获取App报警相关元数据。
请求说明
- 请求方式：GET
- 请求地址：https://open.volcengineapi.com?Action=GetAppAlarmMetricsConf&Version=2022-10-12
ServiceName: apmplus_openapi
Region: cn-beijing
X-App-Ids: xxx
Content-Type: application/json
请求参数
Query
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| Action | String | 是 | GetAppAlarmMetricsConf | 接口名称。当前 API 的名称为 GetAppAlarmMetricsConf。 |
| Version | String | 是 | 2022-10-12 | 接口版本。当前 API 的版本为 2022-10-12。 |
| aid | Integer | 是 | 123456 | 应用ID。 |
返回参数
| 参数 | 类型 | 示例值 | 描述 |
|---|
| data | JSON Map | - | 报警元数据，key为异常类型。 |
| error_msg | String | - | 错误信息，成功为空。 |
| error_no | Long | 0 | 错误码，成功为0。 |
Data
| 参数 | 类型 | 示例值 | 描述 |
|---|
| key | String | - | 异常类型。 |
| value | Object of Config | - | 该异常类型的相关数据。 |
Config
| 参数 | 类型 | 示例值 | 描述 |
|---|
| groups | Array of Group | - | 该报警类别支持的分组维度。 |
| filters | Array of Filter | - | 该类别支持的筛选条件。 |
| metrics | Array of Meta | - | 该报警类别支持的指标。 |
Group
| 参数 | 类型 | 示例值 | 描述 |
|---|
| type | String | normal | 分组维度类型。 |
| field | String | os | 分组维度key。 |
| label | String | 操作系统名称 | 分组维度名。 |
Filter
| 参数 | 类型 | 示例值 | 描述 |
|---|
| op | Array of KeyLabel | in | 该筛选维度支持的条件符号。 |
| type | String | normal | 筛选维度类型。 |
| filed | String | os | 筛选维度key。 |
| label | String | 操作系统名称 | 筛选条件名称。 |
| values | Array of FilterValue | ["Android"] | 筛选维度值。 |
| sub_filter | Array of Filter | - | 子条件。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|
| type | String | simple | 指标类型，简单指标还是复合指标。 |
| label | String | Ajax错误数 | 指标名称。 |
| metric | String | ajax_error_count | 指标key。 |
| sub_meta | Array of Meta | - | 子指标。 |
KeyLabel
| 参数 | 类型 | 示例值 | 描述 |
|---|
| key | String | in | 条件符号key。 |
| label | String | = | 条件符号前端展示。 |
FilterValue
| 参数 | 类型 | 示例值 | 描述 |
|---|
| label | String | model | 标签。 |
| value | String | vivo X100T | 标签的取值。 |
请求示例
GET https://open.volcengineapi.com?Action=GetAppAlarmMetricsConf&Version=2022-10-12&aid=123456
返回示例
{
"data": {},
"error_no": 0,
"error_msg": ""
}
错误码
本接口无特有的错误码。更多信息请参见错误码。