云监控标准
云监控：查询服务维度及监控项
接口功能介绍
获取资源池下服务、维度、监控项信息。
接口约束
资源池ID不能为空。
URI
GET /v4/monitor/query-items
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
| service | 否 | String | 服务 | ecs | |
| itemType | 否 | String | 本参数表示监控项类型。不传返回全部类型。取值范围：series：指标类型。event：事件类型。根据以上范围取值。 | series |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败），默认值：800 | 800 | |
| errorCode | String | 失败时的错误代码，参见公共错误码说明 | ||
| message | String | 失败时的错误描述，一般为英文描述 | Success | |
| msgDesc | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| error | String | 错误码，请求成功时，不返回该字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回对象 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| data | Array of Objects | 统计信息列表 | dataObj |
表 dataObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| service | String | 服务 | ecs | |
| description | String | 描述 | 云主机 | |
| dimensions | Array of Objects | 维度列表 | dimensionObj | |
| serviceCount | Integer | 服务下监控项数量 | 10 |
表 dimensionObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| dimension | String | 维度 | ecs | |
| description | String | 描述 | 云主机 | |
| monitorItems | Array of Objects | 监控资源列表 | monitorItem | |
| dimensionCount | Integer | 维度下监控项数量 | 10 |
表 monitorItem
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| name | String | 监控项的key | cpu_util | |
| metricName | String | 监控项名称 | CPU使用率 | |
| description | String | 监控指标描述 | CPU使用率 | |
| unit | String | 指标单位 | % | |
| unitRelations | Array of Objects | 单位转换字典 | unitRelation | |
| dimensions | Array of Strings | 设备标签列表 | ['uuid'] | |
| isAlarm | Integer | 本参数表示是否支持告警。取值范围：0：不支持。1：支持。根据以上范围取值。 | 1 | |
| period | Integer | 上报周期 | 60 | |
| statistics | Array of Strings | 本参数表示趋势计算类型。取值范围：max：最大值。 min：最小值。 avg：平均值。 sum：求和。var：方差。origin：原始值。根据以上范围取值。 | ['avg','max','min'] | |
| itemType | Integer | 本参数表示监控项类型。取值范围：0：实例指标。1：分组指标。根据以上范围取值。 | 0 |
表 unitRelation
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| unit | String | 单位 | % | |
| weight | Double | 权重 | 1 |
请求示例
请求url
/v4/monitor/query-items?regionID=81f7728662dd11ec810800155d307d5b&service=ecs
请求头header
无
请求体body
无
响应示例
{
"statusCode": 800,
"returnObj": {
"data": [
{
"service": "ecs",
"description": "云主机",
"dimensions": [
{
"dimension": "ecs",
"description": "云主机",
"monitorItems": [
{
"name": "cpu_util",
"description": "CPU使用率",
"unit": "%",
"isAlarm": 1,
"period": 60,
"dimensions": [
"uuid"
],
"statistics": [
"min",
"avg",
"max",
"var"
],
"metricName": "CPU使用率",
"unitRelations": [
{
"weight": 1,
"unit": "%"
}
],
"itemType": 0
},
{
"name": "mem_util",
"description": "内存使用率",
"unit": "%",
"isAlarm": 1,
"period": 60,
"dimensions": [
"uuid"
],
"statistics": [
"avg",
"max",
"var",
"min"
],
"metricName": "内存使用率",
"unitRelations": [
{
"weight": 1,
"unit": "%"
}
],
"itemType": 0
}
],
"dimensionCount": 2
}
],
"serviceCount": 2
}
]
},
"errorCode": "",
"message": "Success",
"msgDesc": "成功",
"description": "成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 描述 |
|---|---|
| 其他 | 参见公共错误码说明 |
