接口描述
将数据推送至BCM进行监控。您在使用自定义监控功能时，可通过此接口将时序数据推送至BCM进行实时监控。
请求结构
- 请求方法：POST
- URL：/csm/api/v1/userId/{userId}/custom/data
- URL参数以及请求body请参考下面的参数列表以及请求示例
参数列表
URL参数
| 名称 |
类型 |
描述 |
是否必须 |
| userId |
String |
租户ID |
是 |
RequestBody参数
| 名称 |
类型 |
描述 |
是否必须 |
| namespace |
String |
名字空间 |
是 |
| metricName |
String |
监控项名称 |
是 |
| dimensions |
List<Dimension> |
维度 |
是 |
| value |
double |
监控项取值 |
是 |
| timestamp |
String |
时间 |
是 |
Dimension
| 名称 |
类型 |
描述 |
是否必须 |
| name |
String |
维度名 |
是 |
| value |
String |
维度值 |
是 |
响应参数
| 名称 |
类型 |
描述 |
| requestId |
String |
请求标识 |
| code |
String |
返回码 |
| message |
String |
返回信息 |
请求示例
POST /csm/api/v1/userId/user1/custom/data HTTP/1.1
Host:bcm.bj.baidubce.com:80
{
"namespace":"namespace1",
"metricName": "pv",
"dimensions": [
{
"name": "dimension1",
"value": "myMachine"
},
{
"name": "dimension2",
"value": "myService"
}
],
"value": 123,
"timestamp": "2020-12-31T08:00:00Z"
}
响应示例
失败响应示例
{
"requestId": "45113fb2-fe84-411f-809b-9383d43003cd",
"code": "ParameterValueException",
"message": "The request param metricName pv of saverMetricData SaverMetricData(namespace=namespace1, metricName=pv, dimensions=[dimension1:myMachine,dimension2:myMachine], value=123, statisticValues=null, timestamp=2020-12-31T08:00:00Z) isvalid."
}
接口描述
将事件数据推送至BCM进行报警。
请求结构
- 请求方法：POST
- URL：/csm/api/v1/custom/event/data
- 请求body请参考下面的参数列表以及请求示例
参数列表
RequestBody参数
| 名称 |
类型 |
描述 |
是否必须 |
| userId |
String |
租户ID |
是 |
| namespace |
String |
名字空间 |
是 |
| eventName |
String |
事件名称 |
是 |
| eventNameAlias |
String |
事件别名 |
否 |
| eventLevel |
String，可选集合：CRITICAL，MAJOR，WARNING，NOTICE |
事件级别 |
是 |
| comment |
String |
备注 |
否 |
| eventId |
String |
事件唯一ID |
是 |
| timestamp |
String |
时间 |
是 |
| region |
String |
区域 |
是 |
响应参数
| 名称 |
类型 |
描述 |
| requestId |
String |
请求标识 |
| code |
String |
返回码 |
| message |
String |
返回信息 |
请求示例
POST /csm/api/v1/custom/event/data HTTP/1.1
Host:bcm.bj.baidubce.com:80
{
"userId":"user1",
"namespace": "namespace1",
"eventName": "event1",
"eventNameAlias":"eventNameAlias1",
"eventLevel":"CRITICAL",
"comment":"{\"deviceID\":\"pd2\",\"info\":\"xxx错误次数超限\",\"advice\":\"联系服务人员维修\"}",
"eventId": "345678fghjgjhdgsfd",
"region":"bj",
"timestamp": "2020-12-31T08:00:00Z"
}
响应示例
失败响应示例
{
"requestId": "45113fb2-fe84-411f-809b-9383d43003cd",
"code": "ParameterValueException",
"message": "The request param eventConfigName event1 of customEventData CustomEventData(userId=user1, namespace=namespace1, eventName=event1, eventNameAlias=eventNameAlias1, eventLevel=CRITICAL, comment={\"deviceID\":\"pd2\",\"info\":\"xxx错误次数超限\",\"advice\":\"联系服务人员维修\"}, timestamp=2020-12-31T08:00:00Z, eventId=345678fghjgjhdgsfd, region=hb) isvalid."
}
