告警事件：查詢告警歷史詳情
更新時間 2024-09-25 16:20:54
最近更新時間: 2024-09-25 16:20:54
分享文章
告警事件
告警事件：查詢告警歷史詳情
接口功能介紹
查詢單條告警歷史詳情。
接口約束
無
URI
GET /v4/monitor/query-alert-history-info
路徑參數
無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| issueID | 是 | String | 告警歷史ID | 65b08a5848091836a6f2afd8 |
請求參數
請求頭header參數
無
請求體body參數
無
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼（800為成功，900為失敗），默認值：800 | 800 | |
| errorCode | String | 失敗時的錯誤代碼，參見公共錯誤碼說明 | ||
| message | String | 失敗時的錯誤描述，一般為英文描述 | Success | |
| msgDesc | String | 失敗時的錯誤描述，一般為中文描述 | 成功 | |
| error | String | 錯誤碼，請求成功時，不返回該字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回對象 | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| status | Integer | 本參數表示告警狀態。取值范圍：0：正在告警。1：告警歷史。根據以上范圍取值。 | 1 | |
| alarmType | String | 本參數表示告警類型。取值范圍：series：指標類型。event：事件類型。根據以上范圍取值。 | series | |
| infoID | String | 告警詳情ID | 65b08a5848091836a6f2afd9 | |
| service | String | 本參數表示服務。取值范圍：ecs：云主機。evs：云硬盤。pms：物理機。...詳見“告警規則：獲取告警服務列表”接口返回。 | ecs | |
| dimension | String | 本參數表示告警維度。取值范圍：ecs：云主機。disk：磁盤。pms：物理機。...詳見“告警規則：獲取告警服務維度關系”接口返回。 | ecs | |
| resource | Array of Objects | 告警資源 | resource | |
| condition | Object | 告警規則 | condition | |
| count | Integer | 資源告警出現次數 | 2 | |
| value | Double | 告警數據值 | 0.27116666 | |
| createTime | Integer | 觸發時間的時間戳 | 1698823059 | |
| updateTime | Integer | 結束時間的時間戳。 | 1698823059 |
表 resource
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| name | String | 監控指標 | cpu_util | |
| value | String | 監控指標中文描述 | cpu使用率 |
表 condition
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| metric | String | 監控指標 | cpu_util | |
| metricCnName | String | 監控指標中文描述 | cpu使用率 | |
| fun | String | 本參數表示告警采用算法。取值范圍：last：原始值算法。avg：平均值算法。max：最大值算法。min：最小值算法。根據以上范圍取值。 | avg | |
| operator | String | 本參數表示比較符。默認值le。取值范圍：eq：等于。gt：大于。ge：大于等于。lt：小于。le：小于等于。根據以上范圍取值。 | eq | |
| period | String | 本參數表示算法統計周期。默認值5m。參數fun為last時不可傳。參數fun為avg、max、min均需填此參數。本參數格式為“數字+單位”。單位取值范圍：m：分鐘。h：小時。d：天。根據以上范圍取值。 | 5m | |
| threshold | String | 告警閾值，可以是整數、小數或百分數格式字符串 | 0 | |
| unit | String | 單位。 | % |
請求示例
請求url
/v4/monitor/query-alert-history-info?issueID=65b08a5848091836a6f2afd8
請求頭header
無
請求體body
無
響應示例
{
"statusCode":800,
"returnObj":[
{
"resource":[
{
"name":"vpn_gateway_id",
"value":"13f47d3b-8e18-56db-a8d7-75be184964f5"
}
],
"infoID":"65b08a5848091836a6f2afd9",
"service":"ipsec_vpn",
"dimension":"ipsec_vpn_gw_stats",
"condition":{
"metric":"vpn_gw_in_bps",
"metricCnName":"VPN網關入方向流量速率",
"period":"5m",
"fun":"avg",
"operator":"eq",
"threshold":"0",
"unit":""
},
"createTime":1706068568,
"updateTime":1706079352,
"value":0,
"status":0,
"alarmType": "series",
"count":0
}
],
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| 其他 | 參見公共錯誤碼說明 |
