查看JS issue错误列表。
请求说明
- 请求方式:POST
- 请求地址:https://open.volcengineapi.com?Action=MiniProJsErrList&Version=2024-03-12
请求参数
ServiceName : apmplus_openapi
Region : cn-beijing
X-App-Ids : xxx
Content-Type : application/json
Query
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|
Action | String | 是 | MiniProJsErrList | 接口名称。当前 API 的名称为 MiniProJsErrList 。 |
Version | String | 是 | 2024-03-12 | 接口版本。当前 API 的版本为 2024-03-12 。 |
Body
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|
common | Object of Common | 是 | - | 通用参数。 |
time_filter | Object of TimeFilter | 是 | - | 时间区间。 |
filter_conditions | Object of FilterConditions | 否 | - | 筛选条件。 |
order_by | String | 否 | time_ascend
| 排序方式。 - time_ascend
- time_descend
- count_ascend
- count_descend
- user_ascend
- user_descend
|
pgno | Long | 否 | 1 | 页号。 |
pgsz | Long | 否 | 10 | 每页项数。 |
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。 |
FilterConditions
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|
type | String | 是 | and
| 筛选条件类型。 - and:children中的条件为“与”关系。
- rule(默认):当前条件为原子条件。
只支持两层,第一层的type必须为and,第二层的type必须为rule。
|
field | String | 否 | pid | 条件字段key,可选值集合由GetFieldKeys 方法获取。 |
op | String | 否 | in | 条件符号,可选值有eq,neq,lt,lte,gt,gte,in,not_in,regex,not_regex。 |
groupKey | String | 否 | context | map类型字段key,可选值集合由GetFieldKeys 方法获取。 |
values | Array of String | 否 | [数据探索] | 条件值,可选值集合由GetFieldValues 方法获取。 |
children | Array of String | 否 | - | 如果下层还有条件,则放入该处,这一层与field,op,groupkey以及values不能同时存在 |
返回参数
参数 | 类型 | 示例值 | 描述 |
---|
error_no | Integer | 0 | 错误信息,0为成功。 |
error_msg | String | - | 错误信息。空为成功。 |
data | Object of Data | - | JS错误聚合列表。 |
Data
参数 | 类型 | 示例值 | 描述 |
---|
result | Array of Result | - | JS错误聚合列表。 |
total | Long | 10 | JS错误聚类总数。 |
Result
参数 | 类型 | 示例值 | 描述 |
---|
message | String | Minified React error | 错误信息。 |
name | String | Error | 错误类型。 |
filename | String | 12345.js | 报错文件名。 |
issue_id | String | 12345 | Js错误聚合ID。 |
issue | Object of Issue | - | issue分配信息。 |
level | String | - | 错误级别。 |
max_crash_time | Long | 1667441262510 | 当前所选时间区间内JS错误最晚出现时间。 |
min_crash_time | Long | 1666781177513 | 当前所选时间区间内JS错误最早出现时间。 |
count | Long | 10 | 错误及用户数信息错误数。 |
count_mini_chart | Object of CountMiniChart | - | 错误数趋势。 |
user | Long | 10 | 影响用户数。 |
user_mini_chart | Object of UserMiniChart | - | 影响用户数趋势。 |
Issue
参数 | 类型 | 示例值 | 描述 |
---|
id | Long | - | issue在mysql里的id,不同于issue_id。 |
managers | Array of Managers | - | issue处理人。 |
status | String | processing | issue状态。 |
fixed_version | String | v1.1.2 | 修复版本号。 |
CountMiniChart
参数 | 类型 | 示例值 | 描述 |
---|
fields | Array of Fields | - | 折线图/饼图维度,len(fields)=len(source[i])。 |
source | Array of String | [["1668355200","js_error","0","0"]] | 趋势图具体点的集合,len(source)为折线图点的数量或者饼图中块数量。 |
UserMiniChart
参数 | 类型 | 示例值 | 描述 |
---|
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 | Long | 12 | 处理人ID。 |
email | String | test_user@test.com | 处理人邮箱。 |
Fields
参数 | 类型 | 示例值 | 描述 |
---|
id | String | date | 维度key。 |
dataType | String | string | 维度类型。 |
name | String | 日期 | 维度名。 |
aggregate | String | - | 聚合方式。 |
请求示例
POST https://open.volcengineapi.com?Action=MiniProJsErrList&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
},
"status": [
],
"pgno": 1,
"filter_conditions": {
"type": "and",
"children": [
{
"type": "and",
"values": "[数据探索]",
"children": [
],
"op": "in",
"field": "pid",
"groupKey": "context"
}
],
"field": "pid",
"values": "[数据探索]",
"groupKey": "context",
"op": "in"
},
"order_by": "time_ascend,time_descend,count_ascend,count_descend,user_ascend,user_descend",
"managers": [
],
"pgsz": 10
}
返回示例
{
"data": {
"total": 10,
"result": [
{
"issue": {
"fixed_version": "v1.1.2",
"managers": [
{
"head_url": "industry",
"user_id": 12,
"email": "test_user@test.com",
"name": "test_user"
}
],
"status": "processing",
"tag": [
{
"values": [
{
"id": 502,
"value": "bladder"
}
],
"id": 148,
"key": ""
}
],
"id": 418
},
"user_mini_chart": {
"fields": [
{
"dataType": "string",
"id": "date",
"name": "日期",
"aggregate": ""
}
],
"source": [
[
"1668355200",
"js_error",
"0",
"0"
]
]
},
"issue_id": "12345",
"user": 10,
"filename": "12345.js",
"max_crash_time": 1667441262510,
"done_release": "Out",
"meego_issue_url": "",
"git_issue_url": "",
"name": "Error",
"count": 10,
"count_mini_chart": {
"source": [
[
"1668355200",
"js_error",
"0",
"0"
]
],
"fields": [
{
"dataType": "string",
"aggregate": "warming",
"name": "日期",
"id": "date"
}
]
},
"min_crash_time": 1666781177513,
"level": "",
"message": "Minified React error"
}
]
},
"error_no": 0,
"error_msg": ""
}
错误码
本接口无特有的错误码。更多信息请参见错误码。