一键告警
一键告警：产品配置详情
接口功能介绍
此接口用于获取单个产品一键告警规则配置信息。
接口约束
无。
URI
GET /v4/monitor/alert-onekey/describe-alert-config
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | ctyun资源池ID | 81f7728662dd11ec810800155d307d5b | |
| service | 是 | String | 本参数表示产品名称。取值范围：ecs：云主机。evs：云硬盘。...详见“[一键告警：产品列表]”接口返回。 | ecs | |
| alarmType | 是 | String | 本参数表示告警类型。 取值范围：series：时序指标。event：事件。 根据以上范围取值。 | series |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败），默认值：800 | 800 | |
| errorCode | String | 失败时的错误代码，参见公共错误码说明 | ||
| message | String | 失败时的错误描述，一般为英文描述 | Success | |
| msgDesc | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| error | String | 错误码，请求成功时，不返回该字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回参数 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| alertConfigList | Array of Objects | 初始化规则列表 | alertConfig |
表 alertConfig
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| alarmRuleID | String | 规则ID | 83bd7537-9e06-5a45-a3b5-f4b13a7e81ea | |
| name | String | 规则名称 | 告警规则123 | |
| service | String | 服务。取值范围：ecs：云主机。evs：云硬盘。...详见“[一键告警：产品列表]”接口返回。 | ecs | |
| dimension | String | 维度。取值范围：ecs：云主机。disk：磁盘。pms：物理机。...详见“告警规则：获取告警服务维度关系”接口返回。 | ecs | |
| evaluationCount | Integer | 连续出现次数 | 5 | |
| metric | String | 指标名 | cpu_util | |
| repeatTimes | Integer | 重复告警通知次数，默认为0 | 3 | |
| silenceTime | Integer | 告警接收策略静默时间，多久重复通知一次，单位为秒 | 300 | |
| recoverNotify | Integer | 恢复是否通知。值范围：0：否。1：是。 | 0 | |
| notifyType | Array of Strings | 告警接收策略。值范围：email：邮件告警。sms：短信告警。 | ['email'] | |
| contactGroupList | Array of Strings | 告警联系人组 | ['000f0322-1f4d-8cc8-bb2e-1c30fb751ccc'] | |
| notifyWeekdays | Array of Integers | 通知周期。值范围：0：周日。1：周一。2：周二。3：周三。4：周四。5：周五。6：周六。 | [0,1,2,3,4,5,6] | |
| notifyStart | String | 通知起始时段 | 00:00:00 | |
| notifyEnd | String | 通知结束时段 | 23:59:59 | |
| webhookUrl | Array of Strings | 告警状态变更webhook推送地址 | ['https://www.ctyun.cn'] | |
| status | Integer | 告警规则启用状态。值范围：0：启用。1：停用。 | 0 | |
| createTime | Integer | 创建时间 | 1689580180000 | |
| updateTime | Integer | 更新时间 | 1689580180000 | |
| operator | String | 注意：一键告警规则的告警类型（alarmType）为事件类型（event）时，没有此返回参数。 此参数表示比较符。范围：eq：等于。gt：大于。ge：大于等于。lt：小于。le：小于等于。根据以上范围取值。 | eq | |
| value | String | 注意：一键告警规则的告警类型（alarmType）为事件类型（event）时，没有此返回参数。 此参数表示告警阈值，可以是整数、小数或百分数格式字符串 | 20 | |
| unit | String | 单位 | % |
请求示例
请求url
/v4/monitor/alert-onekey/describe-service-config?regionID=81f7728662dd11ec810800155d307d5b&service=ecs&alarmType=series
请求头header
无
请求体body
无
响应示例
{
"statusCode": 800,
"returnObj": {
"alertConfigList": [
{
"alarmRuleID": "55e07acc-b661-52b0-ad80-7fb4db598122",
"name": "CPU使用率一键告警",
"service": "ecs",
"dimension": "ecs",
"evaluationCount": 20,
"unit": "",
"metric": "cpu_util",
"repeatTimes": 0,
"silenceTime": 300,
"recoverNotify": 0,
"notifyWeekdays": [
0,
1,
2,
3,
4,
5,
6
],
"notifyStart": "00:00:00",
"notifyEnd": "23:59:59",
"webhookUrl": [
"https://www.ctyun.cn/"
],
"status": 0,
"createTime": 1709870419000,
"updateTime": 1709870419000,
"notifyType": [
"email"
],
"contactGroupList": [
]
},
{
"alarmRuleID": "557496c5-a4c8-5fe8-b813-f5ee6a523495",
"name": "内存使用率一键告警",
"service": "ecs",
"dimension": "ecs",
"evaluationCount": 5,
"unit": "",
"metric": "mem_util",
"repeatTimes": 0,
"silenceTime": 300,
"recoverNotify": 0,
"notifyWeekdays": [
0,
1,
2,
3,
4,
5,
6
],
"notifyStart": "00:00:00",
"notifyEnd": "23:59:59",
"webhookUrl": [
"https://www.ctyun.cn/"
],
"status": 0,
"createTime": 1709870419000,
"updateTime": 1709870419000,
"notifyType": [
"email"
],
"contactGroupList":[
"6618d45b-b42d-5085-9c49-b73e6053cad6"
]
}
]
},
"errorCode": "",
"message": "Success",
"msgDesc": "成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 描述 |
|---|---|
| 其他 | 参见公共错误码说明 |
