API 文档

错误码

最近更新时间:2020-09-22 08:09:24

功能说明

如果返回结果中存在 Error 字段,则表示调用 API 接口失败。例如:

 {
    "Response": {
        "Error": {
            "Code": "AuthFailure.SignatureFailure",
            "Message": "The provided credentials could not be validated. Please check your signature is correct."
        },
        "RequestId": "ed93f3cb-f35e-473f-b9f3-0d451b8b79c6"
    }
}

Error 中的 Code 表示错误码,Message 表示该错误的具体信息。

错误码列表

公共错误码

错误码 说明
UnsupportedOperation 操作不支持。
ResourceInUse 资源被占用。
InternalError 内部错误。
RequestLimitExceeded 请求的次数超过了频率限制。
AuthFailure.SecretIdNotFound 密钥不存在。 请在控制台检查密钥是否已被删除或者禁用,如状态正常,请检查密钥是否填写正确,注意前后不得有空格。
LimitExceeded 超过配额限制。
NoSuchVersion 接口版本不存在。
ResourceNotFound 资源不存在。
AuthFailure.SignatureFailure 签名错误。 签名计算错误,请对照调用方式中的签名方法文档检查签名计算过程。
AuthFailure.SignatureExpire 签名过期。Timestamp 和服务器时间相差不得超过五分钟,请检查本地时间是否和标准时间同步。
UnsupportedRegion 接口不支持所传地域。
UnauthorizedOperation 未授权操作。
InvalidParameter 参数错误。
ResourceUnavailable 资源不可用。
AuthFailure.MFAFailure MFA 错误。
AuthFailure.UnauthorizedOperation 请求未授权。请参考 CAM 文档对鉴权的说明。
AuthFailure.InvalidSecretId 密钥非法(不是云 API 密钥类型)。
AuthFailure.TokenFailure token 错误。
DryRunOperation DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。
FailedOperation 操作失败。
UnknownParameter 未知参数错误。
UnsupportedProtocol HTTP(S)请求协议错误,只支持 GET 和 POST 请求。
InvalidParameterValue 参数取值错误。
InvalidAction 接口不存在。
MissingParameter 缺少参数错误。
ResourceInsufficient 资源不足。

业务错误码

错误码 说明
FailedOperation.ApiBindEnvironmen 该api绑定了使用计划。
FailedOperation.ApiError api类错误。
FailedOperation.CertificateIdBindError 证书绑定错误。
FailedOperation.CertificateIdEnterpriseWaitSubmit 企业证书,待提交。
FailedOperation.CertificateIdError 证书不存在或者您没有权限查看,请在ssl证书管理平台上传有效证书。
FailedOperation.CertificateIdExpired 证书已过期。
FailedOperation.CertificateIdInfoError 该证书信息内容为空,请联系证书同事。
FailedOperation.CertificateIdUnderVerify 证书还在审核中。
FailedOperation.CertificateIdUnknownError 证书其他未知状态,请联系证书同事。
FailedOperation.CertificateIdVerifyFail 证书审核失败。
FailedOperation.CertificateIsNull 证书Id为空。
FailedOperation.DefineMappingEnvironmentError 自定义路径映射,Environment只能取值'test'、 'prepub', 'release'。
FailedOperation.DefineMappingNotNull 选择自定义路径映射时,不能为空。
FailedOperation.DefineMappingParamRepeat 自定义路径映射,取值重复。
FailedOperation.DefineMappingPathError 自定义路径映射,Path不符规范。
FailedOperation.DeletePathMappingSetError 删除自定义域名错误。
FailedOperation.DescribeServiceSubDomainsError 服务自定义域名错误。
FailedOperation.DomainAlreadyBindOtherService 该域名已经绑定其他服务。
FailedOperation.DomainAlreadyBindService 该域名已经绑定该服务。
FailedOperation.DomainNeedBeian 该域名还未在腾讯云备案,请备案之后再绑定域名。
FailedOperation.DomainNotBindService 自定义域名未绑定服务。
FailedOperation.DomainResolveError 该自定义域名没有配置CNAME到默认域名,或者还未生效。
FailedOperation.FormatError 域名格式错误。
FailedOperation.IsDefaultMapping 使用默认路径映射时,不能输入PathMappingSet。
FailedOperation.NetSubDomainError 默认的二级域名输入错误。
FailedOperation.PathMappingSetError 设置路径映射错误。
FailedOperation.ServiceError 服务相关的错误。
FailedOperation.ServiceNotExist 服务不存在。
FailedOperation.SetCustomPathMappingError 设置自定义域名路径映射错误。
FailedOperation.SubDomainFormatError 自定义域名格式错误。
FailedOperation.UnknownProtocolTypeError 未知网络协议类型。
InternalError.OssException oss内部错误。
InvalidParameter.FormatError 参数格式错误。
InvalidParameterValue.InvalidApiBusinessType 传入的Api业务类型必须为OAUTH。
InvalidParameterValue.InvalidApiRequestConfig 无效的API配置。
InvalidParameterValue.InvalidClb 不合法的clb。
InvalidParameterValue.InvalidProcotol 无效的协议类型参数。
InvalidParameterValue.InvalidPublicKey OAUTH2.0 API 公钥信息格式不正确。
InvalidParameterValue.InvalidRequestParameters 不合法的请求参数。
InvalidParameterValue.InvalidServiceConfig 不合法的服务配置。
InvalidParameterValue.NothingModifyForOauth oauth接口无可用修改项。
LimitExceeded.ApiCountLimitExceeded API配额超限。
LimitExceeded.ApiKeyCountLimitExceeded 密钥数量超出限制。
LimitExceeded.ExceededDefineMappingLimit 自定义路径映射,最多三组。
LimitExceeded.ExceededDomainLimit 绑定域名数量超出限制,默认最多5个。
LimitExceeded.ServiceCountLimitExceeded 创建服务总数超过限制。
ResourceNotFound.InvalidAccessKeyId 密钥不存在。
ResourceNotFound.InvalidApi ApiId错误。
ResourceNotFound.InvalidService 对应服务不可见。
ResourceNotFound.InvalidUsagePlan 使用计划不存在。
UnauthorizedOperation.UncertifiedUser 用户未实名制。
UnsupportedOperation.InvalidServiceTrade 当前服务处于隔离中,暂不支持此操作。
UnsupportedOperation.InvalidStatus apikey状态不支持此操作。
UnsupportedOperation.ReduceNetTypes 禁止减少网络类型。
UnsupportedOperation.ResourceIsInUse 资源在使用中。
UnsupportedOperation.UnsupportedBindEnvironment 不允许绑定环境。
UnsupportedOperation.UnsupportedDeleteService 服务使用中,不能被删除。
UnsupportedOperation.UnsupportedUpdateApiKey 密钥状态不支持更新。
UnsupportedOperation.UsagePlanInUse 使用计划使用中,不能被删除。
目录