更新时间：2023.04.11 16:29:06
调用UrlList接口获取页面列表。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
Action | String | 是 |
| 请求名称。 |
Version | String | 是 |
| 请求版本。 |
ServiceName : apmplus_openapi Region : cn-beijing X-App-Ids : xxx Content-Type : application/json
参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
common | object of common | 是 | - | 通用参数。 |
time_filter | object of time_filter | 是 | - | 时间区间。 |
filter_conditions | object of filter_conditions | 是 | - | 筛选条件。 |
page_num | i32 | 否 |
| 页号。 |
page_size | i32 | 否 |
| 每页项数。 |
order | string | 否 |
| 排序方式。
|
order_by_metric | string | 否 |
| 排序依据，由 |
search_text | string | 否 |
| pid模糊搜索，不传则默认全部。 |
metric_list | array of metric_list | 否 | - | 页面指标列表，由 |
top_pids | array of string | 否 |
| 置顶pid列表。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
aid | i64 | 是 |
| 应用ID。 |
site_type | string | 是 |
| 站点类型。 |
env | string | 是 |
| 环境，填""时为全部。 |
os | string | 否 |
| 服务类型，可选值为webpro，app，minipro。 |
user | string | 否 |
| 用户名。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
start_time | i32 | 是 |
| 起始时间，单位s。 |
granularity | i32 | 否 |
| 聚合时间粒度，单位s。 |
end_time | i32 | 是 |
| 终止时间，单位s。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
type | string | 是 |
| 筛选条件类型，可选值为and和rule。只支持两层，第一层的type必须为and，第二层的type必须为rule。 |
field | string | 否 |
| 条件字段key，可选值集合由 |
op | string | 否 |
| 条件符号，可选值有eq，neq，lt，lte，gt，gte，in，not_in，regex，not_regex。 |
groupKey | string | 否 |
| map类型字段key，可选值集合由 |
values | array of string | 否 |
| 条件值，可选值集合由 |
children | array of children | 否 | - | 如果下层还有条件，则放入该处，这一层与field，op，groupkey以及values不能同时存在。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
type | string | 是 |
| 筛选条件类型，可选值为and和rule。只支持两层，第一层的type必须为and，第二层的type必须为rule。 |
field | string | 否 |
| 条件字段key，可选值集合由 |
op | string | 否 |
| 条件符号，可选值有eq，neq，lt，lte，gt，gte，in，not_in，regex，not_regex。 |
groupKey | string | 否 |
| map类型字段key，可选值集合由 |
values | array of string | 否 |
| 条件值，可选值集合由 |
children | array of string | 否 | - | 如果下层还有条件，则放入该处，这一层与field，op，groupkey以及values不能同时存在。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
description | string | 否 |
| 指标名。 |
groupKey | string | 否 |
| 组别key。 |
groupName | string | 否 |
| 组名 |
name | string | 否 |
| 指标key。 |
isDefault | boolean | 否 |
| 是否默认展示。 |
type | string | 否 |
| 指标值类型，是数值指标还是率值指标。 |
unit | string | 否 |
| 指标值单位。 |
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
data | object of data | - | 页面指标总览值列表。 |
error_msg | string | - | 错误信息，成功为空。 |
error_no | i32 |
| 错误码，成功为0。 |
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
table_list | array of table_list | - | 各页面指标总览值。 |
count | i32 |
| 页面总数。 |
summary_metric | object of summary_metric | - | 所有页面指标总览值。 |
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
metric_map | object | - | 指标总览值。 |
name | string |
| 页面ID。 |
onTop | boolean |
| 默认为false，如果为用户所选置顶页面为true。 |
POST https://open.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": "[数据探索]" } ], "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 }
{ "ResponseMetadata": { "RequestId": "201806041104200100100232280022D30", "Action": "UrlList", "Version": "2022-10-12", "Service": "***", "Region": "cn-north-1", "Error": { "Code": "200000", "Message": "参数异常" } } }