获取JS错误详情。
请求说明
- 请求方式：POST
- 请求地址：https://open.volcengineapi.com?Action=MiniProJsErrDetail&Version=2024-03-12
请求参数
ServiceName : apmplus_openapi
Region : cn-beijing
X-App-Ids : xxx
Content-Type : application/json
Query
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| Action | String | 是 | MiniProJsErrDetail | 接口名称。当前 API 的名称为 MiniProJsErrDetail。 |
| Version | String | 是 | 2024-03-12 | 接口版本。当前 API 的版本为 2024-03-12。 |
Body
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| common | Object of Common | 是 | - | 通用参数。 |
| time_filter | Object of TimeFilter | 是 | - | 时间区间。 |
| issue_id | String | 是 | 2769ad7223a4eaefffbe9b2f59bb933b | JS错误聚合ID。 |
Common
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| aid | Long | 是 | 12345 | 应用ID。 |
| site_type | String | 是 | web | 站点类型。 |
| env | String | 是 | online | 环境。填“”时为全部。 |
| os | String | 否 | minipro | 服务类型，可选值为webpro，app，minipro。 |
| user | String | 否 | test_user | 用户名。 |
TimeFilter
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| start_time | Integer | 是 | 1665485413 | 起始时间，单位s。 |
| granularity | Integer | 否 | 3600 | 聚合时间粒度，单位s。 |
| end_time | Integer | 是 | 1665744613 | 终止时间，单位s。 |
返回参数
| 参数 | 类型 | 示例值 | 描述 |
|---|
| data | Object of Data | - | JS错误详情。 |
| error_msg | String | - | 错误信息，成功为空。 |
| error_no | Integer | 0 | 错误码，成功为0。 |
Data
| 参数 | 类型 | 示例值 | 描述 |
|---|
| name | String | - | 错误名和错误信息类型。 |
| message | String | Error: message test | 错误信息。 |
| filename | String | 12345.js | 报错文件名。 |
| user | Long | 10 | 错误及用户数信息JS错误影响用户数。 |
| count | Long | 10 | JS错误数。 |
| issue_id | String | 1234567223a4eaefffbe9b2f59bb933b | issue 相关信息 |
| issue | Object of Issue | - | issue 状态操作 |
Issue
| 参数 | 类型 | 示例值 | 描述 |
|---|
| id | Long | - | issue在mysql里的id，不同于issue_id。 |
| managers | Array of Managers | - | issue处理人。 |
| status | String | processing | issue状态。 |
| fixed_version | String | v1.1.2 | 修复版本号。 |
Managers
| 参数 | 类型 | 示例值 | 描述 |
|---|
| name | String | test_user | 处理人名。 |
| user_id | Long | 12 | 处理人ID。 |
| head_url | String | - | |
| email | String | test_user@test.com | 处理人邮箱。 |
请求示例
POST https://open.volcengineapi.com?Action=MiniProJsErrDetail&Version=2024-03-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": ""
}
错误码
本接口无特有的错误码。更多信息请参见错误码。