监控看板
监控看板：查看详情
接口功能介绍
查看监控看板详细信息，包括视图信息，不包含监控数据信息。
接口约束
参见请求参数说明。
URI
GET /v4/monitor/monitor-board/describe
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
| boardID | 是 | 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
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| views | Array of Objects | 监控视图列表 | view | |
| viewQuota | Integer | 监控视图配额剩余数量 | 10 |
表 view
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| 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?regionID=81f7728662dd11ec810800155d307d5b&boardID=0bf803e8-5049-11ed-8fb7-005056897257
请求头header
无
请求体body
无
响应示例
{
"statusCode": 800,
"returnObj": {
"views": [
{
"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": "3280eb61-b0c4-3413-5bb2-a2b0d79a6870"
}
]
}
],
"gaugePattern": {
"minVal": 0,
"maxVal": 0,
"threshold": [
0,
0
]
}
}
],
"viewQuota": 12
},
"errorCode": "",
"message": "Success",
"msgDesc": "成功",
"description": "成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 描述 |
|---|---|
| Monitor.MonitorBoard.NotExist | 监控看板不存在 |
| 其他 | 参见公共错误码说明 |
