开发者社区 问答 正文

云解析的返回结果


调用API服务后返回数据采用统一格式,返回的HTTP状态码为2xx,代表调用成功;返回4xx或5xx的HTTP状态码代表调用失败。调用成功返回的数据格式主要有XML和JSON两种,外部系统可以在请求时传入参数来制定返回的数据格式,默认为XML格式。本文档中的返回示例为了便于用户查看,做了格式化处理,实际返回结果是没有进行换行、缩进等处理的。

成功结果



XML示例

<?xml version="1.0" encoding="UTF-8"?><!—结果的根结点--><接口名称+Response><!—返回请求标签--><RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId><!—返回结果数据--></接口名称+Response>

JSON示例

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

错误结果


调用接口出错后,将不会返回结果数据。调用方可根据每个接口对应的错误码以及 公共错误码来定位错误原因。
当调用出错时,HTTP请求返回一个4xx或5xx的HTTP状态码。返回的消息体中是具体的错误代码及错误信息。另外还包含一个全局唯一的请求ID:RequestId和一个您该次请求访问的站点ID:HostId。在调用方找不到错误原因时,可以联系阿里云客服,并提供该HostId和RequestId,以便我们尽快帮您解决问题。

XML示例

<?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示例

{"RequestId": "8906582E-6722-409A-A6C4-0E7863B733A5","HostId": "dns.aliyuncs.com","Code": "DomainNotExist","Message": "The domain name does not exist."}

展开
收起
boxti 2017-10-18 10:16:22 1463 分享 版权
阿里云 AI 助理回答

您提到的内容是关于调用阿里云API时返回结果的格式和错误处理的描述。这里有几个关键点:

  1. HTTP状态码:这是判断请求是否成功的直接标志。

    • 2xx 状态码表示请求成功,比如最常见的 200 OK
    • 4xx 状态码通常表示客户端错误,意味着请求中有问题,如 400 Bad Request, 401 Unauthorized, 404 Not Found 等。
    • 5xx 状态码代表服务器端错误,表明服务器在处理请求时遇到了问题,如 500 Internal Server Error, 503 Service Unavailable
  2. 返回数据格式:默认为XML,但大多数API也支持JSON格式,通过在请求中指定参数来选择。JSON格式因其易于阅读和解析,在现代应用中更为常用。

  3. 成功结果示例

    • XML示例中,除了HTTP状态码外,响应体包含一个RequestId作为操作的唯一标识。
    • JSON示例同样包含RequestId,以及可能的其他操作结果数据(注释部分)。
  4. 错误结果处理

    • 当调用失败时,HTTP状态码会是4xx或5xx,并且响应体中会包含错误信息,包括:
      • RequestId:用于追踪请求,对问题排查至关重要。
      • HostId:标识了处理该请求的服务节点,有助于定位问题来源。
      • Code:具体的错误代码,每个服务有其特定的错误码列表。
      • Message:对错误的简要描述,帮助理解错误原因。

如果遇到错误,首先应根据CodeMessage进行自我排查。若无法解决,记录下RequestIdHostId,联系阿里云客服提供这些信息,以便快速获得技术支持。此外,阿里云文档通常会提供所有可能的错误码及其含义,查阅对应服务的API文档是解决问题的有效途径。

有帮助
无帮助
AI 助理回答生成答案可能存在不准确,仅供参考
0 条回答
写回答
取消 提交回答