Common parameters are required in all Database Autonomy Service (DAS) API requests. Common parameters include common request parameters and common response parameters.

Common request parameters

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

Parameter Type Required Description
Format String No The format in which the response is returned. Valid values: JSON and XML. Default value: XML.
Version String Yes The version number of the API in the YYYY-MM-DD format. Set the value to 2021-01-16.
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.
SignatureMethod string Yes The encryption method of the signature string. Set the value to HMAC-SHA1.
Timestamp String Yes The timestamp of the request. Specify the time in the ISO 8601 standard format: yyyy-MM-ddTHH:mm:ssZ. The time must be in UTC. For example, a value of 2013-08-15T12:00:00Z indicates 20:00:00 on August 15, 2013, UTC+8.
SignatureVersion String Yes The version of the signature encryption algorithm. Set the value to 1.0.
SignatureNonce String Yes A unique, random number that is used to prevent replay attacks. You must use different numbers for different requests.

Common response parameters

Every response returns a unique request ID regardless of whether the call is successful.

Sample requests

Sample responses

API responses use the HTTP response format where a 2xx HTTP status code indicates a successful call and a 4xx or 5xx HTTP status code indicates a failed call. 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. In this topic, the sample responses are formatted for ease of reading. The actual responses do not include line breaks or indentations.

Sample success responses

XML format

<?xml version="1.0" encoding="utf-8"?> 
<API operation name+Response>
    <!--Returned request ID-->
    <!--Returned data-->
</API operation name+Response>

JSON format

    "RequestId": "4C467B38-3910-447D-87BC-AC049166F216",
    /* Returned data */

Sample error responses

If an error occurs, the system does not return result data. You can identify the cause of the error based on the error code. For more information, see Client error codes.

If the system returns a 4xx or 5xx HTTP status code, the request failed. The response body contains the specific error code and error message. The response body also contains the globally unique ID of the request (RequestId) and the ID of the requested host (HostId). If you cannot identify the cause of an error, you can contact Alibaba Cloud technical support and provide the returned values of the HostId and RequestId parameters. Alibaba Cloud technical support can help you troubleshoot the error.

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."