監控項列表：查詢
更新時間 2023-08-25 14:17:00
最近更新時間: 2023-08-25 14:17:00
分享文章
接口功能介紹
根據篩選條件查詢各設備類型支持的監控項的列表。
接口約束
deviceType（設備類型）符合取值范圍，具體見請求參數說明。
URI
GET /v4/monitor/query-monitor-items
請求參數
Query參數
| 參數 | 參數類型 | 是否必填 | 示例 | 說明 | 下級對象 |
|---|---|---|---|---|---|
| deviceType | String | 否 | vm | 本參數表示設備類型。默認值為所有類型。取值范圍：vm：云主機。bare_metal：裸金屬。disk：云磁盤。scaling：彈性伸縮。traffic：共享帶寬。eip：彈性IP。elb：負載均衡。listener：監聽器。cstor_sfs：彈性文件。site_monitor：站點監控。natgw：NAT網關。zos_bucket：對象存儲-存儲桶。zos_user：對象存儲-用戶。vnet_monitor_endpoint_statistic：VPC終端節點。vnet_endpoint_service_statistic：VPC終端節點服務。根據以上范圍取值。 |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼（800為成功，900為失敗），默認值：800 | 800 | |
| errorCode | String | 失敗時的錯誤代碼，參見公共錯誤碼說明 | ||
| message | String | 失敗時的錯誤描述，一般為英文描述 | Success | |
| msgDesc | String | 失敗時的錯誤描述，一般為中文描述 | 成功 | |
| returnObj | Object | 返回對象 | returnObj |
表returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| monitorItems | Array of Objects | 監控資源列表 | monitorItem |
表monitorItem
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| deviceType | String | 監控設備類型 | vm | |
| items | Array of Objects | 監控設備指標內容 | items |
表items
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| name | String | 監控指標名稱 | cpu_util | |
| desc | String | 監控指標描述 | CPU使用率 | |
| unit | String | 指標單位 | % |
請求示例
GET /v4/monitor/query-monitor-items?deviceType=vm
響應示例
{
"statusCode":800,
"returnObj":{
"monitorItems":[
{
"deviceType":"vm",
"items":[
{
"name":"cpu_util",
"desc":"CPU使用率",
"unit":"%"
},
{
"name":"mem_util",
"desc":"內存使用率",
"unit":"%"
}
]
}
]
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| Monitor.DeviceType.Unknown | 未知設備類型 |
| 其他 | 參見公共錯誤碼說明 |
