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. This topic provides sample responses that will be returned when a call succeeded or failed.

API responses use the HTTP response format where a 2xx status code indicates a successful call and a 4xx or 5xx status code indicates a failed call.
Note The sample responses in this topic have been formatted for ease of viewing. The actual responses do not include any line breaks or indentations.

Sample success responses

  • XML format
    <? xml version="1.0" encoding="UTF-8"? > 
    <!-The root node of the result-->
    <API name+Response>
        <!-The returned request tag-->
        <!-Response data-->
    </API name+Response>
  • JSON format
        "RequestId": "4C467B38-3910-447D-87BC-AC049166F216"
        /* Response data */

Sample error responses

If an error occurs during an API call, the system will not return any response. You can troubleshoot the error based on the error code returned and common error codes.

If an error occurs during a call, HTTP status code 4xx or 5xx is returned. The body of the returned message includes the specific error code and error message. The body of the returned message also contains the RequestId and HostId parameters. The RequestId parameter indicates the globally unique identifier (GUID) of the request, and the HostId parameter indicates the ID of the site that you accessed with the request.

You can contact Alibaba Cloud Customers Services when you cannot find the cause of the error. We recommend that you provide the HostId and RequestId for us to help you resolve the issue promptly.

  • XML format
    <? xml version="1.0" encoding="UTF-8"? >
        <Message>The domain name does not exist. </Message>
  • JSON format
        "RequestId": "8906582E-6722-409A-A6C4-0E7863B733A5",
        "HostId": "",
        "Code": "DomainNotExist",
        "Message": "The domain name does not exist."