Common parameters

Updated at:

Common request parameters

Common request parameters are parameters required for every API call.

Name

Type

Required

Description

Format

String

No

The format of the return value. JSON and XML are supported. The default value is XML.

Version

String

Yes

The API version. The version is in the YYYY-MM-DD date format. The current version is 2016-02-01.

AccessKeyId

String

Yes

The AccessKey ID issued by Alibaba Cloud for service access.

Signature

String

Yes

The signature string. For more information about how to calculate a signature, see Signature mechanism.

SignatureMethod

String

Yes

The signature method. HMAC-SHA1 is supported.

Timestamp

String

Yes

The timestamp of the request. The timestamp must be in UTC and follow the ISO 8601 standard. The format is YYYY-MM-DDThh:mm:ssZ. For example, 2016-02-25T12:00:00Z represents 12:00:00 on February 25, 2016 (UTC).

SignatureVersion

String

Yes

The version of the signature algorithm. The current version is 1.0.

SignatureNonce

String

Yes

A unique random number used to prevent replay attacks. Use a different random number for each request.

Example

https://httpdns-api.aliyuncs.com/
?Format=XML
&Version=2016-02-01
&AccessKeyId=testid
&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&Timestamp=2016-02-25T12:00:00Z
&<API-specific parameters>
…

Common return parameters

For every API call, the system returns a unique identifier, RequestId, regardless of whether the call is successful.

XML example

<?xml version="1.0" encoding="UTF-8"?>
<!--The root node of the result-->
<APIName+Response>
    <!--The request ID tag-->
    <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
    <!--The returned result data-->
</APIName+Response>

JSON example

{
    "RequestId": "4C467B38-3910-447D-87BC-AC049166F216"
    /* The returned result data */
}