This topic describes the responses returned after API operations are called.

Responses can be returned in either the JSON or XML format. The default response format is JSON. You can specify the Format common parameter in the request to change the format of responses. For more information, see Common parameters.

Note Sample responses provided in API Reference are formatted with line breaks and indentations for better readability and clarity. However, the actual responses are not formatted with line breaks or indentations.

Sample success responses

Every response returns a unique RequestID regardless of whether the call is successful. API responses use the HTTP response format where a 2xx status code indicates a successful call.

XML format 

<?xml version="1.0" encoding="UTF-8"? > <!--The root node of the response-->
<ActionResponse> <!--Returned request ID-->
    <RequestId>4C467B38-3910-447D-87BC-AC049166F223</RequestId> <!--Response data-->
</ActionResponse>

JSON format 

{
    "RequestId": "4C467B38-3910-447D-87BC-AC049166F223" /* Response data */
}

Sample error responses

If an error occurs when you call an operation, an error response that consists of the error code, error message, and request ID is returned. API responses use the HTTP response format where a 4xx or 5xx status code indicates a failed call.

You can troubleshoot an error based on the error code returned and common error codes. If the error persists, you can submit a ticket and provide the HostId and RequestId values to obtain technical support from Alibaba Cloud.

XML format 

<?xml version="1.0" encoding="UTF-8"? ><!--The root node of the response-->
<Error>
    <RequestId>540CFF28-407A-40B5-B6A5-74Bxxxxxxxxx</RequestId> <!--Request ID-->
    <HostId>ess.aliyuncs.com</HostId> <!--Service endpoint-->
    <Code>InternalError</Code> <!--Error code-->
    <Message>The request processing has failed due to some unknown error, exception or failure. </Message> <!--Error message-->
</Error>

JSON format 

{
    "RequestId": "540CFF28-407A-40B5-B6A5-74Bxxxxxxxxx", /* Request ID */
    "HostId": "ess.aliyuncs.com", /* Service endpoint */
    "Code": "InternalError", /* Error code */
    "Message": "The request processing has failed due to some unknown error, exception or failure." /* Error message */
}

Common error codes

HTTP status code Error code Error message Description
400 InvalidAccessKeyId.NotFound The Access Key ID provided does not exist in our records. The error message returned because the specified AccessKeyId parameter does not exist.
400 InvalidParameter The specified value of parameter <parameter name> is not valid. The error message returned because the specified value of the parameter is invalid.
400 MissingParameter The input parameter <parameter name> that is mandatory for processing this request is not supplied. The error message returned because the required parameter is not specified.
400 NoSuchVersion The specified version does not exist. The error message returned because the specified version does not exist.
400 ResourceNotAvailable Resource you requested is not available in this region or zone. The error message returned because the ESS service is not available in the specified region.
400 Throttling Request was denied due to request throttling. The error message returned because the system is under throttling condition. Try again later.
400 UnsupportedOperation The specified action is not supported. The error message returned because the specified operation is not supported.
403 Forbidden Users are not authorized to operate on the specified resource. The error message returned because you are not authorized to perform the specified operation.
403 Forbidden.RiskControl This operation is forbidden by Aliyun Risk Control system. The error message returned because the specified operation is not allowed.
403 Forbidden.Unsubscribed Do not have permission to access this API. The error message returned because you have not activated the ESS service to call the specified API operation.
403 Forbidden.UserVerification Your user account is not verified by Aliyun. The error message returned because you have not completed real-name verification.
403 SignatureDoesNotMatch The signature we calculated does not match the one you provided. The error message returned because the calculated signature is different from the one provided by you.
500 InternalError The request processing has failed due to some unknown error, exception or failure. The error message returned because a system error occurred.
503 ServiceUnavailable The request has failed due to a temporary failure of the server. The error message returned because the server cannot respond to your request. Try again later.