云監控：查詢服務維度及監控項
更新時間 2025-03-26 09:45:42
最近更新時間: 2025-03-26 09:45:42
分享文章
云監控標準
云監控：查詢服務維度及監控項
接口功能介紹
獲取資源池下服務、維度、監控項信息。
接口約束
資源池ID不能為空。
URI
GET /v4/monitor/query-items
路徑參數
無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 資源池ID | 81f7728662dd11ec810800155d307d5b | |
| service | 否 | String | 服務 | ecs | |
| dimension | 否 | String | 維度 | ecs | |
| itemType | 否 | String | 本參數表示監控項類型。不傳返回全部類型。取值范圍：series：指標類型。event：事件類型。根據以上范圍取值。 | series | |
| isEnterpriseProject | 否 | Boolean | 是否支持企業項目 | true | |
| ignoreItems | 否 | Boolean | 監控項過濾參數，為true時不展示監控項信息 | true |
請求參數
請求頭header參數
無
請求體body參數
無
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼（800為成功，900為失敗），默認值：800 | 800 | |
| errorCode | String | 失敗時的錯誤代碼，參見公共錯誤碼說明 | ||
| message | String | 失敗時的錯誤描述，一般為英文描述 | Success | |
| msgDesc | String | 失敗時的錯誤描述，一般為中文描述 | 成功 | |
| error | String | 錯誤碼，請求成功時，不返回該字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回對象 | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| data | Array of Objects | 統計信息列表 | dataObj |
表 dataObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| service | String | 服務 | ecs | |
| description | String | 描述 | 云主機 | |
| dimensions | Array of Objects | 維度列表 | dimensionObj | |
| serviceCount | Integer | 服務下監控項數量 | 10 |
表 dimensionObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| dimension | String | 維度 | ecs | |
| description | String | 描述 | 云主機 | |
| monitorItems | Array of Objects | 監控資源列表 | monitorItem | |
| dimensionCount | Integer | 維度下監控項數量 | 10 |
表 monitorItem
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| name | String | 監控項的key | cpu_util | |
| metricName | String | 監控項名稱 | CPU使用率 | |
| description | String | 監控指標描述 | CPU使用率 | |
| unit | String | 指標單位 | % | |
| unitRelations | Array of Objects | 單位轉換字典 | unitRelation | |
| dimensions | Array of Strings | 設備標簽列表 | ['uuid'] | |
| isAlarm | Integer | 本參數表示是否支持告警。取值范圍：0：不支持。1：支持。根據以上范圍取值。 | 1 | |
| isEvent | Integer | 本參數表示是否為事件類型。取值范圍：0：事件類型。1：指標類型。根據以上范圍取值。 | 1 | |
| period | Integer | 上報周期 | 60 | |
| statistics | Array of Strings | 本參數表示趨勢計算類型。取值范圍：max：最大值。 min：最小值。 avg：平均值。 sum：求和。var：方差。origin：原始值。根據以上范圍取值。 | ['avg','max','min'] | |
| itemType | Integer | 本參數表示監控項類型。取值范圍：0：實例指標。1：分組指標。根據以上范圍取值。 | 0 | |
| metricClass | String | 監控類的key | virtual_machine | |
| metricClassName | String | 監控類名稱 | 云主機監控項 |
表 unitRelation
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| unit | String | 單位 | % | |
| weight | Double | 權重 | 1 |
請求示例
請求url
/v4/monitor/query-items?regionID=81f7728662dd11ec810800155d307d5b&service=ecs
請求頭header
無
請求體body
無
響應示例
{
"statusCode": 800,
"returnObj": {
"data": [
{
"service": "ecs",
"description": "云主機",
"dimensions": [
{
"dimension": "ecs",
"description": "云主機",
"monitorItems": [
{
"name": "cpu_util",
"description": "CPU使用率",
"unit": "%",
"isAlarm": 1,
"isEvent": 1,
"period": 60,
"dimensions": [
"uuid"
],
"statistics": [
"min",
"avg",
"max",
"var"
],
"metricName": "CPU使用率",
"metricClass":"virtual_machine",
"metricClassName":"云主機監控項",
"unitRelations": [
{
"weight": 1,
"unit": "%"
}
],
"itemType": 0
},
{
"name": "mem_util",
"description": "內存使用率",
"unit": "%",
"isAlarm": 1,
"isEvent": 1,
"period": 60,
"dimensions": [
"uuid"
],
"statistics": [
"avg",
"max",
"var",
"min"
],
"metricName": "內存使用率",
"metricClass":"virtual_machine",
"metricClassName":"云主機監控項",
"unitRelations": [
{
"weight": 1,
"unit": "%"
}
],
"itemType": 0
}
],
"dimensionCount": 2
}
],
"serviceCount": 2
}
]
},
"errorCode": "",
"message": "Success",
"msgDesc": "成功",
"description": "成功"
}
狀態碼
請參考
錯誤碼
| errorCode | 描述 |
|---|---|
| 其他 | 請參考 |
