最近更新时间:2023.04.11 16:29:03
首次发布时间:2022.11.18 15:32:33
调用BlankScreenOverviewList接口获取不同归因类型的白屏列表。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 |
| 请求名称。 |
Version | String | 是 |
| 请求版本。 |
ServiceName : apmplus_openapi Region : cn-beijing X-App-Ids : xxx Content-Type : application/json
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
common | object of common | 是 | - | 通用参数。 |
time_filter | object of time_filter | 是 | - | 时间区间。 |
filter_conditions | object of filter_conditions | 否 | - | 筛选条件。 |
order_by | string | 否 |
| 排序维度。
|
order | string | 否 |
| 排序方式。
|
pgno | i64 | 是 |
| 页号 |
pgsz | i64 | 是 |
| 每页项数。 |
type | string | 是 |
| 归因类型。
|
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
aid | i64 | 是 |
| 应用ID。 |
site_type | string | 是 |
| 站点类型。 |
env | string | 是 |
| 环境,填""时为全部。 |
os | string | 否 |
| 服务类型,可选值为webpro,app,minipro。 |
user | string | 否 |
| 用户名。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
start_time | i32 | 是 |
| 起始时间,单位s。 |
granularity | i32 | 否 |
| 聚合时间粒度,单位s。 |
end_time | i32 | 是 |
| 终止时间,单位s。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
type | string | 是 |
| 筛选条件类型,可选值为and和rule,只支持两层,第一层的type必须为and,第二层的type必须为rule。 |
field | string | 否 |
| 条件字段key,可选值集合由 |
op | string | 否 |
| 条件符号,可选值有eq,neq,lt,lte,gt,gte,in,not_in,regex,not_regex。 |
groupKey | string | 否 |
| map类型字段key,可选值集合由 |
values | array of string | 否 |
| 条件值,可选值集合由 |
children | array of children | 否 | - | 如果下层还有条件,则放入该处,这一层与field,op,groupkey以及values不能同时存在。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
type | string | 是 |
| 筛选条件类型,可选值为and和rule,只支持两层,第一层的type必须为and,第二层的type必须为rule。 |
field | string | 否 |
| 条件字段key,可选值集合由 |
op | string | 否 |
| 条件符号,可选值有eq,neq,lt,lte,gt,gte,in,not_in,regex,not_regex。 |
groupKey | string | 否 |
| map类型字段key,可选值集合由 |
values | array of string | 否 |
| 条件值,可选值集合由 |
children | array of string | 否 | - | 如果下层还有条件,则放入该处,这一层与field,op,groupkey以及values不能同时存在。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
errno | i32 |
| 错误码,成功为0。 |
errmsg | string | - | 错误信息,成功为空。 |
data | object of data | - | 白屏归因聚合列表 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
js_error | object of js_error | - | js错误导致白屏情况列表。 |
unclassified | object of unclassified | - | 无法归因的白屏列表。 |
http_error | object of http_error | - | 请求错误导致的白屏列表。 |
resource_error | object of resource_error | - | 静态资源错误导致的白屏列表 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
result | array of result | - | js错误聚合列表。 |
total | i64 |
| js错误聚类总数。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
result | array of result | - | 无法归因的白屏列表。 |
total | i64 |
| 无法归因的白屏数。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
result | array of result | - | 导致白屏的请求错误聚合列表。 |
total | i64 |
| 导致白屏的请求错误聚类总数。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
result | array of result | - | 导致白屏的静态资源错误聚合列表。 |
total | i64 |
| 导致白屏的静态资源错误聚类总数。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
message | string |
| 错误信息。 |
name | string |
| 错误类型。 |
filename | string |
| 报错文件名。 |
issue_id | string |
| issue 状态操作。 |
issue | object of issue | - | issue分配信息。 |
meego_issue_url | string | - | 如果 issue_status 不为 done,则不设置这个字段。 |
level | string | - | 起止时间。 |
max_crash_time | i64 |
| 当前所选时间区间内js错误最晚出现时间。 |
min_crash_time | i64 |
| 错误及用户数信息。 |
count | i64 |
| 错误数 |
count_mini_chart | object of count_mini_chart | - | 错误数趋势。 |
user | i64 |
| 影响用户数。 |
user_mini_chart | object of user_mini_chart | - | 影响用户数趋势。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
url | string |
| 白屏页面url。 |
pid | string |
| 白屏页面pid。 |
client_time | i64 |
| 白屏发生的客户端时间。 |
score | double |
| 白屏分数。 |
screenshot | string |
| 白屏现场截图base64编码值。 |
session_id | string |
| 白屏关联的session_id |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
domain | string |
| 请求错误域名。 |
path | string |
| 请求错误path |
count | i64 |
| 请求错误数。 |
user | i64 |
| 请求错误影响用户数。 |
distribution | object of distribution | - | 请求错误状态码分布情况。 |
count_trend | object of count_trend | - | 请求错误数趋势。 |
user_trend | object of user_trend | - | 请求错误影响用户数趋势。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
domain | string |
| 静态资源错误域名。 |
path | string |
| 静态资源错误path。 |
type | string |
| 静态资源错误类型。 |
count | i64 |
| 静态资源错误数。 |
user | i64 |
| 静态资源错误影响用户数。 |
count_trend | object of count_trend | - | 静态资源错误数趋势。 |
user_trend | object of user_trend | - | 静态资源错误影响用户数趋势。 |
url | string | - | 静态资源错误url。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
managers | array of managers | - | issue处理人。 |
status | string |
| issue状态。 |
fixed_version | string |
| 修复版本号。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
fields | array of fields | - | 折线图/饼图维度,len(fields)=len(source[i])。 |
source | array of string |
| 趋势图具体点的集合,len(source)为折线图点的数量或者饼图中块数量。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
fields | array of fields | - | 折线图/饼图维度,len(fields)=len(source[i])。 |
source | array of string |
| 趋势图具体点的集合,len(source)为折线图点的数量或者饼图中块数量。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
fields | array of fields | - | 折线图/饼图维度,len(fields)=len(source[i])。 |
source | array of string |
| 趋势图具体点的集合,len(source)为折线图点的数量或者饼图中块数量。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
fields | array of fields | - | 折线图/饼图维度,len(fields)=len(source[i])。 |
source | array of string |
| 趋势图具体点的集合,len(source)为折线图点的数量或者饼图中块数量。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
fields | array of fields | - | 折线图/饼图维度,len(fields)=len(source[i])。 |
source | array of string |
| 趋势图具体点的集合,len(source)为折线图点的数量或者饼图中块数量。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
name | string |
| 处理人名。 |
user_id | i64 |
| 处理人ID。 |
string |
| 处理人邮箱。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
id | string |
| 维度key。 |
dataType | string |
| 维度类型。 |
name | string |
| 维度名。 |
aggregate | string | - | 聚合方式。 |
POST https://open.volcengineapi.com/?Action=BlankScreenOverviewList&Version=2022-10-12 { "common": { "aid": 12345, "site_type": "web", "env": "online", "user": "test_user", "os": "webpro" }, "time_filter": { "start_time": 1665485413, "end_time": 1665744613, "granularity": 3600 }, "pgno": 1, "pgsz": 10, "type": "js_error, resource_error, http_error, unclassified", "order_by": "score,client_time,time,count,user", "filter_conditions": { "type": "and", "children": [ { "type": "and", "children": [], "groupKey": "context", "field": "pid", "values": "[数据探索]", "op": "in" } ], "values": "[数据探索]", "groupKey": "context", "field": "pid", "op": "in" }, "order": "desc,asc" }
{ "errmsg": "", "data": { "http_error": { "result": [ { "user": 10, "domain": "www.test.com", "path": "path_test", "distribution": { "source": [ [ "1668355200", "js_error", "0", "0" ] ], "fields": [ { "dataType": "string", "id": "date", "name": "日期", "aggregate": "Sheet" } ] }, "count_trend": { "source": [ [ "1668355200", "js_error", "0", "0" ] ], "fields": [ { "id": "date", "name": "日期", "aggregate": "clubbing", "dataType": "string" } ] }, "count": 10, "user_trend": { "source": [ [ "1668355200", "js_error", "0", "0" ] ], "fields": [ { "id": "date", "name": "日期", "dataType": "string", "aggregate": "" } ] } } ], "total": 10 }, "unclassified": { "result": [ { "url": "https://www.test.com/path_test?key1=value1", "client_time": 1667313554658, "session_id": "049437a9", "score": 51, "screenshot": "data:image/jpeg;base64,/9j/4AAQS", "pid": "path_test" } ], "total": 10 }, "resource_error": { "result": [ { "path": "path_test", "domain": "www.test.com", "url": "reflection", "count": 10, "user_trend": { "source": [ [ "1668355200", "js_error", "0", "0" ] ], "fields": [ { "id": "date", "name": "日期", "dataType": "string", "aggregate": "" } ] }, "user": 10, "type": "resource", "count_trend": { "fields": [ { "name": "日期", "id": "date", "aggregate": "virtue", "dataType": "string" } ], "source": [ [ "1668355200", "js_error", "0", "0" ] ] } } ], "total": 10 }, "js_error": { "result": [ { "user": 10, "min_crash_time": 1666781177513, "user_mini_chart": { "fields": [ { "dataType": "string", "id": "date", "name": "日期", "aggregate": "wildly" } ], "source": [ [ "1668355200", "js_error", "0", "0" ] ] }, "name": "Error", "done_release": "percent", "filename": "12345.js", "count": 10, "level": "disappear", "max_crash_time": 1667441262510, "issue_id": "12345", "git_issue_url": "", "count_mini_chart": { "source": [ [ "1668355200", "js_error", "0", "0" ] ], "fields": [ { "aggregate": "", "dataType": "string", "name": "日期", "id": "date" } ] }, "issue": { "managers": [ { "email": "test_user@test.com", "name": "test_user", "head_url": "", "user_id": 12 } ], "id": 886, "fixed_version": "v1.1.2", "tag": [ { "key": "", "values": [ { "value": "", "id": 419 } ], "id": 401 } ], "status": "processing" }, "message": "Minified React error", "meego_issue_url": "beyond" } ], "total": 10 } }, "errno": 0 }
{ "ResponseMetadata": { "RequestId": "201806041104200100100232280022D30", "Action": "BlankScreenOverviewList", "Version": "2022-10-12", "Service": "***", "Region": "cn-north-1", "Error": { "Code": "200000", "Message": "参数异常" } } }