告警规则
自定义监控告警规则：查询列表
接口功能介绍
根据筛选项查询自定义监控告警规则列表。
接口约束
regionID（资源池）存在。
URI
GET /v4/monitor/query-custom-alarm-rules
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | ctyun资源池ID | 81f7728662dd11ec810800155d307d5b | |
| status | 否 | Integer | 本参数表示告警规则启用状态。取值范围：0：启用。1：停用。根据以上范围取值。 | 0 | |
| alarmStatus | 否 | Integer | 本参数表示告警规则告警状态。取值范围：0：正常。1：正在告警。根据以上范围取值。 | 0 | |
| sort | 否 | String | 本参数表示排序条件，-表示降序。支持的排序字段：updateTime：更新时间。根据以上范围取值。 | -updateTime | |
| name | 否 | String | 规则名称 | test | |
| pageNo | 否 | Integer | 页码，默认为1 | 1 | |
| pageSize | 否 | Integer | 页大小，默认为20 | 10 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败），默认值：800 | 800 | |
| errorCode | String | 失败时的错误代码，参见公共错误码说明 | ||
| message | String | 失败时的错误描述，一般为英文描述 | Success | |
| msgDesc | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| error | String | 错误码，请求成功时，不返回该字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回对象 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| alarmRules | Array of Objects | 告警规则 | alarmRule | |
| totalCount | Integer | 总记录数 | 20 | |
| currentCount | Integer | 当前页记录数 | 10 | |
| totalPage | Integer | 总页数 | 2 |
表 alarmRule
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| regionID | String | ctyun资源池ID | 81f7728662dd11ec810800155d307d5b | |
| alarmRuleID | String | 告警规则ID | 3dbd23b2-74e2-53f8-869c-6fe6b07b9dba | |
| name | String | 规则名 | 告警规则lyc123 | |
| desc | String | 描述 | test | |
| repeatTimes | Integer | 重复告警通知次数 | 1 | |
| silenceTime | Integer | 静默时间，单位：秒 | 300 | |
| recoverNotify | Integer | 本参数表示恢复是否通知。默认值0。取值范围：0：否。1：是。根据以上范围取值。 | 0 | |
| notifyType | Array of Strings | 告警接收策略 | ['email', 'sms'] | |
| contactGroupList | Array of Strings | 告警联系人组 | ['000f0322-1f4d-8cc8-bb2e-1c30fb751ccc'] | |
| notifyWeekdays | Array of Integers | 通知周期 | [0,1,2,3] | |
| notifyStart | String | 通知起始时段 | 00:00:00 | |
| notifyEnd | String | 通知结束时段 | 23:59:59 | |
| webhookUrl | Array of Strings | 否 | ['https://www.ctyun.cn/'] | 告警状态变更webhook推送地址 |
| evaluationCount | Integer | 持续周期数 | 2 | |
| customItemID | String | 自定义监控指标 | ITEM63cb8954325480a3202307071801 | |
| fun | String | 本参数表示告警采用算法。取值范围：last：原始值算法。avg：平均值算法。max：最大值算法。min：最小值算法。根据以上范围取值。 | avg | |
| operator | String | 本参数表示比较符。默认值le。取值范围：eq：等于。gt：大于。ge：大于等于。lt：小于。le：小于等于。根据以上范围取值。 | eq | |
| value | String | 告警阈值，可以是整数、小数或百分数格式字符串 | 0 | |
| period | String | 本参数表示算法统计周期。默认值5m。参数fun为last时不可传。参数fun为avg、max、min均需填此参数。本参数格式为“数字+单位”。单位取值范围：m：分钟。h：小时。d：天。根据以上范围取值。 | 5m | |
| dimensions | Array of Objects | 否 | 自定义监控项维度 | |
| status | Integer | 本参数表示告警规则启用状态。取值范围：0：启用。1：停用。根据以上范围取值。 | 0 | |
| alarmStatus | Integer | 本参数表示告警规则告警状态。取值范围：0：正常。1：正在告警。根据以上范围取值。 | 0 | |
| createTime | Integer | 创建时间 | 1689580180000 | |
| updateTime | Integer | 更新时间 | 1689580180000 |
表 dimValue
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| name | String | 是 | host | 维度名称 |
| value | Array of Strings | 是 | ['自定义值1','自定义值2'] | 维度值 |
请求示例
请求url
/v4/monitor/query-custom-alarm-rules?regionID=81f7728662dd11ec810800155d307d5b&status=1&page=1&pageSize=1
请求头header
无
请求体body
无
响应示例
{
"statusCode": 800,
"returnObj": {
"alarmRules": [
{
"alarmRuleID": "3dbd23b2-74e2-53f8-869c-6fe6b07b9dba",
"regionID": "81f7728662dd11ec810800155d307d5b",
"name": "自定义告警规则测试",
"desc": "test",
"repeatTimes": 0,
"silenceTime": 300,
"recoverNotify": 0,
"notifyType": ["email"],
"contactGroupList": [],
"notifyWeekdays": [0, 1, 2, 3, 4, 5, 6],
"notifyStart": "00:00:00",
"notifyEnd": "23:59:59",
"webhookUrl": ["https://www.ctyun.cn/"],
"evaluationCount": 5,
"customItemID": "ITEM63cb8954325480a3202307071801",
"fun": "avg",
"operator": "ge",
"value": "0",
"period": "5m",
"dimensions": [
{
"name" : "dim1",
"value": "value1"
}
],
"createTime":1689580180000,
"updateTime":1689580180000
}
],
"totalCount": 2,
"currentCount": 1,
"totalPage": 2
},
"errorCode": "",
"message": "Success",
"msgDesc":"成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功 |
错误码
| 错误码 | 描述 |
|---|---|
| 其他 | 参见公共错误码说明 |
