This topic describes how to report monitoring data by sending an HTTP request.


  • Public endpoint:
  • The following table describes the internal endpoints in different regions.
    Region RegionId Endpoint
    China (Hangzhou) cn-hangzhou
    China (Zhangjiakou) cn-zhangjiakou
    China (Shanghai) cn-shanghai
    China (Beijing) cn-beijing
    China (Qingdao) cn-qingdao
    China (Shenzhen) cn-shenzhen
    China (Hong Kong) cn-hongkong
    China (Hohhot) cn-huhehaote
    UAE (Dubai) me-east-1
    US (Silicon Valley) us-west-1
    US (Virginia) us-east-1
    Japan (Tokyo) ap-northeast-1
    Germany (Frankfurt) eu-central-1
    Australia (Sydney) ap-southeast-2
    Singapore (Singapore) ap-southeast-1
    Malaysia (Kuala Lumpur) ap-southeast-3
    India (Mumbai) ap-south-1

Request syntax

An HTTP request uses the following syntax to report monitoring data:
POST /metric/custom/upload HTTP/1.1 
Content-Length:<Content Length>
Content-MD5:<Content MD5>
Date:<GMT Date>

Request parameters

The following tables describe the headers and parameters in an HTTP request that reports monitoring data.
  • Request headers
    Header Type Description
    Authorization String The authorization string that is in the format of AccessKeyID:SignString.
    Content-Length Long The body length of the HTTP request that is defined in RFC 2616. This header is only required if the request has a body.
    Content-MD5 String The MD5 hash of the HTTP request body. The MD5 hash is a string consisting of uppercase letters and digits. This header is only required 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 format defined in RFC 1123 and uses the UTC standard time.

    Example: Mon, 3 Jan 2010 08:33:47 UTC.

    Host String The full hostname of the HTTP request. This header does not include the protocol header such as https://.


    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 only the HMAC-SHA1 signature algorithm.
    x-cms-ip String The IP address of the host that reports the monitoring data.
    User-Agent String The description of the client.
  • Request parameters
    Parameter Type Required Description
    groupId Long Yes The ID of the application group.
    metricName String Yes The name of the metric. For more information, see Overview.
    dimensions Object Yes The map of the monitored resources.

    The value is a collection of key-value pairs. A typical pair is instanceId:i-abcdefgh12****.

    time String Yes The timestamp when the metric data is generated. The timestamp can be in one of the following formats:
    • yyyyMMdd'T'HHmmss.SSSZ

      Example: 20171012T132456.888+0800.

    • long

      Example: 1508136760000.

    type Int Yes

    The type of the reported data. Valid values: 0 and 1. The value 0 indicates raw data and the value 1 indicates aggregate data.

    We recommend that you report aggregate data in both the aggregation periods of 60s and 300s. Otherwise, you cannot query monitoring data of a time span that is more than seven days.

    period String No

    The aggregation period. Unit: seconds.

    If the type parameter is set to 1, the period parameter is required. Valid values:
    • 60
    • 300
    values Object Yes The collection of metric values.

    If the type parameter is set to 0, the keys in this parameter must be set to the specified value. Cloud Monitor aggregates raw data in each aggregation period to generate multiple statistical values, such as the maximum value, the count, and the total value.

Sample success responses

The following example shows the sample response to an HTTP request that reports monitoring data:

  "code":"200",// The HTTP status code 200 indicates that the request was successful.
  "msg":""// The value is empty if monitoring data was reported.