返回结果主要有JSON和XML两种格式,默认为JSON,您可以指定公共请求参数Format变更返回结果的格式。本文中的示例为了便于您查看,做了格式化处理,实际返回结果可能未进行换行、缩进等处理。

正常返回示例

接口调用成功后会返回接口参数和请求ID,此类返回为正常返回。HTTP状态码为2xx。

  • JSON示例
    {
        "TotalCount":25,
        "RequestId":"A66FCCB9-4538-193F-A67A-2E0A515A****",
        "PageSize":10,
        "PageNumber":1,
        "Regions":{
            "Region":[
                {
                    "RegionId":"cn-hangzhou",
                    "RegionEndpoint":"nas.cn-hangzhou.aliyuncs.com",
                    "LocalName":"China (Hangzhou)"
                },
                {
                    "RegionId":"cn-shanghai",
                    "RegionEndpoint":"nas.cn-shanghai.aliyuncs.com",
                    "LocalName":"China (Shanghai)"
                }
            ]
        }
    }
  • XML示例
    <?xml version="1.0" encoding="UTF-8"?>
    <root>
      <TotalCount>25</TotalCount>
      <RequestId>A66FCCB9-4538-193F-A67A-2E0A515A****</RequestId>
      <PageSize>10</PageSize>
      <PageNumber>1</PageNumber>
      <Regions>
        <Region>
          <RegionId>cn-hangzhou</RegionId>
          <RegionEndpoint>nas.cn-hangzhou.aliyuncs.com</RegionEndpoint>
          <LocalName>China (Hangzhou)</LocalName>
        </Region>
        <Region>
          <RegionId>cn-shanghai</RegionId>
          <RegionEndpoint>nas.cn-shanghai.aliyuncs.com</RegionEndpoint>
          <LocalName>China (Shanghai)</LocalName>
        </Region>
      </Regions>
    </root>

异常返回示例

接口调用出错后,会返回错误码、错误信息和请求ID,此类返回为异常返回。HTTP状态码为4xx或者5xx。

您可以根据接口错误码来定位错误原因。更多信息,请参见错误码API错误中心

当无法排查错误时,您可以提交工单联系我们,并在工单中注明该次请求访问的服务节点HostId和请求IDRequestId

  • JSON示例
    {
      "RequestId": "98B65159-F38F-5F9E-AE07-4988FFC4****",/* 请求ID */
      "HostId": "nas.cn-hangzhou.aliyuncs.com",/* 服务节点 */
      "Code": "IllegalCharacters",/* 错误码 */
      "Message": "Parameter contains illegal characters.",/* 错误信息 */
      "Recommend": "https://error-center.aliyun.com/status/search?Keyword=IllegalCharacters&source=PopGw"/* 错误中心地址 *
    }
  • XML示例
    <?xml version="1.0" encoding="UTF-8"?><!--结果的根结点-->
    <Error>
        <RequestId>98B65159-F38F-5F9E-AE07-4988FFC4****</RequestId> <!--请求ID-->
        <HostId>nas.cn-hangzhou.aliyuncs.com</HostId> <!--服务节点-->
        <Code>IllegalCharacters</Code> <!--错误码-->
        <Message>Parameter contains illegal characters.</Message> <!--错误信息-->
        <Recommend>https://error-center.aliyun.com/status/search?Keyword=IllegalCharacters&source=PopGw</Recommend><!--错误中心地址-->
    </Error>