Common request parameters

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


Name Type Required Description
Format String Yes The return value can be either JSON or XML. Default value: XML.
Version String Yes The API version, in the format of YYYY-MM-DD. The current version is 2015-12-01.
AccessKeyId String Yes The accesskey ID provided to you by Alibaba Cloud.
Signature String Yes The signature string in the API request.
SignatureMethod String Yes The encryption method of the signature string. Set the value to HMAC-SHA1.
Timestamp String Yes
  • The timestamp of the request. The date format follows the ISO8601 standard and UTC time is required.
  • The format is YYYY-MM-DDThh:mm:ssZ. For example, 2016-01-01T12:00:00Z.
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 numbers for different requests.

Sample requests

? Format=json

Common response parameters

When you call an operation, the system returns the globally unique identifier (GUID) of the request through the RequestId parameter, regardless of whether the request is successful.

Sample success responses

<? xml version="1.0" encoding="utf-8"? > 
<!--Result Root Node-->
<Interface Name+Response>
<!--The returned request tag-->
<!--The returned result-->
</Interface Name+Response>


API responses use the following format:
  • If the returned HTTP status code is 2xx, the call is successful.
  • An HTTP status code of 4xx or 5xx indicates that the API operation has not been successfully called.
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.
Note Sample responses in this document are formatted for ease of reading. Actual responses are not formatted with line breaks or indentation.

Success results returned

XML format

The response includes information such as whether the request is successful and the specific service data. The following is an example:

<? xml version="1.0" encoding="utf-8"? > 
<!--Result Root Node-->
<Interface Name+Response>
<!--The returned request tag-->
<!--The returned result-->
</Operation Name+Response>

JSON format

"RequestId": "4C4fdsf38-3910-447D-87AD-AC078932216",
/*The returned result*/

Return error results

If an error occurs when you call an operation, no result data is returned. The caller can error code table to locate the cause of the error. If an error occurs during a call, an HTTP status code 4xx or 5xx is returned. The response body contains the error code, the error message, a globally unique request ID (RequestId), and the ID of the site you accessed with this request (HostId).

If you cannot locate the cause of the error, contact Alibaba Cloud customer service and provide them with HostId and RequestId to help solve the problem.

XML format

<? xml version="1.0" encoding="UTF-8"? >
<Message>The specified action is not supported. </Message>

JSON format

"RequestId": "7463B73D-35CC-4D19-A010-6B8D65D242EF",
"HostId": "",
"Code": "UnsupportedOperation",
"Message": "The specified action is not supported."