告警規則：查詢列表v4.1
更新時間 2024-12-05 10:40:57
最近更新時間: 2024-12-05 10:40:57
分享文章
告警規則
告警規則：查詢列表
接口功能介紹
根據篩選項查詢告警規則列表。
接口約束
regionID（資源池）存在。
URI
GET /v4.1/monitor/query-alarm-rules
路徑參數
無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 資源池ID | 81f7728662dd11ec810800155d307d5b | |
| service | 是 | String | 本參數表示服務。取值范圍：ecs：云主機。evs：云硬盤。pms：物理機。...詳見“告警規則：獲取告警服務列表”接口返回。 | ecs | |
| alarmStatus | 否 | Integer | 本參數表示告警規則是否告警。取值范圍：0：未觸發告警。1：觸發告警。2：無數據。根據以上范圍取值。 | 1 | |
| status | 否 | Integer | 本參數表示告警規則狀態。取值范圍：0：啟用。1：停用。根據以上范圍取值。 | 1 | |
| name | 否 | String | 規則名稱（模糊查詢） | 告警規則名稱 | |
| contactGroupName | 否 | String | 告警聯系組名（模糊查詢） | 聯系組 | |
| instanceName | 否 | String | 監控對象名稱（模糊查詢） | vpc-vpc2913 | |
| sortKey | 否 | String | 排序字段 | updateTime | |
| sortType | 否 | String | 排序類型。取值范圍：ASC：升序。DESC：降序。根據以上范圍取值。 | ASC | |
| pageNo | 否 | Integer | 頁碼，默認值：1 | 1 | |
| pageSize | 否 | Integer | 頁大小，默認值：20 | 10 | |
| resGroupID | 否 | String | 資源分組ID | eec4a76a-35ba-57b8-91c6-c4fd923351d6 |
請求參數
請求頭header參數
無
請求體body參數
無
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼（800為成功，900為失敗），默認值：800 | 800 | |
| errorCode | String | 失敗時的錯誤代碼，參見公共錯誤碼說明 | ||
| message | String | 失敗時的錯誤描述，一般為英文描述 | Success | |
| msgDesc | String | 失敗時的錯誤描述，一般為中文描述 | 成功 | |
| returnObj | Object | 返回對象 | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| alarmRules | Array of Objects | 告警規則 | alarmRule | |
| totalCount | Integer | 總記錄數 | 20 | |
| page | Integer | 當前頁記錄數 | 1 | |
| pageSize | Integer | 頁大小 | 2 |
表 alarmRules
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| regionID | String | 資源池ID | 81f7728662dd11ec810800155d307d5b | |
| alarmRuleID | String | 告警規則ID | 3dbd23b2-74e2-53f8-869c-6fe6b07b9dba | |
| name | String | 規則名 | 告警規則名稱 | |
| desc | String | 描述 | 描述 | |
| repeatTimes | Integer | 重復告警通知次數 | 1 | |
| service | String | 服務 | ecs | |
| dimension | String | 維度 | ecs | |
| 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] | |
| notifyStart | String | 通知起始時段 | 00:00:00 | |
| notifyEnd | String | 通知結束時段 | 23:59:59 | |
| status | Integer | 本參數表示告警規則啟用狀態。取值范圍：0：啟用。1：停用。根據以上范圍取值。 | 0 | |
| webhookUrl | Array of Strings | webhook消息推送url | ['www.daliqc.cn'] | |
| resGroupID | String | 資源分組ID | eec4a76a-35ba-57b8-91c6-c4fd923351d6 | |
| createTime | Integer | 創建時間 | 1666855494 | |
| updateTime | Integer | 更新時間 | 1666856960 | |
| projectID | String | 項目ID | ||
| resources | Array of Objects | 具體匹配資源 | resources | |
| condition | Array of Objects | 觸發規則的條件 | condition | |
| dimensions | Array of Objects | 自定義監控信息，僅支持部分資源池 | dimensions | |
| conditionType | Integer | 本參數表示告警策略觸發類型。取值范圍：0：或，任一條件觸發。1：全部條件滿足觸發。根據以上范圍取值。 | 0 | |
| alarmStatus | Integer | 本參數表示告警規則是否告警。取值范圍：0：未觸發告警。1：觸發告警。2：無數據（僅部分資源池支持）。根據以上范圍取值。 | 1 | |
| alarmType | String | 告警規則類型。取值范圍：series：時序類監控。event：事件類。根據以上范圍取值。 | 1 | |
| project | String | 告警規則來源 | console |
表 contactGroup
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| groupID | String | 聯系組ID | 392c2sfc-b05d-5f5c-ae1c-80c24c282090 | |
| name | String | 聯系組名稱 | 告警聯系組 |
表 condition
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| evaluationCount | Integer | 持續次數，當規則執行結果持續多久符合條件時報警（防抖），默認2次 | 2 | |
| metric | String | 監控指標 | cpu_util | |
| metricCnName | String | 監控指標中文名 | cpu使用率 | |
| fun | String | 本參數表示告警采用算法。取值范圍：last：原始值算法。avg：平均值算法。max：最大值算法。min：最小值算法。根據以上范圍取值。 | avg | |
| operator | String | 本參數表示比較符。取值范圍：eq：等于。gt：大于。ge：大于等于。lt：小于。le：小于等于。rg：環比上升。cf：環比下降。rc：環比變化。根據以上范圍取值。 | eq | |
| value | String | 告警閾值，可以是整數、小數或百分數格式字符串 | 0 | |
| period | String | 本參數表示算法統計周期。默認值5m。參數fun為last時不可傳。參數fun為avg、max、min均需填此參數。本參數格式為“數字+單位”。單位取值范圍：m：分鐘。h：小時。d：天。根據以上范圍取值。 | 5m | |
| unit | String | 監控指標單位 | bit |
表 resources
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| resource | Array of Objects | 資源信息 | resource |
表 resource
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| name | String | 資源實例標簽鍵 | uuid | |
| value | String | 資源實例標簽值 | 000f0322-1f4d-8cc8-bb2e-1c30fb751aa5 |
表 dimensions
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| name | String | 自定義監控資源實例標簽鍵 | uuid | |
| value | Array of Strings | 自定義監控資源實例標簽值 | ['1c30fb751aa5'] |
請求示例
請求url
/v4.1/monitor/query-alarm-rules?regionID=81f7728662dd11ec810800155d307d5b&alarmStatus=2&page=1&pageSize=1
請求頭header
無
請求體body
響應示例
{
"statusCode": 800,
"returnObj": {
"alarmRules": [
{
"alarmRuleID": "35809ee8-223c-538e-8981-90943405e866",
"alarmStatus": "1",
"alarmType": "series",
"condition": [
{
"evaluationCount": 1,
"fun": "last",
"metric": "vpn_gw_in_bps",
"metricCnName": "VPN網關入方向流量速率",
"operator": "ge",
"period": "",
"unit": "bps",
"value": "0"
}
],
"conditionType": 1,
"contactGroupList": [
{
"groupID": "fe7f0cdc-4692-5516-8d3a-b06355482090",
"name": "告警組"
}
],
"createTime": 1718594934,
"desc": "告警規則描述",
"dimension": "ipsec_vpn_gw_stats",
"dimensions": [
],
"name": "告警規則名稱",
"notifyEnd": "23:59:59",
"notifyStart": "00:00:00",
"notifyType": [
"email"
],
"notifyWeekdays": [
0,
1,
2,
3,
4,
5,
6
],
"project": "console",
"projectID": "0",
"recoverNotify": 0,
"regionID": "81f7728662dd11ec810800155d307d5b",
"repeatTimes": 0,
"resGroupID": "",
"resources": [
{
"resource": [
{
"name": "vpn_gateway_id",
"value": "614aa3b0-b232-4eb6-8b5a-5be0345e8108"
},
{
"name": "instancename",
"value": "vpn-gateway-a019"
}
]
}
],
"service": "ipsec_vpn",
"silenceTime": 300,
"status": 0,
"updateTime": 1718594934,
"webhookUrl": [
]
}
]
},
"errorCode": "",
"message": "Success",
"msgDesc": "成功"
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| 其他 | 參見公共錯誤碼說明 |
