API返回结果采用统一格式,调用成功返回的数据格式有XML和JSON两种,可以在发送请求时指定返回的数据格式,默认为JSON格式。
成功结果
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>9823FD72-9A5D-4D3F-BA2C-F8238696A81C</RequestId>
<HostId>business.aliyuncs.com</HostId>
<Code>InvalidAction.NotFound</Code>
<Message>Specified api is not found, please check your url and method.</Message>
</Error>
JSON示例:
{
"RequestId":"33D9749B-713A-4BCC-B3B4-8B0094083E97",
"HostId":"business.aliyuncs.com",
"Code":"InvalidAction.NotFound",
"Message":"Specified api is not found, please check your url and method."
}