管控OpenAPI錯(cuò)誤代碼表
本文主要介紹調(diào)用管控OpenAPI時(shí)常見(jiàn)的錯(cuò)誤代碼。
當(dāng)您調(diào)用API網(wǎng)關(guān)開(kāi)放的管控OpenAPI時(shí),如CreateAPI、ModifyAPI、DeleteAPI等,您可能遇到以下錯(cuò)誤碼。
服務(wù)端錯(cuò)誤碼
HttpCode為5xx,表示服務(wù)不可用。此時(shí)建議重試。
錯(cuò)誤代碼 | 描述 | HTTP 狀態(tài)碼 | 語(yǔ)義 | 解決方案 |
ServiceUnavailable | The request has failed due to a temporary failure of the server. | 503 | 服務(wù)不可用 | 建議重試。 |
InternalError | The request processing has failed due to some unknown error, exception or failure. | 500 | 內(nèi)部錯(cuò)誤 | 建議重試。 |
客戶端錯(cuò)誤碼
HttpCode為4xx,表示業(yè)務(wù)錯(cuò)誤。一般為參數(shù)錯(cuò)誤、權(quán)限限制、業(yè)務(wù)邏輯錯(cuò)誤等問(wèn)題,此時(shí)需要仔細(xì)查看錯(cuò)誤碼,并針對(duì)性地解決問(wèn)題。
錯(cuò)誤代碼 | 描述 | HTTP 狀態(tài)碼 | 語(yǔ)義 | 解決 |
Repeated%s | The specified %s is repeated. | 400 | 某參數(shù)重復(fù)(%s 是占位符,實(shí)際調(diào)用會(huì)給出明確的參數(shù)名或提示。) | 建議按照提示修改重復(fù)的參數(shù)后重試。 |
RepeatedCommit | Resubmit request. | 400 | 請(qǐng)求重復(fù) | 請(qǐng)不要頻繁提交請(qǐng)求。 |
Missing%s | The %s is mandatory for this action. | 400 | 缺少參數(shù) %s | 根據(jù)具體返回補(bǔ)充缺少的參數(shù),重試請(qǐng)求。 |
MissingAppIdOrAppOwner | AppId or AppOwner must have a valid value. | 400 | 缺少參數(shù) AppId 或者 AppOwner | 參數(shù) AppId 和 AppOwner 不能同時(shí)為空。 |
Invalid%s | The specified parameter %s value is not valid. | 400 | 參數(shù)無(wú)效 | 根據(jù)返回提示的具體參數(shù),查看相關(guān)參數(shù)約束,修改后重試。 |
NotFound%s | Cannot find resource according to your specified %s. | 400 | 找不到資源 | 根據(jù)指定的參數(shù)%s找不到資源,建議檢查%s是否正確。 |
InvalidFormat%s | The specified parameter %s value is not well formatted. | 400 | 參數(shù)格式錯(cuò)誤 | 建議根據(jù)實(shí)際返回提示,查看%s的格式要求,修改后重試。 |
Duplicate%s | The specified parameter %s value is duplicate. | 400 | 參數(shù)重復(fù) | 某請(qǐng)求參數(shù)不允許重復(fù),建議檢查修正后重試。 |
DependencyViolation%s | The specified %s has %s definitions. | 400 | 參數(shù)依賴錯(cuò)誤 | 指定參數(shù)被依賴,不能隨意刪除,請(qǐng)先解除依賴。 |
Forbidden%s | Not allowed to operate on the specified %s. | 403 | 無(wú)權(quán)操作/操作禁止 | 您無(wú)權(quán)執(zhí)行該操作。 |
NoPermission | User is not authorized to operate on the specified resource. | 403 | 無(wú)權(quán)操作 | RAM 鑒權(quán)不通過(guò)。 |
ExceedLimit%s | The specified %s count exceeds the limit. | 400 | 超出個(gè)數(shù)限制 | 一般指用戶賬戶下創(chuàng)建的 API、API 分組或者APP超出個(gè)數(shù)限制。 |
UserNotFound | The specified user can not be found. | 404 | 指定用戶找不到 | 根據(jù)輸入的用戶信息找不到該用戶。 |
DomainCertificateNotFound | Cannot find the domain certificate. | 400 | 指定域名證書(shū)不存在 | 建議檢查傳入的證書(shū) ID 及名稱。 |
DomainNotResolved | The specified domain has not been resolved. | 400 | 指定域名未解析 | 需要將指定域名 CNAME 解析到分組的二級(jí)域名上,才能完成綁定。域名解析是在用戶域名購(gòu)買的網(wǎng)站上操作。 |
InvalidICPLicense | The specified domain have not got ICP license, or the ICP license does not belong to Aliyun. | 400 | 域名備案不合格 | 要綁定的域名需要在阿里云做首次備案,已經(jīng)在其他系統(tǒng)做備案的,需要在阿里云備案接入。備案接入需要獲取備案號(hào),在阿里云有 ECS 且具有公網(wǎng) IP 的,每個(gè) ECS 有5個(gè)備案號(hào)。 |
Invalid%s.LengthLimit | The parameter %s length exceeds the limit. | 400 | 長(zhǎng)度超限 | 參數(shù)%s超出長(zhǎng)度限制,建議修正后重試。 |
InvalidApiDefault | The ApiDefault value exceeds limit. | 400 | 流控插件 API 默認(rèn)值超過(guò)限制值 | 該值數(shù)值不能超過(guò)1億,與單位無(wú)關(guān)。 |
InvalidAppDefault | The AppDefault value must smaller than the UserDefault and ApiDefault. | 400 | AppDefault 的值不符合規(guī)則 | 該值需要小于 API 流控值和用戶流控值。 |
InvalidUserDefault | The UserDefault value must bigger than the AppDefault and smaller than the ApiDefault. | 400 | UserDefault 的值不符合規(guī)則 | 該值需要小于 API 流控值并大于 APP 流控值。 |
InvalidParamMapping | Parameters must be fully mapped. | 400 | 參數(shù)映射無(wú)效 | 創(chuàng)建 API 時(shí),前后端參數(shù)映射需要是全映射。即每個(gè)入?yún)⒍夹枰渲煤蠖藚?shù)名稱。 |
InvalidOwnerAccount | OwnerAccount is invalid. | 400 | APP所有者賬號(hào)無(wú)效 | 一般為操作授權(quán)時(shí),輸入目標(biāo)用戶的阿里云郵箱賬號(hào)。若該賬號(hào)無(wú)效,建議檢查修正后重試。 |
ServiceForbidden | Your Gateway service is forbidden by risk control. | 400 | API 網(wǎng)關(guān)服務(wù)被風(fēng)控(應(yīng)該使用戶被風(fēng)控吧) | 請(qǐng)注意不要頻繁請(qǐng)求,建議稍后重試。 |
ServiceUnOpen | Your Gateway service has not been opened. | 400 | 服務(wù)未開(kāi)通 | 建議到阿里云官網(wǎng)開(kāi)通一下 API 網(wǎng)關(guān)服務(wù)。 |
ServiceInDept | Your API Gateway service is in dept. | 400 | (您的 API 網(wǎng)關(guān))服務(wù)欠費(fèi) | 充值或者結(jié)算后重新開(kāi)始使用。 |
EqualSignature | The new signature is the same as the old. | 400 | 新密鑰與舊的相等 | 修改后端簽名密鑰時(shí),新設(shè)置的 Key 和 Secret 不能跟原來(lái)的一樣。 |
CertificateNotMatch | The domain does not match the one in the certificate. | 400 | 證書(shū)不匹配 | 指定域名與證書(shū)內(nèi)域名不匹配。 |
CertificateKeyNotMatch | The certificate private key does not match the public key. | 400 | 證書(shū)密鑰不匹配 | 證書(shū)的公鑰和私鑰不匹配。 |
PrivateKeyEncrypted | The certificate private key is encrypted, please upload the unencrypted version. | 400 | 密鑰不能加密 | 證書(shū)私鑰加密了,要求上傳不加密的版本。 |
CertificateSecretKeyError | The certificate private key is invalid. | 400 | 證書(shū)私鑰錯(cuò)誤 | 建議檢查后重新傳入。 |
InvalidApiServiceAddress | The specified service address is not valid. | 400 | API 后端服務(wù)地址無(wú)效 | 配置的 API 后端服務(wù)地址無(wú)效。 |
客戶端公用錯(cuò)誤碼
HttpCode為4xx,調(diào)用全阿里云產(chǎn)品的OpenAPI均可能遇到,表示業(yè)務(wù)錯(cuò)誤。一般為請(qǐng)求格式錯(cuò)誤、請(qǐng)求方式錯(cuò)誤、必填參數(shù)丟失、參數(shù)格式錯(cuò)誤、簽名錯(cuò)誤、流控限制等問(wèn)題。此時(shí)需查看具體錯(cuò)誤碼,針對(duì)性解決問(wèn)題。
報(bào)錯(cuò)場(chǎng)景 | 錯(cuò)誤碼 | 錯(cuò)誤提示 | 狀態(tài)碼 | 建議 |
API 找不到。 | InvalidApi.NotFound | Specified api is not found, please check your url and method. | 404 | 請(qǐng)檢查指定的 action 接口名稱是否正確,注意大小寫(xiě)區(qū)分。 |
缺少必填參數(shù)。 | Missing{ParameterName} | {ParameterName} is mandatory for this action. | 400 | 指定參數(shù)為必填參數(shù),請(qǐng)傳入。 |
AccessKeyId 找不到 | InvalidAccessKeyId.NotFound | Specified access key is not found. | 404 | 請(qǐng)檢查調(diào)用時(shí)是否傳入正確的 AccessKeyId。 |
AccessKeyId 被禁用。 | InvalidAccessKeyId.Inactive | Specified access key is disabled. | 400 | 檢查 AK 是否可用。 |
時(shí)間戳格式不對(duì)(Date 和 Timestamp)。 | InvalidTimeStamp.Format | Specified time stamp or date value is not well formatted. | 400 | 檢查時(shí)間戳。 |
用戶時(shí)間和服務(wù)器時(shí)間超過(guò)15分鐘。 | InvalidTimeStamp.Expired | Specified time stamp or date value is expired. | 400 | 檢查時(shí)間戳。 |
SignatureNonce 重復(fù) | SignatureNonceUsed | Specified signature nonce was used already. | 400 | |
返回值格式不正確。 | InvalidParameter.Format | Specified parameter format is not valid. | 400 | 僅支持 XML/JSON。 |
參數(shù)值校驗(yàn)不通過(guò)。 | Invalid{ParameterName} | Specified parameter {ParameterName} is not valid. | 400 | 請(qǐng)檢查指定參數(shù)的值。 |
Http 請(qǐng)求方法不支持。 | UnsupportedHTTPMethod | Specified signature is not matched with our calculation. | 400 | 請(qǐng)檢查請(qǐng)求Method。 |
簽名方法不支持。 | InvalidSignatureMethod | Specified signature method is not valid. | 400 | 默認(rèn)可以不填寫(xiě)該值。 |
簽名不通過(guò)。 | SignatureDoesNotMatch | Specified signature is not matched with our calculation. | 400 | 簽名不通過(guò)。 |
用戶調(diào)用頻率超限。 | Throttling.User | Request was denied due to user flow control. | 400 | 請(qǐng)稍后訪問(wèn),降低訪問(wèn)頻率。 |
API 訪問(wèn)頻率超限。 | Throttling.API | Request was denied due to api flow control. | 400 | 請(qǐng)稍后訪問(wèn),降低訪問(wèn)頻率。 |
缺少AccessKeyId。 | MissingSecurityToken | SecurityToken is mandatory for this action. | 400 | 請(qǐng)檢查是否傳入有效AccessKeyId。 |