監控看板：更新系統看板資源
更新時間 2024-09-25 16:20:47
最近更新時間: 2024-09-25 16:20:47
分享文章
監控看板
監控看板：更新系統看板資源
接口功能介紹
為系統看板增加監控資源實例，會用給定的新資源替換原有舊資源。僅支持系統看板。
接口約束
參見請求參數說明。
URI
POST /v4/monitor/monitor-board/update-sys-resources
路徑參數
無
Query參數
無
請求參數
請求頭header參數
無
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 資源池ID | 81f7728662dd11ec810800155d307d5b | |
| boardID | 是 | String | 系統監控看板ID | 58631437-d489-7105-d9ac-9bc044d7b6ab | |
| resources | 是 | Array of Objects | 監控資源實例， 監控資源實例最多支持20個 | resource |
表 resource
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| resource | 是 | Array of Objects | 資源 | obj |
表 obj
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| key | 是 | String | 資源鍵 | uuid | |
| value | 是 | String | 資源鍵對應的值 | xxxx |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼（800為成功，900為失敗），默認值：800 | 800 | |
| errorCode | String | 失敗時的錯誤代碼，參見公共錯誤碼說明 | ||
| message | String | 失敗時的錯誤描述，一般為英文描述 | Success | |
| msgDesc | String | 失敗時的錯誤描述，適配中英文 | 成功 | |
| description | String | 失敗時的錯誤描述，適配中英文 | 成功 | |
| error | String | 錯誤碼，請求成功時，不返回該字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回對象 | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| success | Boolean | 是否更新成功 | true |
請求示例
請求url
/v4/monitor/monitor-board/update-sys-resources
請求頭header
無
請求體body
{
"regionID": "1234567890",
"boardID": "58631437-d489-7105-d9ac-9bc044d7b6ab",
"resources": [
{
"resource": [
{
"key": "uuid",
"value": "3280eb61-b0c4-3413-5bb2-a2b0d79a6870"
}
]
}
]
}
響應示例
{
"statusCode": 800,
"returnObj": {
"success": true
},
"errorCode": "",
"message": "Success",
"msgDesc": "成功",
"description": "成功"
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| Monitor.MonitorBoard.NotExist | 監控看板不存在 |
| 其他 | 參見公共錯誤碼說明 |
