This topic describes how to report custom events by sending an HTTP request.
Endpoints
For more information about the endpoints for reporting custom events, see Appendix 3: Endpoints for reporting monitoring data.
Request syntax
An HTTP request uses the following syntax to report custom events:
POST /event/custom/upload HTTP/1.1
Authorization:<AuthorizationString>
Content-Length:<Content Length>
Content-MD5:<Content MD5>
Content-Type:application/json
Date:<GMT Date>
Host:metrichub-cms-cn-hangzhou.aliyuncs.com
x-cms-signature:hmac-sha1
x-cms-api-version:1.0
x-cms-ip:30.27.XX.XX
User-Agent:cms-java-sdk-v-1.0
[{"content":"EventContent","groupId":GroupId,"name":"EventName","time":"20171023T144439.948+0800"}]Request headers and parameters
The following tables describe the headers and parameters in an HTTP request for reporting custom events.
Request headers
Header
Type
Description
Authorization
String
The authorization string that is in the format of
AccessKeyID:SignString.For information about how to obtain the AccessKey ID, see Obtain an AccessKey pair.
For information about how to sign the string, see Does Cloud Monitor support the HMAC-SHA1 signature algorithm and how do I use it?.
Content-Length
Long
The body length of the HTTP request that is defined in RFC 2616. This header is required only if the request has a body.
Content-MD5
String
The MD5 hash of the HTTP request body. The MD5 hash is a string that consists of uppercase letters and digits. This header is required only if the request has a body.
Content-Type
String
The type of the content that is sent in the HTTP request. Set the value to
application/json.Date
String
The standard timestamp header of the HTTP request. This timestamp header follows the time format defined in RFC 1123 and uses the UTC standard time.
Example:
Mon, 3 Jan 2010 08:33:47 GMT.Host
String
The full hostname of the HTTP request. This header does not include protocol headers such as https://.
Example:
metrichub-cms-cn-hangzhou.aliyuncs.com.x-cms-api-version
String
The version of the API. Set the value to 1.0.
x-cms-signature
String
The signature algorithm. Cloud Monitor supports the HMAC-SHA1 signature algorithm.
x-cms-ip
String
The IP address of the host that reports the custom events.
User-Agent
String
The description of the client.
Request parameters
Parameter
Type
Required
Description
content
String
Yes
The details of the custom event.
name
String
Yes
The name of the custom event.
groupId
Long
No
The ID of the application group to which the custom event belongs.
time
String
No
The time when the custom event occurred.
Sample response
The following code shows the sample response to an HTTP request that reports custom events:
{
"code":"200",// The HTTP status code 200 indicates that the request was successful.
"msg":""// The value is empty if the events are reported.
}