You need to enable JavaScript to run this app.
文档中心
应用性能监控全链路版

应用性能监控全链路版

复制全文
下载 pdf
白屏监控
BlankScreenOverviewList
复制全文
下载 pdf
BlankScreenOverviewList
获取不同归因类型的白屏列表。​
请求说明​
客户端监控已在全球多个地域部署服务,旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅 服务地址 文档,根据业务所在地选择最合适的接入点。​
  • 请求方式:POST​
  • 请求地址:https://apmplus-openapi.cn-beijing.volcengineapi.com?Action=BlankScreenOverviewList&Version=2022-10-12​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数,更多详细信息参见 公共参数 。​
​
参数​
类型​
是否必选​
示例值​
描述​
Action​
String​
是​
BlankScreenOverviewList​
接口名称。当前 API 的名称为 BlankScreenOverviewList。​
Version​
String​
是​
2022-10-12​
接口版本。当前 API 的版本为 2022-10-12。​
common​
Object of CommonParams​
是​
-​
通用参数。​
time_filter​
Object of TimeFilter​
是​
-​
时间区间。​
filter_conditions​
Object of FilterCondition​
否​
-​
筛选条件。​
order_by​
String​
否​
score​
排序维度。​
  • score​
  • client_time​
  • time​
  • count​
  • user​
order​
String​
否​
desc​
排序方式。​
  • desc​
  • asc​
pgno​
Long​
是​
1​
页号。​
pgsz​
Long​
是​
10​
每页项数。​
type​
String​
是​
js_error​
归因类型。​
  • js_error​
  • resource_error​
  • http_error​
  • unclassified​
​
CommonParams​
​
参数​
类型​
是否必选​
示例值​
描述​
aid​
Long​
是​
12345​
应用ID。​
site_type​
String​
是​
web​
站点类型。​
env​
String​
是​
online​
环境,填""时为全部。​
os​
String​
否​
webpro​
服务类型,可选值为webpro,app,minipro。​
user​
String​
否​
test_user​
用户名。​
​
TimeFilter​
​
参数​
类型​
是否必选​
示例值​
描述​
start_time​
Integer​
是​
1665485413​
起始时间,单位s。​
end_time​
Integer​
是​
1665744613​
终止时间,单位s。​
granularity​
Integer​
否​
3600​
聚合时间粒度,单位s。​
​
FilterCondition​
​
参数​
类型​
是否必选​
示例值​
描述​
type​
String​
是​
and​
筛选条件类型,可选值为and和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 FilterCondition​
否​
-​
如果下层还有条件,则放入该处,即type为and时必填。这一层与field,op,groupkey以及values不能同时存在。​
​
请求示例​
​
POST https://apmplus-openapi.cn-beijing.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": "[data explore]",​
"op": "in"​
}​
],​
"values": "[data explore",​
"groupKey": "context",​
"field": "pid",​
"op": "in"​
},​
"order": "desc,asc"​
}
​
返回参数​
​
参数​
类型​
示例值​
描述​
errno​
Integer​
0​
错误码,成功为0。​
errmsg​
String​
-​
错误信息,成功为空。​
data​
-​
白屏归因聚合列表。​
​
OverviewListResponseDataV2​
​
参数​
类型​
示例值​
描述​
js_error​
-​
JS错误导致白屏情况列表。​
http_error​
-​
请求错误导致的白屏列表。​
unclassified​
-​
无法归因的白屏列表。​
resource_error​
-​
静态资源错误导致的白屏列表。​
​
OverviewErrorListResponseData​
​
参数​
类型​
示例值​
描述​
total​
Long​
10​
JS错误聚类总数。​
result​
Array of ErrorListItem​
-​
JS错误聚合列表。​
​
ReqErrorResponseData​
​
参数​
类型​
示例值​
描述​
total​
Long​
10​
导致白屏的请求错误聚类总数。​
result​
Array of ReqErrorListItem​
-​
导致白屏的请求错误聚合列表。​
​
OverviewListResponseData​
​
参数​
类型​
示例值​
描述​
total​
Long​
10​
无法归因的白屏数。​
result​
Array of ListItem​
-​
无法归因的白屏列表。​
​
ResourceErrorResponseData​
​
参数​
类型​
示例值​
描述​
total​
Long​
10​
导致白屏的静态资源错误聚类总数。​
result​
-​
导致白屏的静态资源错误聚合列表。​
​
ErrorListItem​
​
参数​
类型​
示例值​
描述​
message​
String​
Minified React error​
错误信息。​
name​
String​
Error​
错误类型。​
filename​
String​
12345.js​
报错文件名。​
issue_id​
String​
12345​
issue状态操作。​
issue​
Object of IssueInfo​
-​
issue分配信息。​
meego_issue_url​
String​
-​
如果issue_status不为done,则不设置这个字段。​
level​
String​
-​
起止时间。​
max_crash_time​
Long​
1667441262510​
当前所选时间区间内JS错误最晚出现时间。​
min_crash_time​
Long​
1666781177513​
错误及用户数信息。​
count​
Long​
10​
错误及用户数信息错误数。​
count_mini_chart​
Object of ChartData​
-​
错误数趋势。​
user​
Long​
10​
影响用户数。​
user_mini_chart​
Object of ChartData​
-​
影响用户数趋势。​
​
ReqErrorListItem​
​
参数​
类型​
示例值​
描述​
path​
String​
path_test​
请求错误path。​
user​
Long​
10​
请求错误影响用户数。​
count​
Long​
10​
请求错误数。​
domain​
String​
www.test.com​
请求错误域名。​
user_trend​
Object of ChartData​
-​
请求错误影响用户数趋势。​
count_trend​
Object of ChartData​
-​
请求错误数趋势。​
distribution​
Object of ChartData​
-​
请求错误状态码分布情况。​
​
ListItem​
​
参数​
类型​
示例值​
描述​
pid​
String​
path_test​
白屏页面pid。​
url​
String​
https://www.test.com/path_test?key1=value1​
白屏页面url。​
score​
Double​
0​
白屏分数。​
screenshot​
String​
data:image/jpeg;base64,/9j/4AAQS​
白屏现场截图base64编码值。​
session_id​
String​
049437a9​
白屏关联的session_id。​
client_time​
Long​
1667313554658​
白屏发生的客户端时间。​
​
ResourceErrorListItem​
​
参数​
类型​
示例值​
描述​
url​
String​
-​
静态资源错误url。​
path​
String​
path_test​
静态资源错误path。​
type​
String​
resource​
静态资源错误类型。​
user​
Long​
10​
静态资源错误影响用户数。​
count​
Long​
10​
静态资源错误数。​
domain​
String​
www.test.com​
静态资源错误域名。​
user_trend​
Object of ChartData​
-​
静态资源错误影响用户数趋势。​
count_trend​
Object of ChartData​
-​
静态资源错误数趋势。​
​
IssueInfo​
​
参数​
类型​
示例值​
描述​
managers​
Array of IssueManager​
-​
issue处理人。​
status​
String​
processing​
issue状态。​
fixed_version​
String​
v1.1.2​
修复版本号。​
​
ChartData​
​
参数​
类型​
示例值​
描述​
fields​
Array of Field​
-​
折线图/饼图维度,len(fields)=len(source[i])。​
source​
Array of String​
[["1668355200","js_error","0","0"]]​
趋势图具体点的集合,len(source)为折线图点的数量或者饼图中块数量。​
​
IssueManager​
​
参数​
类型​
示例值​
描述​
name​
String​
test_user​
处理人名。​
email​
String​
test_user@test.com​
处理人邮箱。​
user_id​
Long​
12​
处理人ID。​
​
Field​
​
参数​
类型​
示例值​
描述​
id​
String​
date​
维度key。​
name​
String​
日期​
维度名。​
dataType​
String​
string​
维度类型。​
aggregate​
String​
-​
聚合方式。​
​
返回示例​
​
{​
"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": "date",​
"aggregate": "Sheet"​
}​
]​
},​
"count_trend": {​
"source": [​
[​
"1668355200",​
"js_error",​
"0",​
"0"​
]​
],​
"fields": [​
{​
"id": "date",​
"name": "date",​
"aggregate": "clubbing",​
"dataType": "string"​
}​
]​
},​
"count": 10,​
"user_trend": {​
"source": [​
[​
"1668355200",​
"js_error",​
"0",​
"0"​
]​
],​
"fields": [​
{​
"id": "date",​
"name": "date",​
"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": "date",​
"dataType": "string",​
"aggregate": ""​
}​
]​
},​
"user": 10,​
"type": "resource",​
"count_trend": {​
"fields": [​
{​
"name": "date",​
"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": "date",​
"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": "date",​
"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​
}
​
错误码​
当前接口暂无独立错误码,若接口调用返回异常,可参考 公共错误码 进行故障排查。​
最近更新时间:2026.08.28 16:25:33
这个页面对您有帮助吗?
有用
有用
无用
无用