全部产品
云市场

返回结果

更新时间:2018-12-04 15:35:29

返回结果

调用 API 服务后返回数据采用统一格式:

返回的 HTTP 状态码为 2xx,代表调用成功。返回的 HTTP 状态码为 4xx 或 5xx,代表调用失败。调用成功返回的数据格式主要有 XML 和 JSON 两种,外部系统可以在请求时传入参数来制定返回的数据格式,默认为 XML 格式。

本文档中的返回示例为了便于用户查看,做了格式化处理,实际返回结果是没有进行换行、缩进等处理的。

成功结果

XML示例

  1. <RegisterUserResponse>
  2. <RequestId>ADE24A7C-DB8B-4D32-94AD-E50E3B921197</RequestId>
  3. <Success>true</Success>
  4. </RegisterUserResponse>

JSON示例

  1. {
  2. "RequestId":"34E01EDD-6A16-4CF0-9541-C644D1BE01AA",
  3. "Success":true
  4. }

错误结果

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

XML示例

  1. <Error>
  2. <RequestId>ADE24A7C-DB8B-4D32-94AD-E50E3B921197</RequestId>
  3. <HostId>dms-enterprise.aliyuncs.com</HostId>
  4. <Code>UserExisted</Code>
  5. <Message>The specified user already exists.</Message>
  6. </Error>

JSON示例

  1. {
  2. "Code":"UserExisted",
  3. "HostId":"dms-enterprise.aliyuncs.com",
  4. "Message":"The specified user already exists.",
  5. "RequestId":"34E01EDD-6A16-4CF0-9541-C644D1BE01AA"
  6. }

公共错误码

请参照:公共错误码表