调用API服务后返回的数据采用统一格式,主要有XML和JSON两种,外部系统可以在请求时传入参数来制定返回的数据格式,默认为XML格式。本文档为您提供调用成功和失败后的返回结果示例。
调用返回的HTTP状态码为2xx
代表调用成功;返回4xx
或5xx
的HTTP状态码代表调用失败。
说明 本文档中的返回示例为了便于用户查看,做了格式化处理,实际返回结果是没有进行换行、缩进等处理的。
成功结果
XML返回结果包括请求是否成功信息和具体的业务数据。示例如下:
<?xml version="1.0" encoding="utf-8"?> <!--结果的根结点--> <接口名称+Response> <!--返回请求标签--> <RequestId>4C4fdsf38-3910-447D-87AD-AC078932216</RequestId> <!--返回结果数据--> </接口名称+Response>
JSON示例:
{ "RequestId": "4C4fdsf38-3910-447D-87AD-AC078932216", /* 返回结果数据 */ }
错误结果
调用接口出错后,将不会返回结果数据。调用方可根据附表错误代码表来定位错误原因。当调用出错时,HTTP请求返回一个4xx
或5xx
的HTTP状态码。返回的消息体中是具体的错误代码及错误信息。另外还包含一个全局唯一的请求ID:RequestId和一个您该次请求访问的站点ID:HostId。若在调用方找不到错误原因,可以联系专有云客服,并提供该HostId和RequestId,以便我们尽快帮您解决问题。
<?xml version="1.0" encoding="UTF-8"?> <Error> <RequestId>8906582E-6722-409A-A6C4-0E7863B733A5</RequestId> <HostId> r-kvstore.aliyuncs.com</HostId> <Code>UnsupportedOperation</Code> <Message>The specified action is not supported.</Message> </Error>
JSON示例:
{ "RequestId": "7463B73D-35CC-4D19-A010-6B8D65D242EF", "HostId": " r-kvstore.aliyuncs.com", "Code": "UnsupportedOperation", "Message": "The specified action is not supported." }