監控看板：視圖詳情
更新時間 2024-09-25 16:20:48
最近更新時間: 2024-09-25 16:20:48
分享文章
監控看板
監控看板：視圖詳情
接口功能介紹
查看監控看板詳細信息，包括視圖信息，不包含監控數據信息。
接口約束
參見請求參數說明。
URI
GET /v4/monitor/monitor-board/describe-view
路徑參數
無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 資源池ID | 81f7728662dd11ec810800155d307d5b | |
| viewID | 是 | String | 監控視圖ID | 0bf803e8-5049-11ed-8fb7-005056897257 |
請求參數
請求頭header參數
無
請求體body參數
無
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼（800為成功，900為失敗），默認值：800 | 800 | |
| errorCode | String | 失敗時的錯誤代碼，參見公共錯誤碼說明 | ||
| message | String | 失敗時的錯誤描述，一般為英文描述 | Success | |
| msgDesc | String | 失敗時的錯誤描述，適配中英文 | 成功 | |
| description | String | 失敗時的錯誤描述，適配中英文 | 成功 | |
| error | String | 錯誤碼，請求成功時，不返回該字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回對象 | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| viewID | String | 監控視圖ID | 0a84e6da-9fab-fcd1-1552-6ab6a0b7ac88 | |
| name | String | 監控視圖名稱 | name | |
| service | String | 云監控服務 | ecs | |
| dimension | String | 云監控維度 | ecs | |
| viewType | String | 視圖類型。取值范圍:timeSeries：折線圖。gauge：儀表盤。barChart：柱狀圖。table：表格。pieChart：餅狀圖。根據以上范圍取值。 | timeSeries | |
| orderIndex | Integer | 排序次序，相同則按照updateTime降序。 | 0 | |
| itemNameList | Array of Strings | 監控指標，指標項最多支持20個 | ['cpu_util'] | |
| compares | Array of Strings | 同比環比比較時間配置，格式為“數字+單位”，單位為空時默認為秒。單位取值范圍：m：分鐘。h：小時。d：天。根據以上范圍取值。 | ['1d'] | |
| resources | Array of Objects | 監控資源實例 ,監控資源實例最多支持20個 | resource | |
| gaugePattern | Object | 儀表盤配置，僅當viewType為gaugePattern時有效 | gaugePattern | |
| createTime | Integer | 創建時間，時間戳，精確到秒 | 1667459789 | |
| updateTime | Integer | 最近更新時間, 時間戳，精確到秒 | 1667459789 |
表 resource
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| resource | Array of Objects | 資源 | obj |
表 obj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| key | String | 資源鍵 | uuid | |
| value | String | 資源鍵對應的值 | xxxx |
表 gaugePattern
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| minVal | Integer | 儀表盤最小值 | 0 | |
| maxVal | Integer | 儀表盤最大值 | 100 | |
| threshold | Array of Integers | 儀表盤中間分段取值 | [30,80] |
請求示例
請求url
/v4/monitor/monitor-board/describe-view?regionID=81f7728662dd11ec810800155d307d5b&viewID=0bf803e8-5049-11ed-8fb7-005056897257
請求頭header
無
請求體body
無
響應示例
{
"statusCode": 800,
"returnObj": {
"viewID": "44cd30c9-25c9-1d98-fa27-a663d575458a",
"name": "viewname",
"service": "ecs",
"dimension": "ecs",
"viewType": "timeSeries",
"orderIndex": 0,
"itemNameList": [
"cpu_util"
],
"createTime": 1713924685,
"updateTime": 1713924685,
"compares": [
],
"resources": [
{
"resource": [
{
"key": "uuid",
"value": "e5cb0fe0-5314-ede8-a10d-7a9aada50958"
}
]
}
],
"gaugePattern": {
"minVal": 0,
"maxVal": 0,
"threshold": [
0,
0
]
}
},
"errorCode": "",
"message": "Success",
"msgDesc": "成功",
"description": "成功"
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| Monitor.MonitorBoard.ViewNotExist | 視圖不存在 |
| 其他 | 參見公共錯誤碼說明 |
