Request structure

CloudMonitor APIs belong to the RPC type. You can call CloudMonitor  APIs by sending HTTP requests.

The request structure is as follows:

http://endpoint/?Action=xx&parameters

In this syntax,

  • Endpoint is the cloud service node that is called. The access node is metrics.aliyuncs.com. For the endpoint of each region, see Endpoint.

  • Action is an action to perform, such as querying the monitoring data for an instance using QueryMetricList.

  • Version is the version of the API, and the current version is 2017-03-01.

  • Parameters are the request parameters seperated by &

    Request parameters consist of common parameters and API specific parameters. Common parameters include the API version number, authentication information, and other information.

The following example shows how to call  QueryMetricList to query the monitoring data of an instance.

http://metrics.cn-hangzhou.aliyuncs.com/?Action=QueryMetricList
&EndTime=2017-05-17+11%3A30%3A27
&StartTime=2017-05-17+11%3A20%3A27
&Period=60
&Dimensions=%7B%22instanceId%22%3A%22i-abcdefgh123456%22%7D
&Timestamp=2017-03-22T09%3A30%3A57Z
&Project=acs_ecs_dashboard
&Metric=cpu_idle

Endpoint

Region Service address
East China 1 (Hangzhou) metrics.cn-hangzhou.aliyuncs.com
China East 2 (Shanghai) metrics.cn-shanghai.aliyuncs.com
North China 1 (Qingdao) metrics.cn-qingdao.aliyuncs.com
China North 2 (Beijing) metrics.cn-beijing.aliyuncs.com
China South 1 (Shenzhen) metrics.cn-shenzhen.aliyuncs.com
China North 3 (Zhangjiakou) metrics.cn-zhangjiakou.aliyuncs.com
China (Hong Kong) metrics.cn-hongkong.aliyuncs.com
Singapore metrics.ap-southeast-1.aliyuncs.com
US (Silicon Valley) metrics.us-west-1.aliyuncs.com
US (Virginia) metrics.us-east-1.aliyuncs.com
Central Europe 1 (Frankfurt) metrics.eu-central-1.aliyuncs.com
Australia (Sydney) metrics.ap-southeast-2.aliyuncs.com
Middle East 1 (Dubai) metrics.me-east-1.aliyuncs.com
Asia Pacific NE 1 (Tokyo) metrics.cn-hangzhou.aliyuncs.com
Malaysia (Kuala Lumpur) metrics.ap-southeast-3.aliyuncs.com
China (Hohhot) metrics.cn-huhehaote.aliyuncs.com
Asia Pacific SE 5 (Jakarta) metrics.ap-southeast-5.aliyuncs.com
Note When you call the APIs at Asia Pacific NE 1 (Japan), the actual API server in service is East China 1 (Hangzhou).

API authorization

For the security of your account, we recommend that you use a RAM user to call APIs. Before using a RAM user to call an API, you must grant the RAM user the corresponding permission to call the API by creating an authorization policy and attaching the policy to the RAM user.

API signature

To ensure secure calls to the API, when the API is invoked, Ali cloud authenticates each API request through the signature. When you manually launch an API request, follow the definition of RFC 2104, use AccessSecret to evaluate the HMAC values as signatures for the encoded, sorted entire request string. For more information, seeRPC API signature.

When calling RPC API, you need to add the signature to your request using the following format:

https://endpoint/?SignatureVersion=1.0&SignatureMethod=HMAC-SHA1&Signature=CT9X0VtwR86fNWSnsc6v8YGOjuE%3D&SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf

Take  QueryMetricList as an example, assume that the Accesskey ID is testid, AccessKey Secret is testsecret, The request URL before signature:
http://metrics.aliyuncs.com/?Action=QueryMetricList&period=60&StartTime=2016-03-22T11:30:27Z&Dimensions={instanceId:'i-abcdefgh123456'}&Timestamp=2017-03-23T06:59:55Z&Project=acs_ecs_dashboard&SignatureVersion=1.0&Format=JSON&SignatureNonce=aeb03861-611f-43c6-9c07-b752fad3dc06&Version=2015-10-20&AccessKeyId=TestId&Metric=cpu_idle&SignatureMethod=HMAC-SHA1
The StringToSign:
GET&%2F&AccessKeyId%3DTestId&Action%3DQueryMetricList&Dimensions%3D%257B%2522instanceId%2522%253A%2522i-abcdefgh123456%2522%257D&Format%3DJSON&Metric%3Dcpu_idle&Period%3D60&Project%3Dacs_ecs_dashboard&SignatureMethod%3DHMAC-SHA1&SignatureNonce%3Daeb03861-611f-43c6-9c07-b752fad3dc06&SignatureVersion%3D1.0&StartTime%3D2016-03-22T11%253A30%253A27Z&Timestamp%3D2017-03-23T06%253A59%253A55Z&Version%3D2015-10-20
Because AccessKey Secret is testsecret, and the key used for HMAC calculation is testsecret&, the signature value is
TLj49H/wqBWGJ7RK0r84SN5IDfM=

Add signature to URL request as a Signature parameter to get the final URL:

http://metrics.cn-hangzhou.aliyuncs.com/?Action=QueryMetricList&StartTime=2016-03-22T11%3A30%3A27Z&Period=60&Dimensions=%7B%22instanceId%22%3A%22i-abcdefgh123456%22%7D&Timestamp=2017-03-23T06%3A59%3A55Z&Project=acs_ecs_dashboard&SignatureVersion=1.0&Format=JSON&SignatureNonce=aeb03861-611f-43c6-9c07-b752fad3dc06&Version=2015-10-20&AccessKeyId=TestId&Metric=cpu_idle&SignatureMethod=HMAC-SHA1&Signature=TLj49H%2FwqBWGJ7RK0r84SN5IDfM%3D