事件告警规则：查看详情
更新时间 2026-03-27 16:49:20
最近更新时间: 2026-03-27 16:49:20
接口功能介绍
查看事件告警规则的详情信息。
接口约束
regionID（资源池）和alarmRuleID（告警规则）存在。
URI
GET /v4/monitor/describe-event-alarm-rule
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
| alarmRuleID | 是 | String | 告警规则ID | 3dbd23b2-74e2-53f8-869c-6fe6b07b9dba |
请求参数
请求头header参数 无
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败），默认值：800 | 800 | |
| errorCode | String | 失败时的错误代码，参见公共错误码说明 | ||
| message | String | 失败时的错误描述，一般为英文描述 | Success | |
| msgDesc | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| description | String | 失败时的错误描述，适配中英文 | 成功 | |
| error | String | 错误码，请求成功时，不返回该字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回对象 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| alarmRuleID | String | 告警规则ID | 2c2472df-f633-5b4b-be45-9609fc9f8154 | |
| regionID | String | ctyun资源池ID | 81f7728662dd11ec810800155d307d5b | |
| name | String | 规则名 | ctyun_rule | |
| desc | String | 描述 | demo | |
| service | String | 本参数表示服务。取值范围： ecs：云主机。 evs：云硬盘。 pms：物理机。 ... 云监控服务，具体服务参见云监控：查询服务维度及监控项 | ecs | |
| dimension | String | 本参数表示告警维度。取值范围： ecs：云主机。 disk：磁盘。 pms：物理机。 ... 云监控服务，具体服务参见云监控：查询服务维度及监控项 | ecs | |
| repeatTimes | Integer | 重复告警通知次数 | 0 | |
| silenceTime | Integer | 告警接收策略静默时间，多久重复通知一次，单位为秒 | 300 | |
| recoverNotify | Integer | 本参数表示恢复是否通知。取值范围： 0：否。 1：是。 根据以上范围取值。 | 0 | |
| notifyType | Array of Strings | 本参数表示告警接收策略。取值范围： email：邮件告警。 sms：短信告警。 根据以上范围取值。 | ['email','sms'] | |
| contactGroupList | Array of Objects | 告警联系人组 | contactGroup | |
| notifyWeekdays | Array of Integers | 本参数表示通知周期。取值范围： 0：周日。 1：周一。 2：周二。 3：周三。 4：周四。 5：周五。 6：周六。 根据以上范围取值。 | [0,1,2,3,4,5,6] | |
| notifyStart | String | 通知起始时段，默认为00:00:00 | 00:00:00 | |
| notifyEnd | String | 通知结束时段，默认为23:59:59 | 23:59:59 | |
| webhookUrl | Array of Strings | webhook消息推送url地址 | ['https://www.ctyun.cn/'] | |
| status | Integer | 本参数表示告警规则启用状态。取值范围： 0：启用。 1：停用。 根据以上范围取值。 | 0 | |
| alarmStatus | Integer | 本参数表示告警规则告警状态。取值范围： 0：正常。 1：正在告警。 根据以上范围取值。 | 0 | |
| createTime | Integer | 创建时间，毫秒级时间戳。 | 1689580180000 | |
| updateTime | Integer | 更新时间，毫秒级时间戳。 | 1689580180000 | |
| projectID | String | 项目ID | 0 | |
| conditions | Array of Objects | 具体匹配策略 | condition | |
| resources | Array of Objects | 资源信息列表 | resources | |
| resourceScope | Integer | 规则的资源范围，取值范围： 0：实例资源类型。 1：资源分组类型。 2：全部资源类型 。 根据以上范围取值。 | 0 | |
| defaultContact | Integer | 是否使用天翼云默认联系人接收通知，取值范围： 0：否。 1：是。 根据以上范围取值。 | 0 |
表 contactGroup
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| contactGroupID | String | 告警联系人组ID | 000f0322-1f4d-8cc8-bb2e-1c30fb751ccc | |
| name | String | 告警联系人组名称 | 告警组aaa |
表 condition
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| eventName | String | 事件指标 | migration_event_start | |
| description | String | 事件中文描述 | 云主机迁移发生 | |
| value | String | 出现次数，告警阈值，整数格式字符串 | 1 | |
| period | String | 本参数表示算法统计周期。 | 5m | |
| level | Integer | 告警等级。取值范围： 1：紧急。 2：警示。 3：普通。 根据以上范围取值。 | 3 |
表 resources
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| resource | Array of Objects | 资源信息 | resourceObj |
表 resourceObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| name | String | 资源实例标签键 | uuid | |
| value | String | 资源实例标签值 | 17d7e40a-1f4e-bca6-fdb4-37dbb43237ee |
枚举参数
无
请求示例
请求url
/v4/monitor/describe-event-alarm-rule?regionID=81f7728662dd11ec810800155d307d5b&alarmRuleID=524ea0e0-6c64-5ba7-9d06-345abc18b9b6
请求头header
无
请求体body
无
响应示例
{
"statusCode": 800,
"returnObj": {
"alarmRuleID": "524ea0e0-6c64-5ba7-9d06-345abc18b9b6",
"regionID": "81f7728662dd11ec810800155d307d5b",
"name": "ctyun_rule",
"desc": "描述",
"service": "ecs",
"dimension": "ecs",
"repeatTimes": 0,
"silenceTime": 300,
"recoverNotify": 0,
"notifyWeekdays": [
0,
1,
2,
3,
4,
5,
6
],
"notifyStart": "00:00:00",
"notifyEnd": "23:59:59",
"webhookUrl": [
],
"status": 0,
"alarmStatus": 0,
"createTime": 1735095127000,
"updateTime": 1735106272000,
"projectID": "0",
"conditions": [
{
"eventName": "migration_event_start",
"description": "云主机因其他异常发生迁移",
"value": "13",
"period": "2h",
"level": 3
}
],
"resources": [
{
"resource": [
{
"name": "uuid",
"value": "7dd744ea-5a02-61d3-e627-38f82f5fd3e1"
},
{
"name": "instancename",
"value": "ecmaf97"
}
]
}
],
"resourceScope": 0,
"defaultContact": 0,
"notifyType": [
"sms",
"email"
],
"contactGroupList": [
]
},
"errorCode": "",
"message": "Success",
"msgDesc": "成功",
"description": "成功"
}
状态码
请参考 状态码
错误码
请参考 错误码
