All Products
Search
Document Center

Common parameters

Last Updated: Sep 15, 2020

Common request parameters

Common request parameters must be included in all GTM API requests.

Parameter

Type

Required

Description

Format

String

No

The format to return the response. Valid values: JSON and XML. Default value: XML.

Version

String

Yes

The version number of the API. The value is in the YYYY-MM-DD format. Set the value to 2015-01-09.

AccessKeyId

String

Yes

The AccessKey ID provided to you by Alibaba Cloud.

Signature

String

Yes

The signature string of the current request. For more information about how signatures are calculated, see Signature method.

SignatureMethod

String

Yes

The signature method. Set the value to HMAC-SHA1.

Timestamp

String

Yes

The timestamp of the request. Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format, for example, 2015-01-09T12:00:00Z. The time must be in UTC.

SignatureVersion

String

Yes

The version of the signature algorithm. Set the value to 1.0.

SignatureNonce

String

Yes

A unique random number used to prevent replay attacks. You must use different random numbers for different requests.

Examples:

https://alidns.aliyuncs.com/
? Format=xml
&Version=2015-01-09
&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D 
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=key-test
&Timestamp=2015-01-09T12:00:00Z
...

Common response parameters

The system returns a unique RequestID for each API request, regardless of whether the call is successful.

Sample responses

  • XML format

<? xml version="1.0" encoding="UTF-8"? > 
<!—Result Root Node-->
<Interface Name+Response>
    <!—Return Request Tag-->
    <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
    <!—Return Result Data-->
</Interface Name+Response>
  • JSON format

{
    "RequestId": "4C467B38-3910-447D-87BC-AC049166F216"
    /* Return Result Data */
}