接口功能介绍
查看告警规则的详情信息。
接口约束
regionID（资源池）和alarmRuleID（告警规则）存在。
URI
GET /v4/monitor/describe-alarm-rule
请求参数
Query参数
| 参数 | 参数类型 | 是否必填 | 示例 | 说明 | 下级对象 |
|---|---|---|---|---|---|
| regionID | String | 是 | 81f7728662dd11ec810800155d307d5b | ctyun资源池ID | |
| alarmRuleID | String | 是 | 3dbd23b2-74e2-53f8-869c-6fe6b07b9dba | 告警规则ID |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败），默认值：800 | 800 | |
| errorCode | String | 失败时的错误代码，参见公共错误码说明 | ||
| message | String | 失败时的错误描述，一般为英文描述 | Success | |
| msgDesc | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| returnObj | Object | 返回对象 | returnObj |
表returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| alarmRule | Object | 告警规则 | alarmRule |
表alarmRule
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| regionID | String | ctyun资源池ID | 81f7728662dd11ec810800155d307d5b | |
| alarmRuleID | String | 告警规则ID | 3dbd23b2-74e2-53f8-869c-6fe6b07b9dba | |
| triggerID | String | 监控平台的规则ID | 634d170039fa5e04c4a33614 | |
| name | String | 规则名 | 告警规则lyc123 | |
| desc | String | 描述 | test | |
| repeatTimes | Integer | 重复告警通知次数 | 1 | |
| service | String | 服务 | ecs | |
| dimension | String | 维度 | ecs | |
| level | Integer | 本参数表示报警级别。取值范围：1：灾难告警。2：严重告警。3：一般告警。4：警告告警。根据以上范围取值。 | 1 | |
| silenceTime | Integer | 静默时间，单位：秒 | 300 | |
| recoverNotify | Integer | 本参数表示恢复是否通知。默认值0。取值范围：0：否。1：是。根据以上范围取值。 | 0 | |
| notifyType | Array of String | 告警接收策略 | ["email", "sms"] | |
| contactGroupList | Array of String | 告警联系人组 | ["test"] | |
| notifyWeekdays | Array of Integer | 通知周期 | [0,1,2,3] | |
| notifyStart | String | 通知起始时段 | 00:00:00 | |
| notifyEnd | String | 通知结束时段 | 23:59:59 | |
| for | Integer | 持续时间，当规则执行结果持续多久符合条件时报警（防抖） | 120 | |
| metric | String | 监控指标 | cpu_util | |
| operator | String | 本参数表示比较符。取值范围：eq：等于。gt：大于。ge：大于等于。lt：小于。le：小于等于。根据以上范围取值。 | ge | |
| value | String | 告警阈值 | 1000 | |
| period | String | 算法统计周期 | 5m | |
| fun | String | 本参数表示告警采用算法。取值范围：last：原始值算法。avg：平均值算法。max：最大值算法。min：最小值算法。根据以上范围取值。 | last | |
| instanceID | String | 资源唯一值 | 000f0322-1f4d-8cc8-bb2e-1c30fb751aa5 | |
| instanceName | String | 资源名称 | 000f0322-1f4d-8cc8-bb2e-1c30fb751aa5 | |
| deviceUUID | String | 资源ID | 000f0322-1f4d-8cc8-bb2e-1c30fb751aa5 | |
| status | Integer | 本参数表示告警规则启用状态。取值范围：0：启用。1：停用。根据以上范围取值。 | 0 |
请求示例
GET /v4/monitor/describe-alarm-rule?regionID=81f7728662dd11ec810800155d307d5b&alarmRuleID=3dbd23b2-74e2-53f8-869c-6fe6b07b9dba
响应示例
{
"statusCode": 800,
"returnObj": {
"alarmRule": {
"regionID": "81f7728662dd11ec810800155d307d5b",
"alarmRuleID": "3dbd23b2-74e2-53f8-869c-6fe6b07b9dba",
"triggerID": "634d170039fa5e04c4a33614",
"name": "告警规则lyc123",
"desc": "",
"repeatTimes": 0,
"service": "ecs",
"dimension": "ecs",
"level": 1,
"silenceTime": 300,
"recoverNotify": 0,
"notifyType": [],
"contactGroupList": [],
"notifyWeekdays": [0,1,2,3],
"notifyStart": "00:00:00",
"notifyEnd": "23:00:00",
"for": 120,
"metric": "cpu_util",
"operator": "ge",
"value": "1000",
"period": "5m",
"fun": "avg",
"instanceID": "000f0322-1f4d-8cc8-bb2e-1c30fb751aa5",
"instanceName": "000f0322-1f4d-8cc8-bb2e-1c30fb751aa5",
"deviceUUID": "000f0322-1f4d-8cc8-bb2e-1c30fb751aa5",
"status": 0
}
},
"errorCode": "",
"message": "Success",
"msgDesc": "成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 描述 |
|---|---|
| 其他 | 参见公共错误码说明 |
