自定义监控项：查询维度值
更新时间 2024-09-25 16:20:51
最近更新时间: 2024-09-25 16:20:51
自定义监控项
自定义监控项：查询维度值
接口功能介绍
调用此接口可查询指定自定义监控项的维度值。
接口约束
资源池ID，自定义监控项ID不能为空。
URI
POST /v4/monitor/query-custom-item/dimension-values
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
| customItemID | 是 | String | 自定义监控项ID | ITEM793d5923652be6ce202306291409 | |
| filter | 否 | Array of Objects | 要过滤的维度条件 | filterDimension | |
| dimensionName | 是 | String | 待查询的维度值 | usage |
表 filterDimension
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| name | 是 | String | 维度名称 | uuid | |
| value | 是 | Array of Strings | 维度对应值 | ['c0d6a468-7f93-f637-6668-591894339d59','b0d6a468-7f93-f637-6668-591894339d56'] |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败），默认值：800 | 800 | |
| errorCode | String | 失败时的错误代码，参见公共错误码说明 | ||
| message | String | 失败时的错误描述，一般为英文描述 | Success | |
| msgDesc | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| error | String | 错误码，请求成功时，不返回该字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回参数，参考returnObj对象结构 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| dimensionValueList | Array of Strings | 查询得到的维度值 | ['compute'] |
请求示例
请求url
/v4/monitor/query-custom-item/dimension-values
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"customItemID": "64ea1664-4347-558e-9bc6-651341c2fa15",
"filter": [
{
"name": "uuid",
"value": [
"c0d6a468-7f93-f637-6668-591894339d59",
"b0d6a468-7f93-f637-6668-591894339d56"
]
}
],
"dimensionName": "usage"
}
响应示例
{
"statusCode": 800,
"errorCode": "",
"message": "Success",
"msgDesc": "成功",
"returnObj": {
"dimensionValueList": [
"compute"
]
}
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 描述 |
|---|---|
| Monitor.CustomItem.DimensionNotFound | 维度不存在 |
| Monitor.CustomItem.ItemIDNotFound | 监控项ID不存在 |
| 其他 | 参见公共错误码说明 |
