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

应用性能监控全链路版

复制全文
下载 pdf
页面列表
UrlList
复制全文
下载 pdf
UrlList
获取页面列表。​
请求说明​
客户端监控已在全球多个地域部署服务,旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅 服务地址 文档,根据业务所在地选择最合适的接入点。​
  • 请求方式:POST​
  • 请求地址:https://apmplus-openapi.cn-beijing.volcengineapi.com?Action=UrlList&Version=2022-10-12​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数,更多详细信息参见 公共参数 。​
​
参数​
类型​
是否必选​
示例值​
描述​
Action​
String​
是​
UrlList​
接口名称。当前 API 的名称为 UrlList。​
Version​
String​
是​
2022-10-12​
接口版本。当前 API 的版本为 2022-10-12。​
common​
Object of CommonParams​
是​
-​
通用参数。​
time_filter​
Object of TimeFilter​
是​
-​
时间区间。​
filter_conditions​
Object of FilterCondition​
是​
-​
筛选条件。​
page_num​
Integer​
否​
1​
页号。​
page_size​
Integer​
否​
10​
每页项数。​
order​
String​
否​
asc,desc​
排序方式。​
  • asc:升序​
  • desc:倒序​
order_by_metric​
String​
否​
js_error.count​
排序依据,由OverviewMetrics方法获取。​
search_text​
String​
否​
pid_​
pid模糊搜索,不传则默认全部。​
metric_list​
Array of MetricList​
否​
-​
页面指标列表,由OverviewMetrics方法获取。​
top_pids​
Array of String​
否​
[pid_1,pid_2]​
置顶pid列表。​
​
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不能同时存在。​
​
MetricList​
​
参数​
类型​
是否必选​
示例值​
描述​
name​
String​
否​
js_error.count​
指标key。​
type​
String​
否​
number​
指标值类型,是数值指标还是率值指标。​
unit​
String​
否​
ms​
指标值单位。​
groupKey​
String​
否​
js_error​
组别key。​
groupName​
String​
否​
JS错误​
组名。​
isDefault​
Boolean​
否​
true​
是否默认展示。​
description​
String​
否​
PV​
指标名。​
​
请求示例​
​
POST https://apmplus-openapi.cn-beijing.volcengineapi.com?Action=UrlList&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​
},​
"filter_conditions": {​
"type": "and",​
"children": [​
{​
"type": "and",​
"op": "in",​
"children": [],​
"groupKey": "context",​
"field": "pid",​
"values": "[data explore]"​
}​
],​
"op": "in",​
"field": "pid",​
"groupKey": "context",​
"values": "[data explore]"​
},​
"search_text": "pid_",​
"order_by_metric": "js_error.count",​
"top_pids": "[pid_1,pid_2]",​
"page_size": 10,​
"page_num": 1,​
"metric_list": [​
{​
"isDefault": true,​
"unit": "ms",​
"groupName": "JS error",​
"groupKey": "js_error",​
"description": "PV",​
"type": "number",​
"name": "js_error.count"​
}​
],​
"order": "asc,desc"​
}
​
返回参数​
​
参数​
类型​
示例值​
描述​
data​
Object of ListData​
-​
页面指标总览值列表。​
error_msg​
String​
-​
错误信息,成功为空。​
error_no​
Integer​
0​
错误码,成功为0。​
​
ListData​
​
参数​
类型​
示例值​
描述​
count​
Integer​
20​
页面总数。​
table_list​
Array of ListItem​
-​
各页面指标总览值。​
summary_metric​
JSON Map​
-​
所有页面指标总览值。​
​
ListItem​
​
参数​
类型​
示例值​
描述​
name​
String​
/path_test​
页面ID。​
onTop​
Boolean​
true​
默认为false,如果为用户所选置顶页面为true。​
metric_map​
JSON Map​
-​
指标总览值。​
​
SummaryMetric​
​
参数​
类型​
示例值​
描述​
key​
String​
-​
页面指标key。​
value​
Object of MetricDetail​
​
​
​
MetricMap​
​
参数​
类型​
示例值​
描述​
key​
String​
-​
指标对应的key。​
value​
Object of MetricDetail​
​
​
​
MetricDetail​
​
参数​
类型​
示例值​
描述​
type​
String​
-​
指标类型。​
value​
Double​
1000​
指标值。​
change​
Double​
0.01​
指标环比。​
positive​
Boolean​
true​
是否优化。​
  • true:优化​
  • false:劣化​
​
返回示例​
​
{​
"data": {​
"table_list": [​
{​
"link": "",​
"name": "/path_test",​
"onTop": true​
}​
],​
"count": 20​
},​
"error_msg": "",​
"error_no": 0​
}
​
错误码​
当前接口暂无独立错误码,若接口调用返回异常,可参考 公共错误码 进行故障排查。​
最近更新时间:2026.08.28 16:25:38
这个页面对您有帮助吗?
有用
有用
无用
无用