To send a CloudMonitor API request, you must send an HTTPS GET or HTTPS POST request to the CloudMonitor endpoint. You must add the request parameters that correspond to the API operation being called. After you call the API, the system returns a response. The request and response are encoded in UTF-8.

Request syntax

CloudMonitor API operations use the RPC protocol. You can call CloudMonitor API operations by sending HTTPS GET requests.

The following request syntax is used:
https://Endpoint/?Action=xx&Parameters
The following table describes the parameters in the request syntax.
Parameter Description
Endpoint The endpoint of the CloudMonitor API. For more information, see Endpoints.
Action The operation that you want to perform. For example, to query the monitoring data of a specified metric for a specified cloud service, you must set the Action parameter to DescribeMetricList.
Version The version number of the API. The version number of the CloudMonitor API is 2019-01-01.
Parameters The request parameters for the operation. Separate multiple parameters with ampersands (&).

Request parameters include both common parameters and operation-specific parameters. Common parameters include the API version number and authentication information. For more information, see Common parameters.

Endpoints

The following table lists the two types of CloudMonitor endpoints that are available in each region.
  • Public endpoint: You can use the public endpoint to access the CloudMonitor API over the Internet.
  • Virtual private cloud (VPC) endpoint: You can use the VPC endpoint to access the CloudMonitor API across VPCs that belong to the same region. You do not need to allow access to CloudMonitor from the Internet.
Alibaba Cloud region Region ID Endpoint
Chinese mainland N/A Public endpoint: metrics.aliyuncs.com
Note To access CloudMonitor in a region in the Chinese mainland, you can use the unified public endpoint or the endpoint that is specific to the region.
China (Hangzhou) cn-hangzhou
  • Public endpoint: metrics.cn-hangzhou.aliyuncs.com
  • VPC endpoint: metrics-vpc.cn-hangzhou.aliyuncs.com
China (Shanghai) cn-shanghai
  • Public endpoint: metrics.cn-shanghai.aliyuncs.com
  • VPC endpoint: metrics-vpc.cn-shanghai.aliyuncs.com
China (Shenzhen) cn-shenzhen
  • Public endpoint: metrics.cn-shenzhen.aliyuncs.com
  • VPC endpoint: metrics-vpc.cn-shenzhen.aliyuncs.com
China (Qingdao) cn-qingdao
  • Public endpoint: metrics.cn-qingdao.aliyuncs.com
  • VPC endpoint: metrics-vpc.cn-qingdao.aliyuncs.com
China (Beijing) cn-beijing
  • Public endpoint: metrics.cn-beijing.aliyuncs.com
  • VPC endpoint: metrics-vpc.cn-beijing.aliyuncs.com
China (Zhangjiakou) cn-zhangjiakou
  • Public endpoint: metrics.cn-zhangjiakou.aliyuncs.com
  • VPC endpoint: metrics-vpc.cn-zhangjiakou.aliyuncs.com
China (Hohhot) cn-huhehaote
  • Public endpoint: metrics.cn-huhehaote.aliyuncs.com
  • VPC endpoint: metrics-vpc.cn-huhehaote.aliyuncs.com
China (Ulanqab) cn-wulanchabu
  • Public endpoint: metrics.cn-wulanchabu.aliyuncs.com
  • VPC endpoint: metrics-vpc.cn-wulanchabu.aliyuncs.com
China (Heyuan) cn-heyuan
  • Public endpoint: metrics.cn-heyuan.aliyuncs.com
  • VPC endpoint: metrics-vpc.cn-heyuan.aliyuncs.com
China (Chengdu) cn-chengdu
  • Public endpoint: metrics.cn-chengdu.aliyuncs.com
  • VPC endpoint: metrics-vpc.cn-chengdu.aliyuncs.com
China (Guangzhou) cn-guangzhou
  • Public endpoint: metrics.cn-guangzhou.aliyuncs.com
  • VPC endpoint: metrics-vpc.cn-guangzhou.aliyuncs.com
China (Hong Kong) cn-hongkong
  • Public endpoint: metrics.cn-hongkong.aliyuncs.com
  • VPC endpoint: metrics-vpc.cn-hongkong.aliyuncs.com
Singapore (Singapore) ap-southeast-1
  • Public endpoint: metrics.ap-southeast-1.aliyuncs.com
  • VPC endpoint: metrics-vpc.ap-southeast-1.aliyuncs.com
Australia (Sydney) ap-southeast-2
  • Public endpoint: metrics.ap-southeast-2.aliyuncs.com
  • VPC endpoint: metrics-vpc.ap-southeast-2.aliyuncs.com
Malaysia (Kuala Lumpur) ap-southeast-3
  • Public endpoint: metrics.ap-southeast-3.aliyuncs.com
  • VPC endpoint: metrics-vpc.ap-southeast-3.aliyuncs.com
Indonesia (Jakarta) ap-southeast-5
  • Public endpoint: metrics.ap-southeast-5.aliyuncs.com
  • VPC endpoint: metrics-vpc.ap-southeast-5.aliyuncs.com
Japan (Tokyo) ap-northeast-1
  • Public endpoint: metrics.ap-northeast-1.aliyuncs.com
  • VPC endpoint: metrics-vpc.ap-northeast-1.aliyuncs.com
US (Silicon Valley) us-west-1
  • Public endpoint: metrics.us-west-1.aliyuncs.com
  • VPC endpoint: metrics-vpc.us-west-1.aliyuncs.com
US (Virginia) us-east-1
  • Public endpoint: metrics.us-east-1.aliyuncs.com
  • VPC endpoint: metrics-vpc.us-east-1.aliyuncs.com
Germany (Frankfurt) eu-central-1
  • Public endpoint: metrics.eu-central-1.aliyuncs.com
  • VPC endpoint: metrics-vpc.eu-central-1.aliyuncs.com
UK (London) eu-west-1
  • Public endpoint: metrics.eu-west-1.aliyuncs.com
  • VPC endpoint: metrics-vpc.eu-west-1.aliyuncs.com
India (Mumbai) ap-south-1
  • Public endpoint: metrics.ap-south-1.aliyuncs.com
  • VPC endpoint: metrics-vpc.ap-south-1.aliyuncs.com
UAE (Dubai) me-east-1
  • Public endpoint: metrics.me-east-1.aliyuncs.com
  • VPC endpoint: metrics-vpc.me-east-1.aliyuncs.com
China North 2 Ali Gov 1 cn-wulanchabu
  • Public endpoint: metrics.cn-north-2-gov-1.aliyuncs.com
  • VPC: metrics-vpc.cn-north-2-gov-1.aliyuncs.com

Sample request

The following sample request is used to call the DescribeMetricList operation to query the monitoring data of a metric of a specified cloud service.
Note The sample request is formatted to improve readability.
https://metrics.cn-hangzhou.aliyuncs.com/?Action=DescribeMetricList
&Format=xml
&Version=2019-01-01
&Signature=LbCj99dCxXdE9amsCivm0U4yT****
&SignatureMethod=HMAC-SHA1
&SignatureNonce=87d98ae51f0793f2c8638d3a9bdd****
&SignatureVersion=1.0
&AccessKeyId=LTAI4G4jDmmbPAG9CXfH****
&TimeStamp=2021-05-06T12:00:00Z
...