获取页面列表。
请求说明 请求方式：POST 请求地址：https://open.volcengineapi.com/?Action=UrlList&Version=2022-10-12 ServiceName: apmplus_openapi
Region: cn-beijing
X-App-Ids: xxx
Content-Type: application/json
请求参数 Query 参数 类型 是否必选 示例值 描述 Action String 是 UrlList接口名称。当前 API 的名称为 UrlList。 Version String 是 2022-10-12接口版本。当前 API 的版本为 2022-10-12。
Body 参数 类型 是否必选 示例值 描述 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
排序方式。
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 否 contextmap类型字段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指标名。
返回参数 参数 类型 示例值 描述 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 MetricMap MetricDetail 参数 类型 示例值 描述 type String -指标类型。 value Double 1000指标值。 change Double 0.01指标环比。 positive
Boolean
true
是否优化。
请求示例 POST https:
{
"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" : "[数据探索]"
}
] ,
"op" : "in" ,
"field" : "pid" ,
"groupKey" : "context" ,
"values" : "[数据探索]"
} ,
"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错误" ,
"groupKey" : "js_error" ,
"description" : "PV" ,
"type" : "number" ,
"name" : "js_error.count"
}
] ,
"order" : "asc,desc"
}
返回示例 {
"data" : {
"table_list" : [
{
"link" : "" ,
"name" : "/path_test" ,
"onTop" : true }
] ,
"count" : 20
} ,
"error_msg" : "" ,
"error_no" : 0
}
错误码 本接口无特有的错误码。更多信息请参见错误码 。