自定义监控-查询数据接口
更新时间：2021-06-21
接口描述
获取自定义监控指定指标的一个或多个统计数据的时间序列数据。
接口限制
o 一次返回的数据点数目不能超过1440个。
请求结构
- 请求方法：POST
- 请求URL：/csm/api/v1/userId/{userId}/custom/namespaces/{namespace}/metrics/{metricName}/data
参数列表
URL参数
| 名称 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| userId | String | 租户ID | 是 |
| namespace | String | 名字空间 | 是 |
| metricName | String | 监控指标名称 | 是 |
RequestBody参数
| 名称 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| statistics | String，可选值为average,maximum,minimum,sum,sampleCount | 统计方法类型 | 是 |
| dimensions | List<String>，由dimensionName:dimensionValue组成。当监控项具备多个维度时使用分号连接，例如dimensionName:dimensionValue;dimensionName:dimensionValue，相同维度只能指定一个维度值 | 维度列表 | 是 |
| startTime | String,请参考日期与时间，UTC日期表示 | 查询起始时间 | 是 |
| endTime | String,请参考日期与时间，UTC日期表示 | 查询截止时间 | 是 |
| cycle | Integer，单位：秒（s） | 统计周期 | 是 |
参数解释
- 名字空间namespace、监控项metric、统计方法statistic、维度dimensions等的概念请参考核心概念。
响应参数
| 名称 | 类型 | 描述 |
|---|---|---|
| requestId | String | 请求标识 |
| code | String | 返回码 |
| message | String | 错误信息 |
| dataPoints | List（DataPoint） | 监控指标 |
| dimensions | List（Dimensions） | 维度组合 |
DataPoint
| 名称 | 类型 | 描述 |
|---|---|---|
| average | double | 统计周期内监控项的平均值 |
| sum | double | 统计周期内监控项的和值 |
| minimum | double | 统计周期内监控项的最小值 |
| maximum | double | 统计周期内监控项的最大值 |
| sampleCount | Integer | 统计周期内监控项数据点数 |
| timestamp | String,请参考日期与时间，UTC日期表示 | 监控项统计周期对应的时间 |
Dimensions
| 名称 | 类型 | 描述 |
|---|---|---|
| name | String | 维度名 |
| value | String | 维度值 |
请求示例
POST /csm/api/v1/userId/useer1/custom/namespaces/namespace1/metrics/metricName1/data HTTP/1.1
Host:bcm.cnhzpro.agilecloud.com:80
{
"startTime":"2020-12-31T08:00:00Z",
"endTime":"2020-12-31T08:02:00Z",
"dimensions":[
"dimension1:myMachine;dimension2:myService"
],
"statistics":"average",
"cycle":60
} 响应示例
成功响应示例
在查询数据的时候，需要填写statistics参数，该参数的值决定了响应里一个dataPoint会有哪些属性。
当statistics=average时，返回结果示例如下：
HTTP/1.1 200 OK
x-bce-request-id: dwegvad4-dwea-4d3dsa-8ew2-4b7263fs1ecd
Content-Type: application/json;charset=UTF-8
[
{
"dataPoints": [
{
"average": 2.24,
"timestamp": "1609387200"
},
{
"average": 0.22,
"timestamp": "1609387260"
},
{
"average": 0.19,
"timestamp": "1609387320"
}
],
"dimensions":[
{
"name": "dimension1",
"value": "myMachine"
},
{
"name": "dimension2",
"value": "myService"
}
]
}
]失败响应示例
情况一 未查询到数据。在请求中指定用户、名字空间、监控项及维度下，从开始时间至结束时间内没有查询到监控数据。
当这种情况发生时，会为您返回对应的时间点，但没有监控数据
HTTP/1.1 200 OK
x-bce-request-id: dd00bad4-d22a-4d1c-8f12-4b513f0b91ec
Content-Type: application/json;charset=UTF-8
[
{
"dataPoints": [
{
"timestamp": "1609387200"
},
{
"timestamp": "1609387260"
},
{
"timestamp": "1609387320"
}
],
"dimensions":[
{
"name": "dimension1",
"value": "myMachine"
},
{
"name": "dimension2",
"value": "myService"
}
]
}
]情况二 参数不正确。下例为statistics参数不是可选集合范围中的值。
HTTP/1.1 200 OK
x-bce-request-id: dd00bad4-d22a-4d1c-8f12-4b513f0b91ec
Content-Type: application/json;charset=UTF-8
{
"requestId": "dd00bad4-d22a-4d1c-8f12-4b513f0b91ec",
"code": "ParameterValueException",
"message": "The request param value: max is misMatch."
}下例为维度参数中值的格式不正确。
HTTP/1.1 200 OK
x-bce-request-id: dd00bad4-d22a-4d1c-8f12-4b513f0b91ec
Content-Type: application/json;charset=UTF-8
{
"requestId": "dd00bad4-d22a-4d1c-8f12-4b513f0b91ec",
"code": "ParamValueNotInScopeException",
"message": "The request param dimension value mismatch."
}