返回结果主要有 XML 和 JSON 两种格式,默认为 XML,您可以指定公共请求参数 Format 变更返回结果的格式。更多详情,请参阅 公共参数。为了便于查看和美观,API 文档返回示例均有换行和缩进等处理,实际返回结果无换行和缩进处理。

正常返回示例

接口调用成功后会返回接口返回参数和请求 ID,我们称这样的返回为正常返回。HTTP 状态码为 2xx。

  • XML 示例
    1. <?xml version=”1.0 encoding=”UTF-8”?><!—结果的根结点—>
      <ActionResponse> <!—返回请求标签—>
      <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId> <!—返回结果数据—>
      </ActionResponse>
  • JSON 示例
    1. { RequestId”: 4C467B38-3910-447D-87BC-AC049166F216 / 返回结果数据 /}

异常返回示例

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

您可以根据返回的错误信息排查错误,错误码可以到对应API文档页面查看。当您无法排查错误时,可以 提交工单 联系我们,并在工单中注明RequestId

  • XML 示例
    1. <?xml version=”1.0 encoding=”UTF-8”?><!—结果的根结点—>
      <Error>
      <RequestId>540CFF28-407A-40B5-B6A5-74Bxxxxxxxxx</RequestId> <!—请求 ID—>
      <HostId>ccc.cn-shanghai.aliyuncs.com</HostId> <!—服务节点—>
      <Code>NotExist.Instance</Code> <!—错误码—>
      <Message>Call center instance ‘9cfad875-6260-4a53-a6e-b13e3fb31f7d’ does not exist</Message> <!—错误信息—>
      </Error>
  • JSON 示例
    1. { RequestId”: 540CFF28-407A-40B5-B6A5-74Bxxxxxxxxx”, / 请求 ID /
      HostId”: ccc.cn-shanghai.aliyuncs.com”, / 服务节点 /
      Code”: NotExist.Instance”, / 错误码 /
      Message”: Call center instance 9cfad875-6260-4a53-a6e-b13e3fb31f7d does not exist / 错误信息 /}