Custom Metric Push API Description
Push time-series data to BCM for monitoring. With the Custom Monitor feature, you can transmit time-series data to BCM via this API for real-time monitoring.
Request structure
Method: POST
URL:/csm/api/v1/userId/{userId}/custom/data
For URL parameters and Request body, refer to the parameter list and Request example below
Parameter list
URL parameter
Name
Types
Description
Required or not
userId
String
Tenant ID
Yes
RequestBody
Name
Types
Description
Required or not
namespace
String
Scope
Yes
metricName
String
Monitor item name
Yes
dimensions
List<Dimension >
Dimension
Yes
value
double
Monitor item value
Yes
timestamp
String
Time
Yes
Dimension
Name
Types
Description
Required or not
name
String
Dimension name
Yes
value
String
Dimension value
Yes
Response parameters
Name
Types
Description
requestId
String
Request identifier
code
String
Return code
message
String
Return information
Request example
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"
}
Response example
Unsuccessful response example
{
"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."
}
Custom Event API Description
Push event data to BCM for monitoring. (Note: The event bus is now online. Historical custom events can continue to use the old event push API. For new events, please refer to [ Event Bus Event Set ](BCM/Operation guide/Event Bus/Event Set.md))
Request structure
Method: POST
URL:/csm/api/v1/custom/event/data
For the request body, refer to the parameter list and examples below
Parameter list
RequestBody
Name
Types
Description
Required or not
userId
String
Tenant ID
Yes
namespace
String
Scope
Yes
eventName
String
Event name
Yes
eventNameAlias
String
Event alias
No
eventLevel
String, optional set: CRITICAL, MAJOR, WARNING, NOTICE
Event Level
Yes
comment
String
Remarks
No
eventId
String
Unique ID of event
Yes
timestamp
String
Time
Yes
region
String
Region
Yes
Response parameters
Name
Types
Description
requestId
String
Request identifier
code
String
Return code
message
String
Return information
Request example
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 error count exceeded limit\",\"advice\":\"Contact service personnel for repair\"}",
"eventId": "345678fghjgjhdgsfd",
"region":"bj",
"timestamp": "2020-12-31T08:00:00Z"
}
Response example
Unsuccessful response example
{
"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 error count exceeded limit\",\"advice\":\"Contact service personnel for repair\"}, timestamp=2020-12-31T08:00:00Z, eventId=345678fghjgjhdgsfd, region=hb) isvalid."
}