You need to enable JavaScript to run this app.
导航
JSErrDetail
最近更新时间:2023.12.26 18:54:56首次发布时间:2022.11.18 15:32:34

调用JSErrDetail接口获取js错误详情。

使用说明

  • 接口名称:JSErrDetail
  • 请求方式:POST
  • 接口地址:/?Action=JSErrDetail&Version=2022-10-12

请求参数

Query

参数

类型

是否必选

示例值

描述

Action

String

JSErrDetail

请求名称。

Version

String

2022-10-12

请求版本。

ServiceName : apmplus_openapi
Region : cn-beijing 
X-App-Ids : xxx
Content-Type : application/json

Body

参数

类型

是否必选

示例值

描述

common

object of common

-

通用参数。

time_filter

object of time_filter

-

时间区间。

issue_id

string

2769ad7223a4eaefffbe9b2f59bb933b

js错误聚合ID。

common

参数

类型

是否必选

示例值

描述

aid

i64

12345

应用ID。

site_type

string

web

站点类型。

env

string

online

环境,填""时为全部。

os

string

webpro

服务类型,可选值为webproappminipro

user

string

test_user

用户名。

time_filter

参数

类型

是否必选

示例值

描述

start_time

i32

1665485413

起始时间,单位s。

granularity

i32

3600

聚合时间粒度,单位s。

end_time

i32

1665744613

终止时间,单位s。

返回参数

参数

类型

示例值

描述

data

object of data

-

js错误详情。

error_msg

string

-

错误信息,成功为空。

error_no

i32

0

错误码,成功为0。

data

参数

类型

示例值

描述

name

string

-

错误名和信息错误类型。

message

string

Error: message test

错误信息。

filename

string

12345.js

报错文件名。

user

i64

10

错误及用户数信息js错误影响用户数。

count

i64

10

js错误数。

issue_id

string

1234567223a4eaefffbe9b2f59bb933b

issue 相关信息js错误聚合ID。

issue

object of issue

-

issue状态操作关联git issue。

min_crash_time

i64

1668561659926

所选时间区间内js错误最早发生时间。

max_crash_time

i64

1678561659926

所选时间区间内js错误最晚发生时间。

min_crash_release

string

v1.2.3

所选时间区间内js错误最早出现版本。

max_crash_release

string

v1.2.4

所选时间区间内js错误最晚出现版本。

min_crash_pid

string

pid_1

所选时间区间内js错误最早出现页面。

max_crash_pid

string

pid_2

所选时间区间内js错误最晚出现页面。

trends

object of trends

-

js错误趋势图。

extra

object of extra

-

js错误额外信息。

release_distribution

object of release_distribution

-

版本分布。

pid_distribution

object of pid_distribution

-

页面分布。

releases

array of string

-

js错误发生的版本列表。

issue

参数

类型

示例值

描述

id

i64

-

issue在mysql里的ID,不同于issue_id。

managers

array of managers

-

issue处理人。

status

string

processing

issue状态。

fixed_version

string

v1.1.2

修复版本号。

参数

类型

示例值

描述

fields

array of fields

-

折线图/饼图维度,len(fields)=len(source[i])。

source

array of string

[["1668355200","js_error","0","0"]]

趋势图具体点的集合,len(source)为折线图点的数量或者饼图中块数量。

extra

参数

类型

示例值

描述

release_info

array of release_info

-

版本发布情况。

release_distribution

参数

类型

示例值

描述

fields

array of fields

-

折线图/饼图维度,len(fields)=len(source[i])。

source

array of string

[["1668355200","js_error","0","0"]]

趋势图具体点的集合,len(source)为折线图点的数量或者饼图中块数量。

pid_distribution

参数

类型

示例值

描述

fields

array of fields

-

折线图/饼图维度,len(fields)=len(source[i])。

source

array of string

[["1668355200","js_error","0","0"]]

趋势图具体点的集合,len(source)为折线图点的数量或者饼图中块数量。

managers

参数

类型

示例值

描述

name

string

test_user

处理人名。

user_id

i64

12

处理人ID。

email

string

test_user@test.com

处理人邮箱。

fields

参数

类型

示例值

描述

id

string

date

维度key。

dataType

string

string

维度类型。

name

string

日期

维度名。

aggregate

string

-

聚合方式。

release_info

参数

类型

示例值

描述

create_at

i32

1668483578

版本发布时间。

release

string

v2.2.123

版本。

env

string

test

版本发布环境。

commit

string

[]

版本相关commit。

请求示例

POST https://open.volcengineapi.com/?Action=JSErrDetail&Version=2022-10-12 
{
    "common": {
        "aid": 12345,
        "site_type": "web",
        "env": "online",
        "os": "webpro",
        "user": "test_user"
    },
    "time_filter": {
        "start_time": 1665485413,
        "end_time": 1665744613,
        "granularity": 3600
    },
    "issue_id": "2769ad7223a4eaefffbe9b2f59bb933b"
}

返回示例

正常返回示例

{
    "data": {
        "extra": {
            "release_info": [
                {
                    "commit": "",
                    "create_at": 1668483578,
                    "env": "test",
                    "release": "v2.2.123"
                }
            ]
        },
        "release_distribution": {
            "source": [
                [
                    "1668355200",
                    "js_error",
                    "0",
                    "0"
                ]
            ],
            "fields": [
                {
                    "name": "日期",
                    "aggregate": "",
                    "dataType": "string",
                    "id": "date"
                }
            ]
        },
        "releases": [],
        "message": "Error: message test",
        "trends": {
            "source": [
                [
                    "1668355200",
                    "js_error",
                    "0",
                    "0"
                ]
            ],
            "fields": [
                {
                    "name": "日期",
                    "aggregate": "",
                    "id": "date",
                    "dataType": "string"
                }
            ]
        },
        "issue": {
            "fixed_version": "v1.1.2",
            "tag": [
                {
                    "key": "",
                    "id": 172,
                    "values": [
                        {
                            "value": "",
                            "id": 346
                        }
                    ]
                }
            ],
            "managers": [
                {
                    "head_url": "",
                    "email": "test_user@test.com",
                    "name": "test_user",
                    "user_id": 12
                }
            ],
            "status": "processing",
            "id": 944
        },
        "max_crash_pid": "pid_2",
        "meego_issue_url": "powerful",
        "issue_id": "1234567223a4eaefffbe9b2f59bb933b",
        "filename": "12345.js",
        "git_issue_url": "I'm",
        "user": 10,
        "count": 10,
        "min_crash_time": 1668561659926,
        "name": "together",
        "pid_distribution": {
            "fields": [
                {
                    "id": "date",
                    "dataType": "string",
                    "name": "日期",
                    "aggregate": ""
                }
            ],
            "source": [
                [
                    "1668355200",
                    "js_error",
                    "0",
                    "0"
                ]
            ]
        },
        "max_crash_release": "v1.2.4",
        "min_crash_release": "v1.2.3",
        "max_crash_time": 1678561659926,
        "min_crash_pid": "pid_1"
    },
    "error_no": 0,
    "error_msg": ""
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "JSErrDetail",
        "Version": "2022-10-12",
        "Service": "***",
        "Region": "cn-north-1",
        "Error": {
            "Code": "200000",
            "Message": "参数异常"
        }
    }
}