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

应用性能监控全链路版

复制全文
下载 pdf
请求监控
ReqItemDashboard
复制全文
下载 pdf
ReqItemDashboard
获取具体请求大盘。​
请求说明​
客户端监控已在全球多个地域部署服务,旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅 服务地址 文档,根据业务所在地选择最合适的接入点。​
  • 请求方式:POST​
  • 请求地址:https://apmplus-openapi.cn-beijing.volcengineapi.com?Action=ReqItemDashboard&Version=2022-10-12​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数,更多详细信息参见 公共参数 。​
​
参数​
类型​
是否必选​
示例值​
描述​
Action​
String​
是​
ReqItemDashboard​
接口名称。当前 API 的名称为 ReqItemDashboard。​
Version​
String​
是​
2022-10-12​
接口版本。当前 API 的版本为 2022-10-12。​
slow_duration​
Long​
是​
3000​
慢请求阈值,单位为ms。​
common​
Object of CommonParams​
是​
-​
通用参数。​
time_filter​
Object of TimeFilter​
是​
-​
时间区间。​
filter_conditions​
Object of FilterCondition​
否​
-​
筛选条件。​
name​
String​
是​
data:image/svg+xml​
静态资源地址​
type​
String​
是​
resource​
静态资源类型​
​
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=ReqItemDashboard&Version=2022-10-12​
{​
"domain": "www.test.com",​
"path": "",​
"slow_duration": 3000,​
"common": {​
"aid": 12345,​
"site_type": "web",​
"env": "online",​
"os": "webpro",​
"user": "test_user"​
},​
"time_filter": {​
"start_time": 1665485413,​
"end_time": 1665744613,​
"granularity": 3600​
},​
"filter_conditions": {​
"type": "and",​
"op": "in",​
"groupKey": "context",​
"field": "pid",​
"children": [​
{​
"type": "and",​
"children": [],​
"field": "pid",​
"values": "[data explore]",​
"op": "in",​
"groupKey": "context"​
}​
],​
"values": "[data explore]"​
}​
}
​
返回参数​
​
参数​
类型​
示例值​
描述​
data​
-​
请求大盘。​
error_msg​
String​
-​
错误信息,成功为空。​
error_no​
Integer​
0​
错误码,成功为0。​
​
ReqItemDashboardData​
​
参数​
类型​
示例值​
描述​
sla_trend​
Object of DashBoardChartData​
-​
请求SLA趋势。​
slow_trend​
Object of DashBoardChartData​
-​
慢请求占比趋势。​
sla_dashboard​
Object of DashBoardChartData​
-​
请求SLA。​
slow_dashboard​
Object of DashBoardChartData​
-​
慢请求比例。​
​
DashBoardChartData​
​
参数​
类型​
示例值​
描述​
data​
Object of ChartData​
-​
请求大盘详情。​
​
ChartData​
​
参数​
类型​
示例值​
描述​
fields​
Array of Field​
-​
折线图/饼图维度,len(fields)=len(source[i])。​
source​
Array of String​
[["1668355200","js_error","0","0"]]​
趋势图具体点的集合,len(source)为折线图点的数量或者饼图中块数量。​
​
Field​
​
参数​
类型​
示例值​
描述​
id​
String​
date​
维度key。​
name​
String​
日期​
维度名。​
dataType​
String​
string​
维度类型。​
aggregate​
String​
-​
聚合方式。​
​
返回示例​
​
{​
"error_msg": "",​
"data": {​
"slow_dashboard": {​
"data": {​
"source": [​
[​
"1668355200",​
"js_error",​
"0",​
"0"​
]​
],​
"fields": [​
{​
"id": "date",​
"name": "date",​
"dataType": "string",​
"aggregate": ""​
}​
]​
},​
"extra": {​
"benchmark": 129​
}​
},​
"slow_trend": {​
"data": {​
"fields": [​
{​
"aggregate": "",​
"name": "date",​
"dataType": "string",​
"id": "date"​
}​
],​
"source": [​
[​
"1668355200",​
"js_error",​
"0",​
"0"​
]​
]​
},​
"extra": {​
"benchmark": -79​
}​
},​
"sla_dashboard": {​
"data": {​
"fields": [​
{​
"aggregate": "",​
"name": "date",​
"id": "date",​
"dataType": "string"​
}​
],​
"source": [​
[​
"1668355200",​
"js_error",​
"0",​
"0"​
]​
]​
},​
"extra": {​
"benchmark": 510​
}​
},​
"sla_trend": {​
"data": {​
"fields": [​
{​
"name": "date",​
"id": "date",​
"dataType": "string",​
"aggregate": ""​
}​
],​
"source": [​
[​
"1668355200",​
"js_error",​
"0",​
"0"​
]​
]​
},​
"extra": {​
"benchmark": 115​
}​
}​
},​
"error_no": 0​
}
​
错误码​
当前接口暂无独立错误码,若接口调用返回异常,可参考 公共错误码 进行故障排查。​
最近更新时间:2026.08.28 16:25:36
这个页面对您有帮助吗?
有用
有用
无用
无用