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&ParametersThe 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 |
|
| China (Shanghai) | cn-shanghai |
|
| China (Shenzhen) | cn-shenzhen |
|
| China (Qingdao) | cn-qingdao |
|
| China (Beijing) | cn-beijing |
|
| China (Zhangjiakou) | cn-zhangjiakou |
|
| China (Hohhot) | cn-huhehaote |
|
| China (Ulanqab) | cn-wulanchabu |
|
| China (Heyuan) | cn-heyuan |
|
| China (Chengdu) | cn-chengdu |
|
| China (Guangzhou) | cn-guangzhou |
|
| China (Hong Kong) | cn-hongkong |
|
| Singapore (Singapore) | ap-southeast-1 |
|
| Australia (Sydney) | ap-southeast-2 |
|
| Malaysia (Kuala Lumpur) | ap-southeast-3 |
|
| Indonesia (Jakarta) | ap-southeast-5 |
|
| Japan (Tokyo) | ap-northeast-1 |
|
| US (Silicon Valley) | us-west-1 |
|
| US (Virginia) | us-east-1 |
|
| Germany (Frankfurt) | eu-central-1 |
|
| UK (London) | eu-west-1 |
|
| India (Mumbai) | ap-south-1 |
|
| UAE (Dubai) | me-east-1 |
|
| China North 2 Ali Gov 1 | cn-wulanchabu |
|
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
...