本文主要介紹返回結(jié)果。
返回結(jié)果主要有 XML 和 JSON 兩種格式,默認(rèn)為 JSON,您可以指定公共請求參數(shù) Format
變更返回結(jié)果的格式。更多詳情,請參閱 公共參數(shù)。
說明 為了便于查看和美觀,API 文檔返回示例均有換行和縮進(jìn)等處理,實(shí)際返回結(jié)果無換行和縮進(jìn)處理。
正常返回示例
接口調(diào)用成功后會返回接口返回參數(shù)和請求 ID,我們稱這樣的返回為正常返回。HTTP 狀態(tài)碼為 2xx。
XML
示例
<?xml version="1.0" encoding="UTF-8"?> <!--結(jié)果的根結(jié)點(diǎn)-->
<ActionResponse> <!--返回請求標(biāo)簽-->
<RequestId>4C467B38-3910-447D-87BC-AC049166F223</RequestId> <!--返回結(jié)果數(shù)據(jù)-->
</ActionResponse>
JSON
示例
{
"RequestId": "4C467B38-3910-447D-87BC-AC049166F223" /* 返回結(jié)果數(shù)據(jù) */
}
異常返回示例
接口調(diào)用出錯(cuò)后,會返回錯(cuò)誤碼、錯(cuò)誤信息和請求 ID,我們稱這樣的返回為異常返回。HTTP 狀態(tài)碼為 4xx 或者 5xx。
您可以根據(jù)接口錯(cuò)誤碼以及 公共錯(cuò)誤碼 排查錯(cuò)誤。當(dāng)您無法排查錯(cuò)誤時(shí),可以 提交工單 聯(lián)系我們,并在工單中注明服務(wù)節(jié)點(diǎn) HostId
和 RequestId
。
XML
示例
<?xml version="1.0" encoding="UTF-8"?><!--結(jié)果的根結(jié)點(diǎn)-->
<Error>
<RequestId>540CFF28-407A-40B5-B6A5-74Bxxxxxxxxx</RequestId> <!--請求 ID-->
<HostId>ess.aliyuncs.com</HostId> <!--服務(wù)節(jié)點(diǎn)-->
<Code>InternalError</Code> <!--錯(cuò)誤碼-->
<Message>The request processing has failed due to some unknown error, exception or failure.</Message> <!--錯(cuò)誤信息-->
</Error>
JSON
示例
{
"RequestId": "540CFF28-407A-40B5-B6A5-74Bxxxxxxxxx", /* 請求 ID */
"HostId": "ess.aliyuncs.com", /* 服務(wù)節(jié)點(diǎn) */
"Code": "InternalError", /* 錯(cuò)誤碼 */
"Message": "The request processing has failed due to some unknown error, exception or failure." /* 錯(cuò)誤信息 */
}
公共錯(cuò)誤碼
HttpCode | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
---|---|---|---|
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. | 指定的參數(shù)取值不合法。 |
400 | MissingParameter | The input parameter <parameter name> that is mandatory for processing this request is not supplied. | 缺少必需參數(shù)。 |
400 | NoSuchVersion | The specified version does not exist. | 指定的 API 版本不存在。 |
400 | ResourceNotAvailable | Resource you requested is not available in this region or zone. | 指定的地域暫未部署彈性伸縮服務(wù)。 |
400 | Throttling | Request was denied due to request throttling. | 系統(tǒng)流控期間,請稍后再試。 |
400 | UnsupportedOperation | The specified action is not supported. | 無法調(diào)用指定的 API。 |
403 | Forbidden | Users are not authorized to operate on the specified resource. | 您無法執(zhí)行該操作。 |
403 | Forbidden.RiskControl | This operation is forbidden by Aliyun Risk Control system. | 系統(tǒng)風(fēng)險(xiǎn)控制,禁止該操作。 |
403 | Forbidden.Unsubscribed | Do not have permission to access this API. | 您未開通彈性伸縮服務(wù),無法調(diào)用該 API。 |
403 | Forbidden.UserVerification | Your user account is not verified by Aliyun. | 您未完成實(shí)名認(rèn)證。
更多詳情,請參閱 實(shí)名認(rèn)證。 |
403 | SignatureDoesNotMatch | The signature we calculated does not match the one you provided. | 我們計(jì)算得出的簽名與您提供的簽名不匹配。 |
500 | InternalError | The request processing has failed due to some unknown error, exception or failure. | 系統(tǒng)錯(cuò)誤。 |
503 | ServiceUnavailable | The request has failed due to a temporary failure of the server. | 服務(wù)器當(dāng)前無法處理請求,請稍后再試。 |