This topic describes the request and response parameters that are required for all Alibaba Cloud DNS API operations.

Common request parameters

Common request parameters must be included in all Alibaba Cloud DNS API requests.

Table 1. Common request parameters
ParameterTypeRequiredDescription
FormatStringNoThe format in which to return the response. Valid values: JSON and XML. Default value: XML.
VersionStringYesThe version number of the API. The value is in the YYYY-MM-DD format. Set the value to 2015-01-09.
AccessKeyIdStringYesThe AccessKey ID provided to you by Alibaba Cloud.
SignatureStringYesThe signature string of the current request.
SignatureMethodStringYesThe encryption method of the signature string. Set the value to HMAC-SHA1.
TimestampStringYesThe 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.
SignatureVersionStringYesThe version of the signature encryption algorithm. Set the value to 1.0.
SignatureNonceStringYesA unique, random number used to prevent replay attacks. You must use different numbers for different requests.
Examples 
https://alidns.aliyuncs.com/?Action=xxx
&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

Responses can be returned in either the JSON or XML format. You can specify the response format in the request. The default response format is XML. Every response returns a unique RequestID regardless of whether the call succeeds.
  • An HTTP status code of 2xx indicates that the call succeeds.
  • An HTTP status code of 4xx or 5xx indicates that the call failed.
The following are sample responses:
  • XML format 
    <? xml version="1.0" encoding="utf-8"? > 
    <!--Result root node-->
    <API name+Response>
        <!--Returned request tag-->
        <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
        <!--Response result data-->
    </API name+Response>
  • JSON format 
    {
    "RequestId":"4C467B38-3910-447D-87BC-AC049166F216",
    /*Response result data*/
    }