更新时间：2023.04.11 16:29:03
调用EventTypeDetail接口获取具体自定义事件的category和metric聚合列表。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
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 | 是 | - | 时间区间。 |
event_name | string | 是 |
| 自定义事件名。 |
filter_conditions | object of filter_conditions | 否 | - | 筛选条件。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
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不能同时存在。 |
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
error_msg | string | - | 错误信息，成功为空。 |
error_no | i32 | - | 错误码，成功为0。 |
data | object of data | - | 具体自定义事件的category和metric聚合列表。 |
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
metric_list | array of metric_list | - | 具体自定义事件的metric聚合列表。 |
category_list | array of category_list | - | 具体自定义事件的category聚合列表。 |
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
metric_name | string |
| metric key。 |
count | i32 |
| 该metric key上报次数。 |
avg | double |
| 该metric key对应的metric value的avg聚合值。 |
pct25 | double |
| 该metric key对应的metric value的pct25聚合值 |
pct50 | double |
| 该metric key对应的metric value的pct50聚合值。 |
pct70 | double |
| 该metric key对应的metric value的pct70聚合值。 |
pct90 | double |
| 该metric key对应的metric value的pct90聚合值。 |
pct99 | double |
| 该metric key对应的metric value的pct99聚合值。 |
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
category_name | string |
| category key。 |
count | i32 |
| 该category key上报次数。 |
top_values | array of top_values | - | 该category key对应的value top20上报情况。 |
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
count | i32 |
| 该category key对应的value上报量。 |
pct | double |
| 该category key对应的value上报量占所有value上报量的占比。 |
value | string |
| 该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": "参数异常" } } }