告警概览
告警Top事件
接口功能介绍
调用此接口可查询指定资源池下告警Top事件。
接口约束
regionID（资源池）存在。
URI
GET /v4/monitor/query-alarm-top-event
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
| range | 否 | String | 时间范围，默认值:7d，取值示例：7d，24h，6h 分别代表最近7天，最近24小时，最近6小时。 时间范围最长不能超过3个月 | 7d |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败），默认值：800 | 800 | |
| errorCode | String | 失败时的错误代码，参见公共错误码说明 | ||
| message | String | 失败时的错误描述，一般为英文描述 | Success | |
| msgDesc | String | 失败时的错误描述，适配中英文 | 成功 | |
| description | String | 失败时的错误描述，适配中英文 | 成功 | |
| error | String | 错误码，请求成功时，不返回该字段 | Openapi.Parameter.Error | |
| returnObj | Array of Objects | 返回对象 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| service | String | 产品服务 | ecs | |
| dimension | String | 产品维度 | ecs | |
| serviceDesc | String | 产品服务描述 | 云主机 | |
| dimensionDesc | String | 产品维度描述 | 云主机 | |
| event | String | 事件 | policy_task_failed | |
| eventDesc | String | 事件描述 | 策略任务失败告警 | |
| count | Integer | 告警次数 | 2 |
请求示例
请求url
/v4/monitor/query-alarm-top-event?regionID=81f7728662dd11ec810800155d307d5b
请求头header
无
请求体body
无
响应示例
{
"statusCode": 800,
"returnObj": [
{
"service": "evs_backup",
"dimension": "volume_backup_policy_task",
"event": "policy_task_failed",
"eventDesc": "策略任务失败告警",
"count": 2,
"serviceDesc": "云硬盘备份",
"dimensionDesc": "云硬盘备份策略事件"
}
],
"errorCode": "",
"message": "Success",
"msgDesc": "成功",
"description": "成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 描述 |
|---|---|
| Openapi.Overview.ParamValueOutOfRange | 参数取值超出范围 |
| 其他 | 参见公共错误码说明 |
