获取报警的category及对应的指标等元信息。
请求说明
- 请求方式：POST
- 请求地址：https://open.volcengineapi.com?Action=MiniProAlarmMeta&Version=2024-03-12
请求参数
ServiceName : apmplus_openapi
Region : cn-beijing
X-App-Ids : xxx
Content-Type : application/json
Query
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| Action | String | 是 | MiniProAlarmMeta | 接口名称。当前 API 的名称为 MiniProAlarmMeta。 |
| Version | String | 是 | 2024-03-12 | 接口版本。当前 API 的版本为 2024-03-12。 |
Body
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| common | Object of Common | 是 | - | 通用参数。 |
Common
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| aid | Long | 是 | 12345 | 应用ID。 |
| os | String | 否 | minipro | 服务类型。取值支持app、webpro、minipro。 |
返回参数
| 参数 | 类型 | 示例值 | 描述 |
|---|
| data | Object of Data | - | 返回内容。 |
| error_msg | String | - | 错误信息。 |
| error_no | Integer | 0 | 错误码。0为成功。 |
Data
| 参数 | 类型 | 示例值 | 描述 |
|---|
| key | String | pageview | 报警类型唯一key。 |
| label | String | 用户分析 | 报警类型。 |
| type | String | simple | 类型。 |
| measure_meta_list | Array of MeasureMetaList | - | 具体报警类型下的报警指标。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|
type | String | basic
| 该指标下是否有子指标。 |
| label | String | DomReady/均值 | 指标名。 |
| measure_name | String | browser_perf.dom_ready.avg | 指标唯一key。 |
请求示例
POST https://open.volcengineapi.com?Action=MiniProAlarmMeta&Version=2024-03-12
{
"common": {
"aid": 12345,
"os": "minipro"
}
}
返回示例
{
"err_detail":"",
"data":{
"measure_category_meta_list":[
{
"key":"pageview",
"label":"用户分析",
"type":"simple",
"measure_meta_list":[
{
"key":"",
"type":"basic",
"label":"PV",
"short_label":"",
"measure_name":"pv_uv.count"
}
]
},
{
"key":"performance",
"label":"性能指标",
"type":"simple",
"measure_meta_list":[
{
"key":"",
"type":"group",
"label":"DomReady",
"short_label":"",
"measure_meta_list":[
{
"key":"",
"type":"basic",
"label":"DomReady/均值",
"short_label":"",
"measure_name":"browser_perf.dom_ready.avg"
}
]
}
]
}
]
},
"error_msg":"",
"error_no":0
}
错误码
本接口无特有的错误码。更多信息请参见错误码。