You need to enable JavaScript to run this app.
导航
应用性能监控全链路版
  • 文档首页
    • /
  • 应用性能监控全链路版

EventTypeDetail

最近更新时间：2023.12.26 18:54:55

首次发布时间：2022.11.18 15:32:33

我的收藏

调用EventTypeDetail接口获取具体自定义事件的category和metric聚合列表。

使用说明

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

请求参数

Query

参数

类型

是否必选

示例值

描述

Action

String

是

EventTypeDetail

请求名称。

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

是

-

时间区间。

event_name

string

是

event_test

自定义事件名。

filter_conditions

object of filter_conditions

否

-

筛选条件。

common

参数

类型

是否必选

示例值

描述

aid

i64

是

12345

应用ID。

site_type

string

是

web

站点类型。

env

string

是

online

环境，填""时为全部。

os

string

否

webpro

服务类型，可选值为webpro，app，minipro。

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

筛选条件类型，可选值为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 children

否

-

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

children

参数

类型

是否必选

示例值

描述

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 string

否

-

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

返回参数

参数

类型

示例值

描述

error_msg

string

-

错误信息，成功为空。

error_no

i32

-

错误码，成功为0。

data

object of data

-

具体自定义事件的category和metric聚合列表。

data

参数

类型

示例值

描述

metric_list

array of metric_list

-

具体自定义事件的metric聚合列表。

category_list

array of category_list

-

具体自定义事件的category聚合列表。

metric_list

参数

类型

示例值

描述

metric_name

string

metric_key_test

metric key。

count

i32

10

该metric key上报次数。

avg

double

1.2

该metric key对应的metric value的avg聚合值。

pct25

double

1.0

该metric key对应的metric value的pct25聚合值

pct50

double

1.2

该metric key对应的metric value的pct50聚合值。

pct70

double

1.3

该metric key对应的metric value的pct70聚合值。

pct90

double

1.4

该metric key对应的metric value的pct90聚合值。

pct99

double

1.5

该metric key对应的metric value的pct99聚合值。

category_list

参数

类型

示例值

描述

category_name

string

category_key_test

category key。

count

i32

10

该category key上报次数。

top_values

array of top_values

-

该category key对应的value top20上报情况。

top_values

参数

类型

示例值

描述

count

i32

10

该category key对应的value上报量。

pct

double

0.12

该category key对应的value上报量占所有value上报量的占比。

value

string

category_value_test

该category key对应的value。

请求示例

POST https://open.volcengineapi.com/?Action=EventTypeDetail&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
    },
    "event_name": "event_test",
    "filter_conditions": {
        "type": "and",
        "op": "in",
        "values": "[数据探索]",
        "children": [
            {
                "type": "and",
                "field": "pid",
                "op": "in",
                "values": "[数据探索]",
                "groupKey": "context",
                "children": []
            }
        ],
        "groupKey": "context",
        "field": "pid"
    }
}

返回示例

正常返回示例

{
    "error_no": 0,
    "data": {
        "metric_list": [
            {
                "metric_name": "metric_key_test",
                "pct70": 1.3,
                "pct25": 1,
                "pct99": 1.5,
                "count": 10,
                "pct90": 1.4,
                "pct50": 1.2,
                "avg": 1.2
            }
        ],
        "category_list": [
            {
                "top_values": [
                    {
                        "pct": 0.12,
                        "value": "category_value_test",
                        "count": 10
                    }
                ],
                "count": 10,
                "category_name": "category_key_test"
            }
        ]
    },
    "error_msg": ""
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "EventTypeDetail",
        "Version": "2022-10-12",
        "Service": "***",
        "Region": "cn-north-1",
        "Error": {
            "Code": "200000",
            "Message": "参数异常"
        }
    }
}