全部产品
弹性计算 会员服务 网络 安全 移动云 数加·大数据分析及展现 数加·大数据应用 管理与监控 云通信 阿里云办公 培训与认证 智能硬件
存储与CDN 数据库 域名与网站(万网) 应用服务 数加·人工智能 数加·大数据基础服务 互联网中间件 视频服务 开发者工具 解决方案 物联网 更多

返回结果

更新时间:2017-12-13 19:13:04

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

  • 返回的 HTTP 状态码为 2xx,代表调用成功。
  • 返回的 HTTP 状态码为 4xx 或 5xx,代表调用失败。

调用成功返回的数据格式为 JSON ,外部系统可以在请求时指定返回的数据格式为 JSON 格式。

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

成功结果

JSON 示例

  1. {
  2. "RequestId": "AB467B42-2210-4489-99BC-23049166F265",
  3. /* 返回结果数据 */
  4. }

错误结果

调用接口出错后,将不会返回结果数据。调用方可根据每个接口对应的错误码以及下述 公共错误码 来定位错误原因。

当调用出错时,HTTP 请求返回一个 4xx 或 5xx 的 HTTP 状态码。

返回的消息体中是具体的错误代码及错误信息。另外还包含一个全局唯一的请求 ID:RequestId 和一个您该次请求访问的站点 ID:HostId。在调用方找不到错误原因时,可以联系阿里云客服,并提供该 HostId 和 RequestId,以便我们尽快帮您解决问题。

JSON 示例

  1. {
  2. "RequestId": "32065824-5622-349A-A621-0E7863B73367",
  3. "HostId": "imm.cn-shanghai.aliyuncs.com",
  4. "Code": "IllegalTimestamp",
  5. "Message": "The input parameter “Timestamp” that is mandatory for processing this request is not supplied. "
  6. }

公共错误码

错误代码 HTTP 状态码 描述
IdempotentParameterMismatch 400 The request is retried with updated parameters.
InvalidArguments 400 The Arguments “xxx” is not valid.
CoexistenceArguments 400 The Arguments “xxx” and “yyy” can not be used together.
IllegalTimestamp 400 The input parameter “Timestamp” that is mandatory for processing this request is not supplied.
IncompleteSignature 400 The request signature does not conform to Aliyun standards.
InvalidAccessKeyId.NotFound 400 The specified Access Key ID does not exist.
InvalidParamater 400 The specified parameter “SignatureMethod” is not valid.
InvalidParamater 400 The specified parameter “SignatureVersion” is not valid.
InvalidParameter 400 The specified parameter “Action or Version” is not valid.
InvalidParameter.IsNull 400 The required parameter must be not null.
MissingParameter 400 The input parameter “Action” that is mandatory for processing this request is not supplied.
MissingParameter 400 The input parameter “AccessKeyId” that is mandatory for processing this request is not supplied.
MissingParameter 400 The input parameter “Signature” that is mandatory for processing the request is not supplied.
MissingParameter 400 The input parameter “TimeStamp” that is mandatory for processing this request is not supplied.
MissingParameter 400 The input parameter “Version” that is mandatory for processing this request is not supplied.
SignatureNonceUsed 400 The request signature nonce has been used.
Throttling 400 You have made too many requests within a short time; your request is denied due to request throttling.
UnsupportedParameter 400 The parameter “xxx” is not supported.
Forbidden.AccessKeyDisabled 403 The Access Key is disabled.
Forbidden.RiskControl 403 This operation is forbidden by Aliyun RiskControl system.
Forbidden.SubUser 403 The specified action is not available for you.
Forbidden.Unauthorized 403 User not authorized to operate on the specified resource.
InvalidAccount.NotFound 403 The specified Account does not exist.
InvalidAction 403 Specified action is not valid.
UnsupportedHTTPMethod 403 This http method is not supported.
RequestEntityTooLarge 413 The request entity beyond limit.
InternalError 500 The request processing has failed due to some unknown error, exception or failure.
ServiceUnavailable 503 The request has failed due to a temporary failure of the server.
ServiceUnavailable.RegionMaintaining 503 System maintenance is in progress on the selected region, please wait a few minutes before trying again.
本文导读目录