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

应用性能监控全链路版

复制全文
下载 pdf
请求监控
ReqSlowList
复制全文
下载 pdf
ReqSlowList
获取top10慢请求。​
请求说明​
客户端监控已在全球多个地域部署服务,旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅 服务地址 文档,根据业务所在地选择最合适的接入点。​
  • 请求方式:POST​
  • 请求地址:https://apmplus-openapi.cn-beijing.volcengineapi.com?Action=ReqSlowList&Version=2022-10-12​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数,更多详细信息参见 公共参数 。​
​
参数​
类型​
是否必选​
示例值​
描述​
Action​
String​
是​
ReqSlowList​
接口名称。当前 API 的名称为 ReqSlowList。​
Version​
String​
是​
2022-10-12​
接口版本。当前 API 的版本为 2022-10-12。​
common​
Object of CommonParams​
是​
-​
通用参数。​
time_filter​
Object of TimeFilter​
是​
-​
时间区间。​
filter_conditions​
Object of FilterCondition​
否​
-​
筛选条件。​
slow_duration​
Long​
是​
2000​
慢请求阈值,单位ms。​
order_by​
String​
否​
slow_rate​
排序方式。支持按照slow_rate、slow_value、count、avg、pct25、pct50、pct70、pct90和pct99排序。​
type​
String​
否​
avg​
请求耗时聚合方式。支持按照avg、pct25、pct50、pct70、pct90、pct95和pct99聚合。​
​
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=ReqSlowList&Version=2022-10-12​
{​
"common": {​
"aid": 12345,​
"site_type": "web",​
"env": "online",​
"os": "webpro",​
"user": "test_user"​
},​
"time_filter": {​
"start_time": 1665485413,​
"end_time": 1665744613,​
"granularity": 3600​
},​
"slow_duration": 2000,​
"type": "avg,pct25,pct50,pct70,pct90,pct95,pct99",​
"filter_conditions": {​
"type": "and",​
"children": [​
{​
"type": "and",​
"op": "in",​
"groupKey": "context",​
"children": [],​
"values": "[data explore]",​
"field": "pid"​
}​
],​
"values": "[data explore]",​
"groupKey": "context",​
"field": "pid",​
"op": "in"​
},​
"order_by": "slow_rate,slow_value,count,avg,pct25,pct50,pct70,pct90,pct99"​
}
​
返回参数​
​
参数​
类型​
示例值​
描述​
data​
Array of ReqSlowListItem​
-​
Top10慢请求。​
error_msg​
String​
-​
错误信息,成功为空。​
error_no​
Integer​
0​
错误码,成功为0。​
​
ReqSlowListItem​
​
参数​
类型​
示例值​
描述​
path​
String​
path_test​
请求路径。​
domain​
String​
www.test.com​
请求域名。​
duration​
Long​
1200​
请求耗时,单位ms。​
slow_rate​
String​
0.12​
慢请求率。​
user_rate​
String​
0.12​
慢请求影响用户率。​
rate_trend​
Object of ChartData​
-​
慢请求率趋势。​
user_trend​
Object of ChartData​
-​
慢请求影响用户率趋势。​
duration_trend​
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": [​
{​
"domain": "www.test.com",​
"user_trend": {​
"fields": [​
{​
"dataType": "string",​
"aggregate": "",​
"id": "date",​
"name": "date"​
}​
],​
"source": [​
[​
"1668355200",​
"js_error",​
"0",​
"0"​
]​
]​
},​
"duration": 1200,​
"user_rate": "0.12",​
"duration_trend": {​
"fields": [​
{​
"name": "date",​
"id": "date",​
"aggregate": "",​
"dataType": "string"​
}​
],​
"source": [​
[​
"1668355200",​
"js_error",​
"0",​
"0"​
]​
]​
},​
"slow_rate": "0.12",​
"rate_trend": {​
"fields": [​
{​
"dataType": "string",​
"name": "date",​
"aggregate": "",​
"id": "date"​
}​
],​
"source": [​
[​
"1668355200",​
"js_error",​
"0",​
"0"​
]​
]​
},​
"path": "path_test"​
}​
],​
"error_no": 0​
}
​
错误码​
当前接口暂无独立错误码,若接口调用返回异常,可参考 公共错误码 进行故障排查。​
最近更新时间:2026.08.28 16:25:36
这个页面对您有帮助吗?
有用
有用
无用
无用