You need to enable JavaScript to run this app.
导航
UrlList
最近更新时间:2023.12.26 18:54:59首次发布时间:2022.11.18 15:32:35

调用UrlList接口获取页面列表。

使用说明

  • 接口名称:UrlList
  • 请求方式:POST
  • 接口地址:/?Action=UrlList&Version=2022-10-12

请求参数

Query

参数

类型

是否必选

示例值

描述

Action

String

UrlList

请求名称。

Version

String

2022-10-12

请求版本。

ServiceName : apmplus_openapi
Region : cn-beijing 
X-App-Ids : xxx
Content-Type : application/json

Body

参数

类型

是否必选

示例值

描述

common

object of common

-

通用参数。

time_filter

object of time_filter

-

时间区间。

filter_conditions

object of filter_conditions

-

筛选条件。

page_num

i32

1

页号。

page_size

i32

10

每页项数。

order

string

asc,desc

排序方式。

  • asc:升序
  • desc:倒序

order_by_metric

string

js_error.count

排序依据,由OverviewMetrics方法获取。

search_text

string

pid_

pid模糊搜索,不传则默认全部。

metric_list

array of metric_list

-

页面指标列表,由OverviewMetrics方法获取。

top_pids

array of string

[pid_1,pid_2]

置顶pid列表。

common

参数

类型

是否必选

示例值

描述

aid

i64

12345

应用ID。

site_type

string

web

站点类型。

env

string

online

环境,填""时为全部。

os

string

webpro

服务类型,可选值为webproappminipro

user

string

test_user

用户名。

time_filter

参数

类型

是否必选

示例值

描述

start_time

i32

1665485413

起始时间,单位s。

granularity

i32

3600

聚合时间粒度,单位s。

end_time

i32

1665744613

终止时间,单位s。

filter_conditions

参数

类型

是否必选

示例值

描述

type

string

and

筛选条件类型,可选值为andrule。只支持两层,第一层的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 children

-

如果下层还有条件,则放入该处,这一层与field,op,groupkey以及values不能同时存在。

children

参数

类型

是否必选

示例值

描述

type

string

and

筛选条件类型,可选值为andrule。只支持两层,第一层的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 string

-

如果下层还有条件,则放入该处,这一层与field,op,groupkey以及values不能同时存在。

metric_list

参数

类型

是否必选

示例值

描述

description

string

PV

指标名。

groupKey

string

js_error

组别key。

groupName

string

JS错误

组名

name

string

js_error.count

指标key。

isDefault

boolean

true

是否默认展示。

type

string

number

指标值类型,是数值指标还是率值指标。

unit

string

ms

指标值单位。

返回参数

参数

类型

示例值

描述

data

object of data

-

页面指标总览值列表。

error_msg

string

-

错误信息,成功为空。

error_no

i32

0

错误码,成功为0。

data

参数

类型

示例值

描述

table_list

array of table_list

-

各页面指标总览值。

count

i32

20

页面总数。

summary_metric

object of summary_metric

-

所有页面指标总览值。

table_list

参数

类型

示例值

描述

metric_map

object

-

指标总览值。

name

string

/path_test

页面ID。

onTop

boolean

true

默认为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": "参数异常"
        }
    }
}