自定义监控项
自定义监控项：查询
接口功能介绍
调用此接口可查询自定义监控项。
接口约束
资源池ID不能为空。
URI
GET /v4/monitor/query-custom-items
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
| customItemID | 否 | String | 自定义监控项ID | ITEM793d5923652be6ce202306291409 | |
| name | 否 | String | 监控项名称，支持模糊搜索 | 我的CPU使用率 | |
| pageNo | 否 | Integer | 页码，不传默认为1 | 1 | |
| pageSize | 否 | Integer | 每页大小，不传默认为10 | 10 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败），默认值：800 | 800 | |
| errorCode | String | 失败时的错误代码，参见公共错误码说明 | ||
| message | String | 失败时的错误描述，一般为英文描述 | Success | |
| msgDesc | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| error | String | 错误码，请求成功时，不返回该字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回参数，参考returnObj对象结构 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| customItemList | Array of Objects | 自定义监控项列表 | customItem | |
| totalCount | Integer | 总记录数 | 2 | |
| totalPage | Integer | 总页数 | 1 | |
| currentCount | Integer | 当前记录数 | 2 |
表 customItem
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| regionID | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
| customItemID | String | 自定义监控项ID | ITEM793d5923652be6ce202306291409 | |
| name | String | 监控项名称 | 我的CPU使用率 | |
| unit | String | 自定义监控项的单位 | % | |
| interval | Integer | 数据上报间隔，单位秒 | 60 | |
| dimensions | Array of Strings | 用于查询监控数据的维度 | ['uuid','usage'] | dimension |
表 dimension
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| name | String | 维度名称，支持英文、下划线 | uuid | |
| description | String | 维度描述，支持中文、英文、下划线 | 主机的唯一标识 |
请求示例
请求url
/v4/monitor/query-custom-items?regionID=81f7728662dd11ec810800155d307d5b&name=CPU使用率&pageNo=1&pageSize=10
请求头header
无
请求体body
无
响应示例
{
"statusCode": 800,
"errorCode":"",
"message": "Success",
"msgDesc": "成功",
"returnObj": {
"customItemList": [
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"customItemID": "ITEM793d5923652be6ce202306291409",
"name": "我的CPU使用率",
"unit": "%",
"interval": 60,
"dimensions": [
{
"name": "uuid",
"description": "主机的唯一标识"
},
{
"name": "usage",
"description": "主机用途"
}
]
},
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"customItemID": "ITEM233d5923652be6ce202306291409",
"name": "新的CPU使用率",
"unit": "%",
"interval": 300,
"dimensions": [
{
"name": "uuid",
"description": "主机的唯一标识"
},
{
"name": "host",
"description": "主机所在宿主机"
}
]
}
],
"totalCount": 2,
"totalPage": 1,
"currentCount": 2
}
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 描述 |
|---|---|
| 其他 | 参见公共错误码说明 |
