自定义监控-查询数据接口
更新时间：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 | 维度值 |
请求示例
Plain Text
1POST /csm/api/v1/userId/useer1/custom/namespaces/namespace1/metrics/metricName1/data HTTP/1.1
2Host:bcm.cnhzpro.agilecloud.com:80
3
4{
5 "startTime":"2020-12-31T08:00:00Z",
6 "endTime":"2020-12-31T08:02:00Z",
7 "dimensions":[
8 "dimension1:myMachine;dimension2:myService"
9 ],
10 "statistics":"average",
11 "cycle":60
12} 响应示例
成功响应示例
在查询数据的时候，需要填写statistics参数，该参数的值决定了响应里一个dataPoint会有哪些属性。
当statistics=average时，返回结果示例如下：
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: dwegvad4-dwea-4d3dsa-8ew2-4b7263fs1ecd
3Content-Type: application/json;charset=UTF-8
4[
5 {
6 "dataPoints": [
7 {
8 "average": 2.24,
9 "timestamp": "1609387200"
10 },
11 {
12 "average": 0.22,
13 "timestamp": "1609387260"
14 },
15 {
16 "average": 0.19,
17 "timestamp": "1609387320"
18 }
19 ],
20 "dimensions":[
21 {
22 "name": "dimension1",
23 "value": "myMachine"
24 },
25 {
26 "name": "dimension2",
27 "value": "myService"
28 }
29 ]
30 }
31]失败响应示例
情况一 未查询到数据。在请求中指定用户、名字空间、监控项及维度下，从开始时间至结束时间内没有查询到监控数据。
当这种情况发生时，会为您返回对应的时间点，但没有监控数据
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: dd00bad4-d22a-4d1c-8f12-4b513f0b91ec
3Content-Type: application/json;charset=UTF-8
4[
5 {
6 "dataPoints": [
7 {
8 "timestamp": "1609387200"
9 },
10 {
11 "timestamp": "1609387260"
12 },
13 {
14 "timestamp": "1609387320"
15 }
16 ],
17 "dimensions":[
18 {
19 "name": "dimension1",
20 "value": "myMachine"
21 },
22 {
23 "name": "dimension2",
24 "value": "myService"
25 }
26 ]
27 }
28]情况二 参数不正确。下例为statistics参数不是可选集合范围中的值。
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: dd00bad4-d22a-4d1c-8f12-4b513f0b91ec
3Content-Type: application/json;charset=UTF-8
4{
5 "requestId": "dd00bad4-d22a-4d1c-8f12-4b513f0b91ec",
6 "code": "ParameterValueException",
7 "message": "The request param value: max is misMatch."
8}下例为维度参数中值的格式不正确。
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: dd00bad4-d22a-4d1c-8f12-4b513f0b91ec
3Content-Type: application/json;charset=UTF-8
4{
5 "requestId": "dd00bad4-d22a-4d1c-8f12-4b513f0b91ec",
6 "code": "ParamValueNotInScopeException",
7 "message": "The request param dimension value mismatch."
8}