调用API服务后的返回结果示例
返回结果
调用API服务后返回数据采用统一格式：
- 返回的HTTP状态码为2xx，代表调用成功；
- 返回4xx或5xx的HTTP状态码代表调用失败。
调用成功返回的数据格式主要有XML和JSON两种，外部系统可以在请求时传入参数来制定返回的数据格式，默认为XML格式。本文档中的返回示例为了便于用户查看，做了格式化处理，实际返回结果是没有进行换行、缩进等处理的。
成功结果
XML示例：
<?xml version="1.0" encoding="UTF-8" ?>
<!-结果的根结点-->
<接口名称+ Response>
<!-返回请求标签-->
<RequestId>25818875-5F78-4A13-BEF6-D7393642CA58</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>cloudphoto.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": "cloudphoto.cn-shanghai.aliyuncs.com",
"Code": "UnsupportedOperation",
"Message": "The specified action is not supported."
}
展开
收起
版权声明：本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
阿里云 AI 助理回答
从您的描述中，可以看出您正在了解或使用阿里云API的调用返回结果格式。无论是成功还是失败的响应，阿里云API都遵循一定的结构来确保调用者能够清晰地理解调用状态和获取必要的信息。
成功结果
- HTTP状态码：2xx系列，表明请求已成功被服务器处理。
- 返回数据格式：默认为XML，但可以通过请求参数指定为JSON。这两种格式都包含了操作的结果数据以及一个全局唯一的请求标识
RequestId。这个RequestId在需要技术支持时非常关键，因为它能帮助追踪具体的请求过程。
XML示例解析：
<RequestId>25818875-5F78-4A13-BEF6-D7393642CA58</RequestId>
这里只展示了RequestId部分，实际成功响应会包含更多具体操作成功的数据字段。
JSON示例解析：
{
"RequestId": "4C467B38-3910-447D-87BC-AC049166F216",
/* 返回结果数据 */
}
同样，注释部分代表应有具体操作成功后的数据内容，而不仅仅是RequestId。
失败结果
- HTTP状态码：4xx表示客户端错误（如请求无效），5xx表示服务器端错误。
- 返回信息：包括错误代码
Code、错误信息Message、请求IDRequestId，以及可能的站点IDHostId。这些信息对于诊断问题至关重要。
XML示例解析：
<RequestId>8906582E-6722-409A-A6C4-0E7863B733A5</RequestId>
<HostId>cloudphoto.cn-shanghai.aliyuncs.com</HostId>
<Code>UnsupportedOperation</Code>
<Message>The specified action is not supported.</Message>
JSON示例解析：
{
"RequestId": "8906582E-6722-409A-A6C4-0E7863B733A5",
"HostId": "cloudphoto.cn-shanghai.aliyuncs.com",
"Code": "UnsupportedOperation",
"Message": "The specified action is not supported."
}
这两个示例展示了如何识别和理解API调用失败的原因，通过错误代码和消息可以快速定位问题所在。
当遇到调用问题时，首先检查HTTP状态码和错误代码，然后根据错误信息进行相应的调整或查阅阿里云官方文档以获取更详细的错误说明和解决办法。如果问题依然无法解决，记得保留RequestId和HostId以便联系阿里云客服获得帮助。
有帮助
无帮助
AI 助理回答生成答案可能存在不准确，仅供参考
相关问答