All Products
Search
Document Center

Common parameters

Last Updated: Feb 28, 2019

Common parameters are required for all API requests, which consist of common request parameters and common response parameters.

Common request parameters

Name Type Required Description
Format String No The type of the response. Valid values: JSON and XML. Default value: XML.
Version String Yes The API version, with a date format of YYYY-MM-DD. The current version is 2015-01-09.
Signature String Yes The signature result string. For more information about signature calculation methods, see Sign signatures.
SignatureMethod String Yes The signature method. HMAC-SHA1 is supported.
SignatureNonce String Yes A unique random number. This parameter is used to prevent replay attacks. You must use different random numbers for different requests.
SignatureVersion String Yes The signature algorithm version. The current version is 1.0.
AccessKeyId String Yes The AccessKeyId that Alibaba Cloud issues to you for service access.
Timestamp String Yes The timestamp of a request.

The date format follows the ISO8601 standard and UTC time is used.

The format is YYYY-MM-DDThh:mm:ssZ, for example, 2015-01-09T12:00:00Z (for 12:00:00 on January 9, 2015, UTC time).

Common response parameters

The system returns a GUID (RequestId) for each API request, regardless of whether the API operation is called successfully.

Sample requests

  1. https://openanalytics.cn-hangzhou.aliyuncs.com/?Format=xml
  2. &Version=2018-06-19
  3. &Signature=HaiKP8dBpEqhzeutgqOrHDpvxWw%3D
  4. &SignatureMethod=HMAC-SHA1
  5. &SignatureNonce=6d4b46a912d4b6d36809a04d216972a0
  6. &SignatureVersion=1.0
  7. &AccessKeyId=key-test
  8. &Timestamp=2018-11-10T06%3A31%3A08Z

Sample responses

XML format

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!—The root node of the result-->
  3. <Operation name+Response>
  4. <!—The returned request tag-->
  5. <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
  6. <!—The response data-->
  7. </Operation name+Response>

JSON format

  1. {
  2. "RequestId": "4C467B38-3910-447D-87BC-AC049166F216"
  3. /* The response data */
  4. }