Response structure

After you make an API request, an HTTP status code is returned. 2xx indicates that the request has succeeded; 4xx or 5xx indicates that an error occurred while processing the request. You can identify the cause of the error by using the HTTP status code and its description. If the problem cannot be solved, you can contact our support team, and provide the RequestId and the HostId which are included in the response of an unsuccessful request, to help us quickly find the resolution.

The response text is JSON formatted. If you make the API request by using tools that are not provided by Alibaba Cloud, you can customize the response format in the request parameters.

In the example responses we present as follows, we use line breaks to separate the original whole line of text for readability.

Successful response example

XML format

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

JSON format

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

Unsuccessful response example

XML format

<KMS>
<HttpStatus>400</HttpStatus>
<Code>IllegalTimestamp</Code>
<Message>The input parameter "Timestamp" that is mandatory for processing this request is not supplied.</Message>
<RequestId>3b237773-bc2c-4bea-95fc-319a1a5baa68</RequestId>
 </KMS>

JSON format

{
"HttpStatus": 400
"Code": "IllegalTimestamp"
"Message": "The input parameter "Timestamp" that is mandatory for processing this request is not supplied."
"RequestId": "e85db688-a2d3-44ca-9790-4259f59e90d8"
}

Common error codes