監控看板：創建
更新時間 2025-03-26 09:51:23
最近更新時間: 2025-03-26 09:51:23
分享文章
監控看板
監控看板：創建
接口功能介紹
創建監控看板，可以創建空看板，也可以附帶視圖創建。
接口約束
- 可創建看板數量不能超過用戶的看板配額數量。
- 其他參見請求參數說明。
URI
POST /v4/monitor/monitor-board/create
路徑參數
無
Query參數
無
請求參數
請求頭header參數
無
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 資源池ID | 81f7728662dd11ec810800155d307d5b | |
| name | 是 | String | 監控看板名稱， 同資源池下看板名稱不可重復 | 名稱 | |
| views | 否 | Array of Objects | 監控視圖 | view |
表 view
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| name | 是 | String | 監控視圖名稱 | 名稱 | |
| service | 是 | String | 云監控服務 | ecs | |
| dimension | 是 | String | 云監控維度 | ecs | |
| viewType | 是 | String | 視圖類型。取值范圍:timeSeries：折線圖。gauge：儀表盤。barChart：柱狀圖。table：表格。pieChart：餅狀圖。根據以上范圍取值。 | timeSeries | |
| orderIndex | 否 | Integer | 視圖排序次數。默認值為0。 | 0 | |
| itemNameList | 是 | Array of Strings | 監控指標，指標項最多支持20個，當viewType為gauge和pieChart時，僅支持單監控指標 | ['cpu_util'] | |
| compares | 否 | Array of Strings | 同比環比比較時間配置，格式為“數字+單位”，單位為空時默認為秒。當前只支持1d和7d。單位取值范圍：m：分鐘。h：小時。d：天。根據以上范圍取值。 | ['1d'] | |
| resources | 是 | Array of Objects | 監控資源實例，監控對象最多支持20個，當viewType為gauge時，僅支持單資源實例 | resource | |
| gaugePattern | 否 | Object | 儀表盤配置，僅當viewType為gauge時生效 | gaugePattern |
表 resource
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| resource | 是 | Array of Objects | 資源 | obj |
表 obj
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| key | 是 | String | 資源鍵 | uuid | |
| value | 是 | String | 資源鍵對應的值 | 5ac245b3-dd9b-75c3-cee5-d1b674bb0d69 |
表 gaugePattern
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| minVal | 否 | Integer | 儀表盤最小值。默認值為0 | 0 | |
| maxVal | 否 | Integer | 儀表盤最大值。默認值為100 | 100 | |
| threshold | 否 | Array of Integers | 儀表盤中間分段取值，長度必須為2。默認值為[30,80] | [30,80] |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼（800為成功，900為失敗），默認值：800 | 800 | |
| errorCode | String | 失敗時的錯誤代碼，參見公共錯誤碼說明 | ||
| message | String | 失敗時的錯誤描述，一般為英文描述 | Success | |
| msgDesc | String | 失敗時的錯誤描述，適配中英文 | 成功 | |
| description | String | 失敗時的錯誤描述，適配中英文 | 成功 | |
| error | String | 錯誤碼，請求成功時，不返回該字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回對象 | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| boardID | String | 監控看板ID | fb33ae47-415f-4026-23ad-c8492a667e9c | |
| viewIDs | Array of Strings | 視圖ID | [ '5ac245b3-dd9b-75c3-cee5-d1b674bb0d69'] |
請求示例
請求url
/v4/monitor/monitor-board/create
請求頭header
無
請求體body
{
"name": "看板1",
"regionID": "1234567890",
"views": [
{
"name": "視圖1",
"service": "ecs",
"dimension": "ecs",
"viewType": "timeSeries",
"itemNameList": [
"cpu_util"
],
"resources": [
{
"resource": [
{
"key": "uuid",
"value": "3280eb61-b0c4-3413-5bb2-a2b0d79a6870"
}
]
}
],
}
]
}
響應示例
{
"statusCode": 800,
"returnObj": {
"boardID": "fb33ae47-415f-4026-23ad-c8492a667e9c",
"viewIDs": [
"5ac245b3-dd9b-75c3-cee5-d1b674bb0d69"
]
},
"errorCode": "",
"message": "Success",
"msgDesc": "成功",
"description": "成功"
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| Monitor.MonitorBoard.NameAlreadyExist | 監控看板名稱已存在 |
| Monitor.MonitorBoard.ViewNameDuplicated | 視圖名稱重復 |
| Monitor.MonitorBoard.BoardQuotaLimit | 看板數量超過配額數量 |
| 其他 | 參見公共錯誤碼說明 |
