获取指定自定义事件的报警指标。
请求说明
- 请求方式：POST
- 请求地址：https://open.volcengineapi.com/?Action=GetAlarmEventMetaMetric&Version=2022-10-12
ServiceName: apmplus_openapi
Region: cn-beijing
X-App-Ids: xxx
Content-Type: application/json
请求参数
Query
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| Action | String | 是 | GetAlarmEventMetaMetric | 接口名称。当前 API 的名称为 GetAlarmEventMetaMetric。 |
| Version | String | 是 | 2022-10-12 | 接口版本。当前 API 的版本为 2022-10-12。 |
Body
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| common | Object of Common | 否 | - | 通用参数。 |
| event_name | String | 否 | basic-custom | 事件名。调用GetAlarmEventMeta接口查看取值。 |
Common
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| aid | Long | 否 | 12345 | 应用ID。 |
| os | String | 否 | webpro | 服务类型。 |
返回参数
| 参数 | 类型 | 示例值 | 描述 |
|---|
| data | Object of Data | - | 返回内容。 |
| error_msg | String | - | 错误信息。 |
| error_no | Integer | 0 | 错误码。成功为0。 |
Data
| 参数 | 类型 | 示例值 | 描述 |
|---|
| key | String | - | 报警类型唯一key。 |
| type | String | basic | 指标类型。 |
| label | String | basic-custom/上报量 | 指标。 |
| measure_name | String | {\"metric\":\"custom.count\",\"event_dimension\":\"event_name\",\"event_name\":\"basic-custom\"} | 报警指标名称。 |
| measure_meta_list | Array of MeasureMetaList | - | 报警指标元数据。 |
请求示例
POST https://open.volcengineapi.com/?Action=GetAlarmEventMetaMetric&Version=2022-10-12
{
"common":{
"aid":12345,
"os":"webpro"
},
"event_name":"basic-custom"
}
返回示例
{
"err_detail":"",
"data":{
"measure_meta_list":[
{
"key":"",
"type":"basic",
"label":"basic-custom/上报量",
"short_label":"",
"measure_name":"{\"metric\":\"custom.count\",\"event_dimension\":\"event_name\",\"event_name\":\"basic-custom\"}",
"measure_meta_list":[
],
"comment":{
"link":"",
"comment":"",
"event_comment":"事件basic-custom的上报量"
},
"event_name":"basic-custom",
"unit":{
"unit_type":"",
"unit":""
},
"agg_func_list":[
]
},
{
"key":"",
"type":"basic",
"label":"basic-custom/fruit/去重计数",
"short_label":"",
"measure_name":"{\"metric\":\"custom.categories.uniq\",\"event_dimension\":\"event_name\",\"event_name\":\"basic-custom\",\"map_key\":\"fruit\"}",
"measure_meta_list":[
],
"comment":{
"link":"",
"comment":"",
"event_comment":"事件basic-custom的category fruit的去重计数"
},
"event_name":"basic-custom",
"unit":{
"unit_type":"",
"unit":""
},
"agg_func_list":[
]
}
]
},
"error_msg":"",
"error_no":0
}
错误码
本接口无特有的错误码。更多信息请参见错误码。