推送数据接口
更新时间：2019-06-14
接口描述
将数据推送至BCM进行监控。您在使用自定义监控功能时，可通过此接口将数据推送至BCM进行实时监控。
使用限制
目前，仅北京、广州、苏州、香港Region可使用自定义监控功能，其他Region不支持此功能。
请求结构
- 请求方法：POST
- URL：/json-api/v1/metricdata/{userid}/{scope}
- 请求body请参考下面的请求参数以及请求示例
请求参数
名称 |
类型 |
描述 |
是否必须 |
参数位置 |
|---|---|---|---|---|
| userId | String | 租户ID | 是 | URL参数 |
| scope | String，仅限于使用如下字符集合："0~9、A~Z、a~z"、 "_" | 名字空间 | 是 | URL参数 |
| metricData | List<MetricDatum> | 监控项数据 | 是 | RequestBody参数 |
MetricDatum
名称 |
类型 |
描述 |
是否必须 |
|---|---|---|---|
| metricName | String | 监控项名称 | 是 |
| dimensions | List<Dimension> | 维度 | 是 |
| value | double | 监控项取值 | 否 |
| timestamp | String | 时间 | 是 |
Dimension
名称 |
类型 |
描述 |
是否必须 |
|---|---|---|---|
| name | String | 维度名 | 是 |
| value | String | 维度值 | 是 |
响应参数
名称 |
类型 |
描述 |
|---|---|---|
| requestId | String | 请求标识 |
| code | String | 返回码 |
| message | String | 返回信息 |
请求示例
Plain Text
1POST /json-api/v1/metricdata/user1/UserDefined_BCC HTTP/1.1
2Host:bcm.bj.baidubce.com:80
3{
4 "metricData": [
5 {
6 "metricName": "pv",
7 "dimensions": [
8 {
9 "name": "os",
10 "value": "centos"
11 },
12 {
13 "name": "serviceName",
14 "value": "myService"
15 }
16 ],
17 "value": 1234567,
18 "timestamp": "2014-05-26T07:30:00Z"
19 },
20 {
21 "metricName": "responseTime",
22 "dimensions": [
23 {
24 "name": "os",
25 "value": "windows"
26 },
27 {
28 "name": "serviceName",
29 "value": "myService"
30 }
31 ],
32 "value": 1234568,
33 "timestamp": "2014-05-26T07:30:00Z"
34 }
35 ]
36}响应示例
成功响应示例
Plain Text
1{
2 "requestId": "45113fb2-fe84-411f-809b-9383d43003cd",
3 "code": "OK",
4 "message": ""
5}失败响应示例
Plain Text
1{
2 "requestId": "45113fb2-fe84-411f-809b-9383d43003cd",
3 "code": "INVALID_PARAMETER_VALUE",
4 "message": "Metric data required"
5}