告警概覽：告警Top指標
更新時間 2024-09-25 16:20:54
最近更新時間: 2024-09-25 16:20:54
分享文章
告警概覽
告警Top指標
接口功能介紹
調用此接口可查詢指定資源池下告警Top指標。
接口約束
regionID（資源池）存在。
URI
GET /v4/monitor/query-alarm-top-metric
路徑參數
無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 資源池ID | 81f7728662dd11ec810800155d307d5b | |
| range | 否 | String | 時間范圍，默認值:7d，取值示例：7d，24h，6h 分別代表最近7天，最近24小時，最近6小時。 時間范圍最長不能超過3個月 | 7d |
請求參數
請求頭header參數
無
請求體body參數
無
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼（800為成功，900為失敗），默認值：800 | 800 | |
| errorCode | String | 失敗時的錯誤代碼，參見公共錯誤碼說明 | ||
| message | String | 失敗時的錯誤描述，一般為英文描述 | Success | |
| msgDesc | String | 失敗時的錯誤描述，適配中英文 | 成功 | |
| description | String | 失敗時的錯誤描述，適配中英文 | 成功 | |
| error | String | 錯誤碼，請求成功時，不返回該字段 | Openapi.Parameter.Error | |
| returnObj | Array of Objects | 返回對象 | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| service | String | 產品服務 | ecs | |
| dimension | String | 產品維度 | ecs | |
| serviceDesc | String | 產品服務描述 | 云主機 | |
| dimensionDesc | String | 產品維度描述 | 云主機 | |
| metric | String | 監控指標 | mem_util | |
| metricDesc | String | 監控指標描述 | 內存使用率 | |
| count | Integer | 告警次數 | 15 |
請求示例
請求url
/v4/monitor/query-alarm-top-metric?regionID=81f7728662dd11ec810800155d307d5b
請求頭header
無
請求體body
無
響應示例
{
"statusCode": 800,
"returnObj": [
{
"service": "cloud_backup",
"dimension": "storage_pool",
"metric": "used_vault_size",
"count": 83,
"metricDesc": "云備份存儲庫使用量",
"serviceDesc": "云備份",
"dimensionDesc": "云備份"
},
{
"service": "ecs",
"dimension": "ecs",
"metric": "mem_util",
"count": 27,
"metricDesc": "內存使用率",
"serviceDesc": "云主機",
"dimensionDesc": "云主機"
},
{
"service": "ecs",
"dimension": "ecs",
"metric": "cpu_util",
"count": 25,
"metricDesc": "CPU使用率",
"serviceDesc": "云主機",
"dimensionDesc": "云主機"
},
{
"service": "elb",
"dimension": "elb",
"metric": "lb_newcreate",
"count": 13,
"metricDesc": "實例每秒新建連接數",
"serviceDesc": "負載均衡",
"dimensionDesc": "負載均衡"
},
{
"service": "cstor_sfs",
"dimension": "cstor_sfs",
"metric": "fs_write_iops",
"count": 12,
"metricDesc": "文件系統寫iops",
"serviceDesc": "彈性文件",
"dimensionDesc": "彈性文件"
}
],
"errorCode": "",
"message": "Success",
"msgDesc": "成功",
"description": "成功"
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| Openapi.Overview.ParamValueOutOfRange | 參數取值超出范圍 |
| 其他 | 參見公共錯誤碼說明 |
