监控看板
监控看板:查询系统看板支持的服务维度
接口功能介绍
查询系统看板支持的服务维度。
接口约束
参见请求参数说明。
URI
GET /v4/monitor/monitor-board/query-sys-services
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID | 81f7728662dd11ec810800155d307d5b |
请求参数
请求头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
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
data | Array of Objects | 服务维度信息 | data |
表 data
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
service | String | 云监控服务 | ecs | |
serviceName | String | 云监控服务的名称 | 云主机 | |
dimensions | Array of Objects | 云监控维度 | dimension |
表 dimension
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
dimension | String | 云监控维度 | ecs | |
dimensionName | String | 云监控维度的名称 | 云主机 |
请求示例
请求url
/v4/monitor/monitor-board/query-sys-services?regionID=1234567890
请求头header
无
请求体body
无
响应示例
{
"statusCode": 800,
"returnObj": {
"data": [
{
"service": "ecs",
"serviceName": "云主机",
"dimensions": [
{
"dimension": "ecs",
"dimensionName": "云主机"
}
]
}
]
},
"errorCode": "",
"message": "Success",
"msgDesc": "成功",
"description": "成功"
}
状态码
状态码 | 描述 |
---|---|
200 | 请求成功 |
错误码
errorCode | 描述 |
---|---|
其他 | 参见公共错误码说明 |