监控看板
监控看板：创建
接口功能介绍
创建监控看板，可以创建空看板，也可以附带视图创建。
接口约束
- 可创建看板数量不能超过用户的看板配额数量。
- 其他参见请求参数说明。
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 | 看板数量超过配额数量 |
| 其他 | 参见公共错误码说明 |
