Response results

Last Updated: Apr 13, 2018

We return the results in either XML or JSON format, but JSON is the default choice. You can switch to XML schema by specifying the request parameter Format. For more information, see Common parameters.

Note: Response examples in our API documents have line breaks and indentions to make them easy to read. The actual response results are not formatted.

Success response example

Every successful response has a request ID in the RequestId element and other API-specific response parameters. The HTTP status code for a success response is 2XX.

XML format

  1. <?xml version="1.0" encoding="UTF-8"?> <!--Result root node-->
  2. <ActionResponse> <!--Response request tag-->
  3. <RequestId>4C467B38-3910-447D-87BC-AC049166F223</RequestId> <!--Response result data-->
  4. </ActionResponse>

JSON format

  1. {
  2. "RequestId": "4C467B38-3910-447D-87BC-AC049166F223" /* Response result data */
  3. }

Error response example

Every error response consists of a request ID in the RequestId element and access endpoint in the HostId element, the error code, and the error message. The HTTP status code for an error response is 4xx or 5xx.

You can fix the exception according to the API-specific error codes or common error codes and try the request again.Alternatively, you can open a ticket and provide additional inputs such as the HostId and RequestId to get technical support from us.

XML format

  1. <?xml version="1.0" encoding="UTF-8"?> <!--Result root node-->
  2. <Error>
  3. <RequestId>540CFF28-407A-40B5-B6A5-74Bxxxxxxxxx</RequestId> <!--Request ID-->
  4. <HostId></HostId> <!--Endpoint-->
  5. <Code>ServiceUnavailable </Code> <!--Error code-->
  6. <Message>The request has failed due to a temporary failure of the server.</Message> <!--Error message-->
  7. </Error>

JSON format

  1. {
  2. "RequestId": "540CFF28-407A-40B5-B6A5-74Bxxxxxxxxx", /* Request ID */
  3. "HostId": "", /* Endpoint */
  4. "Code": "ServiceUnavailable", /* Error code */
  5. "Message": "The request has failed due to a temporary failure of the server." /* Error message */
  6. }

Common error codes

Error code Error message HTTP status code Meaning
InvalidAccessKeyId.NotFound The Access Key ID provided does not exist in our records. 400 The specified AccessKey does not exist.
InvalidParameter The specified value of parameter <parameter name> is not valid. 400 The specified parameter is invalid.
MissingParameter The input parameter <parameter name> that is mandatory for processing this request is not supplied 400 You must specify the required parameters.
NoSuchVersion The specified version does not exist. 400 The specified API version does not exist.
ResourceNotAvailable Resource you requested is not available in this region or zone. 400 ESS service is unavailable in the specified region.
Throttling Request was denied due to request throttling. 400 You have made too many frequent requests in short time. Please try again later.
UnsupportedOperation The specified action is not supported. 400 Unable to call the specified API.
Forbidden Users are not authorized to operate on the specified resource. 403 You cannot perform the specified action.
Forbidden.RiskControl This operation is forbidden by Aliyun Risk Control system. 403 The specified action is under risk control.
Forbidden.Unsubscribed Do not have permission to access this API. 403 You must enable the ESS service before calling this API.
SignatureDoesNotMatch The signature we calculated does not match the one you provided. 403 The signature calculated by us is different from the one you provide.
InternalError The request processing has failed due to some unknown error, exception or failure. 500 Internal error.
ServiceUnavailable The request has failed due to a temporary failure of the server. 503 The server cannot respond to your request. Please try again later.
Thank you! We've received your feedback.