返回结果

您可以阅读本文,了解API的返回结果。

返回结果说明

返回结果主要有XML和JSON两种格式,默认使用XML,您可以指定公共请求参数 Format 变更返回结果的格式。

为了便于查看,API文档返回示例均有换行和缩进等处理,实际返回结果无换行和缩进处理。

正常返回示例

  • XML示例

    <?xml version="1.0" encoding="UTF-8" ?>
    <!--结果的根结点-->
    <接口名称+ Response>
        <!--返回请求标签-->
        <RequestId>25818875-5F78-4A13-BEF6-D7393642CA58</RequestId>
        <!--返回结果数据-->
    </接口名称+Response>
                                    
  • JSON示例

    {
        "RequestId": "4C467B38-3910-447D-87BC-AC049166F216", /* 返回结果数据 */
    }
                                    

异常返回示例

接口调用出错后,会返回错误码、错误信息和请求 ID,我们称这样的返回为异常返回。HTTP 状态码为 4xx 或者 5xx。 您可以根据接口错误码以及附录中的错误码表排查错误。当您无法排查错误时,请提交工单,联系阿里云客服并提供服务节点HostId和RequestId,我们会尽快为您解答。

  • XML示例

    <?xml version="1.0" encoding="UTF-8"?> 
    <Error>
                    <RequestId>8906582E-6722-409A-A6C4-0E7863B733A5</RequestId> 
                    <HostId>vod.cn-shanghai.aliyuncs.com</HostId> 
                    <Code>UnsupportedOperation</Code>
                    <Message>The specified action is not supported.</Message>
            </Error>
                                            
  • JSON示例

            {
                    "RequestId": "8906582E-6722-409A-A6C4-0E7863B733A5", 
                    "HostId": "vod.cn-shanghai.aliyuncs.com",
                    "Code": "UnsupportedOperation",
                    "Message": "The specified action is not supported."
            }