監控看板：查詢列表
更新時間 2024-09-25 16:20:48
最近更新時間: 2024-09-25 16:20:48
分享文章
監控看板
監控看板：查詢列表
接口功能介紹
查詢監控看板列表，僅返回基礎信息，不返回視圖信息。
接口約束
參見請求參數說明。
URI
GET /v4/monitor/monitor-board/list
路徑參數
無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 資源池ID | 81f7728662dd11ec810800155d307d5b | |
| boardType | 否 | String | 看板類型。默認all。取值范圍：all：查詢所有。system：系統默認看板。custom：自定義看板。根據以上范圍取值。 | system | |
| name | 否 | String | 名稱模糊搜索 | name | |
| service | 否 | String | 視圖中包含指定云監控服務的看板，僅當boardType為system時有效 | ecs | |
| dimension | 否 | String | 視圖中包含指定云監控維度的看板，僅當boardType為system時有效 | ecs | |
| pageNo | 否 | Integer | 頁碼，默認為1 | 1 | |
| pageSize | 否 | Integer | 頁大小，默認為10 | 2 |
請求參數
請求頭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
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| boardList | Array of Objects | 監控看板列表 | board | |
| currentCount | Integer | 當前頁記錄數 | 14 | |
| totalCount | Integer | 總記錄數 | 2 | |
| totalPage | Integer | 總頁數 | 1 | |
| boardQuota | Integer | 監控看板配額剩余數量 | 10 |
表 board
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| boardID | String | 監控看板ID | 0a84e6da-9fab-fcd1-1552-6ab6a0b7ac88 | |
| type | String | 看板類型。取值范圍：system：系統默認看板。custom：自定義看板。根據以上范圍取值。 | system | |
| name | String | 監控看板名稱 | name | |
| createTime | Integer | 創建時間，時間戳，精確到秒 | 1667459789 | |
| updateTime | Integer | 最近更新時間, 時間戳，精確到秒 | 1667459789 |
請求示例
請求url
/v4/monitor/monitor-board/list?regionID=1234567890
請求頭header
無
請求體body
無
響應示例
{
"statusCode": 800,
"returnObj": {
"boardList": [
{
"boardID": "947dcfbd-c5c8-4117-bfc7-0588de9489e7",
"type": "custom",
"name": "看板1",
"createTime": 1713924685,
"updateTime": 1713924685
},
{
"boardID": "a07da011-44d1-4c46-8dd7-d77ab10f82fa",
"type": "system",
"name": "board",
"createTime": 1711011480,
"updateTime": 1711011480
}
],
"totalCount": 2,
"currentCount": 2,
"boardQuota": 10,
"totalPage": 1
},
"errorCode": "",
"message": "Success",
"msgDesc": "成功",
"description": "成功"
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| 其他 | 參見公共錯誤碼說明 |
