用户每次发送接口调用请求,无论成功与否,系统都会向用户返回请求结果。本文将介绍相关返回结果的具体情况。
DMS OpenAPI使用标准的HTTP状态码表示请求处理的结果,具体HTTP状态码如下所示:
- 返回的HTTP状态码为2xx,代表调用成功。
- 返回的HTTP状态码为4xx或5xx,代表调用失败。
成功结果
示例:
- XML示例
<RegisterUserResponse> <RequestId>ADE24A7C-DB8B-4D32-94AD-E50E3B******</RequestId> <Success>true</Success> </RegisterUserResponse>
- JSON示例
{ "RequestId":"34E01EDD-6A16-4CF0-9541-C644D1******", "Success":true }
错误结果
调用出错后,HTTP请求会返回一个4xx或5xx的HTTP状态码。返回的消息中包含具体的错误代码及错误信息,还包含一个全局唯一的请求ID(RequestId)和一个本次请求访问的站点ID(HostId)。
示例:
- XML示例
<Error> <RequestId>ADE24A7C-DB8B-4D32-94AD-E50E3B******</RequestId> <HostId>xxx-xxxxxxxxxx.aliyuncs.com</HostId> <Code>UserExisted</Code> <Message>The specified user already exists.</Message> </Error>
- JSON示例
{ "Code":"UserExisted", "HostId":"xxx-xxxxxxxxxx.aliyuncs.com", "Message":"The specified user already exists.", "RequestId":"34E01EDD-6A16-4CF0-9541-C644D1******" }