本文主要介绍返回结果。
返回结果主要有 XML 和 JSON 两种格式,默认为 JSON,您可以指定公共请求参数 Format
变更返回结果的格式。更多详情,请参阅 公共参数。
说明 为了便于查看和美观,API 文档返回示例均有换行和缩进等处理,实际返回结果无换行和缩进处理。
正常返回示例
接口调用成功后会返回接口返回参数和请求 ID,我们称这样的返回为正常返回。HTTP 状态码为 2xx。
XML
示例
<?xml version="1.0" encoding="UTF-8"?> <!--结果的根结点-->
<ActionResponse> <!--返回请求标签-->
<RequestId>4C467B38-3910-447D-87BC-AC049166F223</RequestId> <!--返回结果数据-->
</ActionResponse>
JSON
示例
{
"RequestId": "4C467B38-3910-447D-87BC-AC049166F223" /* 返回结果数据 */
}
异常返回示例
接口调用出错后,会返回错误码、错误信息和请求 ID,我们称这样的返回为异常返回。HTTP 状态码为 4xx 或者 5xx。
您可以根据接口错误码以及 公共错误码 排查错误。当您无法排查错误时,可以 提交工单 联系我们,并在工单中注明服务节点 HostId
和 RequestId
。
XML
示例
<?xml version="1.0" encoding="UTF-8"?><!--结果的根结点-->
<Error>
<RequestId>540CFF28-407A-40B5-B6A5-74Bxxxxxxxxx</RequestId> <!--请求 ID-->
<HostId>ess.aliyuncs.com</HostId> <!--服务节点-->
<Code>InternalError</Code> <!--错误码-->
<Message>The request processing has failed due to some unknown error, exception or failure.</Message> <!--错误信息-->
</Error>
JSON
示例
{
"RequestId": "540CFF28-407A-40B5-B6A5-74Bxxxxxxxxx", /* 请求 ID */
"HostId": "ess.aliyuncs.com", /* 服务节点 */
"Code": "InternalError", /* 错误码 */
"Message": "The request processing has failed due to some unknown error, exception or failure." /* 错误信息 */
}
公共错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidAccessKeyId.NotFound | The Access Key ID provided does not exist in our records. | 指定的 AccessKey 不存在。 |
400 | InvalidParameter | The specified value of parameter <parameter name> is not valid. | 指定的参数取值不合法。 |
400 | MissingParameter | The input parameter <parameter name> that is mandatory for processing this request is not supplied. | 缺少必需参数。 |
400 | NoSuchVersion | The specified version does not exist. | 指定的 API 版本不存在。 |
400 | ResourceNotAvailable | Resource you requested is not available in this region or zone. | 指定的地域暂未部署弹性伸缩服务。 |
400 | Throttling | Request was denied due to request throttling. | 系统流控期间,请稍后再试。 |
400 | UnsupportedOperation | The specified action is not supported. | 无法调用指定的 API。 |
403 | Forbidden | Users are not authorized to operate on the specified resource. | 您无法执行该操作。 |
403 | Forbidden.RiskControl | This operation is forbidden by Aliyun Risk Control system. | 系统风险控制,禁止该操作。 |
403 | Forbidden.Unsubscribed | Do not have permission to access this API. | 您未开通弹性伸缩服务,无法调用该 API。 |
403 | Forbidden.UserVerification | Your user account is not verified by Aliyun. | 您未完成实名认证。
更多详情,请参阅 实名认证。 |
403 | SignatureDoesNotMatch | The signature we calculated does not match the one you provided. | 我们计算得出的签名与您提供的签名不匹配。 |
500 | InternalError | The request processing has failed due to some unknown error, exception or failure. | 系统错误。 |
503 | ServiceUnavailable | The request has failed due to a temporary failure of the server. | 服务器当前无法处理请求,请稍后再试。 |