Call an API

Updated at:

To call a CloudESL API, send an HTTP GET request to its server-side endpoint. Include the required parameters in the request as specified in the API reference. After a call is made, the system returns a response. Both requests and responses are encoded in the UTF-8 character set.

Request structure

CloudESL APIs are RPC-style. To call an API, send an HTTP GET request.

The request structure is as follows:
http://Endpoint/?Action=xx&Parameters
Where:
  • Endpoint: The service endpoint for the CloudESL API is cloudesl.cn-hangzhou.aliyuncs.com.
  • Action: The operation to execute. For example, call DescribeStores to query the list of created CloudESL outlets.
  • Version: The API version to use. The API version for CloudESL is 2020-02-01.
  • Parameters: Request parameters. Separate each parameter with an ampersand (&).

    Request parameters consist of common parameters and API-specific parameters. Common parameters include information such as the API version and identity verification. For more information, see Common parameters.

This example shows how to call the DescribeStores API:
Note The examples in this document are formatted for readability.
https://cloudesl.cn-hangzhou.aliyuncs.com/?Action=DescribeStores
&Format=json
&Version=2020-02-01
&Signature=xxxx%xxxx%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=key-test
&TimeStamp=2012-06-01T12:00:00Z
…