示例
更新時間 2023-07-19 11:40:59
最近更新時間: 2023-07-19 11:40:59
分享文章(zhang)
說明
當前接口使用前請使用資源池概況信息查詢接口查詢(xun)待(dai)對接的資源(yuan)(yuan)池(chi)(chi)信息，如(ru)資源(yuan)(yuan)池(chi)(chi)概(gai)況(kuang)信息查詢(xun)結果為"regionVersion":"v4.0",即可使用(yong)；如(ru)資源(yuan)(yuan)池(chi)(chi)概(gai)況(kuang)信息結果為";regionVersion":"v3.0",請使用(yong)舊版。
接口功能介紹
查詢告警歷史。
接口約束
regionID（資(zi)源池）存在(zai)，searchKey（搜索(suo)關鍵詞(ci)）滿(man)足參數(shu)說(shuo)明范圍。
URI
GET /v4/monitor/query-alert-history
請求參數
Query參數
| 參數 | 參數類型 | 是否必填 | 示例 | 說明 | 下級對象 |
|---|---|---|---|---|---|
| regionID | String | 是 | 81f7728662dd11ec810800155d307d5b | ctyun資源池ID | |
| azName | String | 是 | 可用區1 | 填寫可用區名稱或者 default。您可以調用資源池可用區查詢獲取資源池信息，查詢結果中zoneList內返回可用區名稱，若查詢結果中zoneList為空，即為單可用區，本字段填寫default。 | |
| searchKey | String | 否 | contactGroupName | 本參數表示搜索關鍵詞。取值范圍： contactGroupName：聯系人組名，模糊查詢。 triggerID：監控平臺規則ID，精確查詢。 instanceName：實例名，模糊查詢。 name：告警規則名稱，模糊查詢。 根據以上范圍取值。 |
|
| searchValue | String | 否 | test | 配合searchKey使用，對應的值 | |
| status | Integer | 否 | 0 | 本參數表示狀態。取值范圍： 0：正常。 1：告警。 根據以上范圍取值。 |
|
| service | String | 否 | ecs | 本參數表示告警服務。取值范圍： ecs：云主機。 evs：云硬盤。 pms：物理機。 ... 詳見“告警規則：獲取告警服務列表”接口返回。 |
|
| page | Integer | 否 | 1 | 頁碼，默認為1 | |
| pageSize | Integer | 否 | 10 | 頁大小，默認為20 |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼（800為成功，900為失敗），默認值：800 | 800 | |
| errorCode | String | 失敗時的錯誤代碼，參見公共錯誤碼說明 | ||
| message | String | 失敗時的錯誤描述，一般為英文描述 | Success | |
| msgDesc | String | 失敗時的錯誤描述，一般為中文描述 | 成功 | |
| returnObj | Object | 返回對象 | returnObj |
表returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| issues | Array of Objects | 告警事件列表 | issue | |
| totalCount | Integer | 記錄總數 | 1 | |
| page | Integer | 頁碼 | 1 | |
| pageSize | Integer | 頁大小 | 20 |
表issue
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| triggerID | String | 監控平臺規則ID | 634fac0339fa5e04c4a33648 | |
| status | Integer | 本參數表示狀態。取值范圍：0：正常。1：告警。根據以上范圍取值。 | 1 | |
| lastChange | String | 更新時間 | 2022-10-19T07:53:36Z | |
| name | String | 規則名稱 | 告警規則lyc123 | |
| service | String | 服務 | ecs | |
| dimension | String | 維度 | ecs | |
| level | Integer | 本參數表示報警級別。取值范圍：1：災難告警。2：嚴重告警。3：一般告警。4：警告告警。根據以上范圍取值。 | 1 | |
| deviceUUID | String | 設備唯一ID | 000f0322-1f4d-8cc8-bb2e-1c30fb751aa5 | |
| instanceName | String | 實例名 | 000f0322-1f4d-8cc8-bb2e-1c30fb751aa5 | |
| instanceID | String | 實例ID | 000f0322-1f4d-8cc8-bb2e-1c30fb751aa5 | |
| clock | String | 觸發時間 | 2022-10-19T07:51:32Z | |
| notifyType | Array of String | 告警接收策略 | ["email"] |
請求示例
GET /v4/monitor/query-alert-history?regionID=81f7728662dd11ec810800155d307d5b&searchKey=name&searchValue=告警規則&service=ecs&status=1&page=1&pageSize=1
響應示例
{
"statusCode": 800,
"returnObj": {
"issues": [
{
"triggerID": "634fac0339fa5e04c4a33648",
"status": 0,
"desc":
"test",
"lastChange": "2022-10-19T07:53:36Z",
"name": "告警規則lyc123",
"service": "ecs",
"dimension": "ecs",
"deviceUUID": "000f0322-1f4d-8cc8-bb2e-1c30fb751aa5",
"instanceName": "000f0322-1f4d-8cc8-bb2e-1c30fb751aa5",
"instanceID": "000f0322-1f4d-8cc8-bb2e-1c30fb751aa5",
"level": 1,
"clock": "2022-10-19T07:51:32Z",
"notifyType":[]
}
],
"totalCount": 21,
"page": 1,
"pageSize": 1
},
"errorCode": "",
"message": "Success",
"msgDesc":"成功"
}
