Returned Results

Last Updated: May 27, 2016

After the API service is called, the returned data adopts a uniform format. A returned HTTP status code of 2xx indicates that the call is successful. A returned HTTP status code of 4xx or 5xx indicates that the call failed. For successful calls, the returned data are primarily available in XML and JSON. When a request is sent, an external system can pass in parameters to define the format of returned data, XML by default. In this document, examples of returned results are formatted in a way that is easier for users to view. The actual returned results are free of line breaks, indentation, etc.

Successful Results

XML Example

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

JSON Example

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

Error Results

When an error occurs in an interface call, no result data will be returned. The caller can determine the causes of errors based on the error codes for each interface and Public Error Codes.

When an error occurs in a call, an HTTP status code of 4xx or 5xx will be returned for the HTTP request. The returned message body contains the specific error code and error message. It also contains a globally unique request ID: RequestId and the ID of the site you accessed with this request: HostId. If the caller cannot find the cause of the error, he can contact Alibaba Cloud customer service and provide the HostId and RequestId to help us solve the problem as quickly as possible.

XML Example

<?xml version="1.0" encoding="UTF-8"?>
<Error>
   <RequestId>8906582E-6722-409A-A6C4-0E7863B733A5</RequestId>
   <HostId>dns.aliyuncs.com</HostId>
   <Code>DomainNotExist</Code>
   <Message>The domain name does not exist.</Message>
</Error>

JSON Example

{
    "RequestId": "8906582E-6722-409A-A6C4-0E7863B733A5",
    "HostId": "dns.aliyuncs.com",
    "Code": "DomainNotExist",
    "Message": "The domain name does not exist."
}
Thank you! We've received your feedback.