监控看板
监控看板：查询列表
接口功能介绍
查询监控看板列表，仅返回基础信息，不返回视图信息。
接口约束
参见请求参数说明。
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 | 描述 |
|---|---|
| 其他 | 参见公共错误码说明 |
