功能说明
如果返回结果中存在 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 表示该错误的具体信息。
错误码列表
公共错误码
| 错误码 | 说明 |
|---|---|
| ActionOffline | 接口已下线。 |
| AuthFailure.InvalidAuthorization | 请求头部的 Authorization 不符合腾讯云标准。 |
| AuthFailure.InvalidSecretId | 密钥非法（不是云 API 密钥类型）。 |
| AuthFailure.MFAFailure | MFA 错误。 |
| AuthFailure.SecretIdNotFound | 密钥不存在。请在 控制台 检查密钥是否已被删除或者禁用，如状态正常，请检查密钥是否填写正确，注意前后不得有空格。 |
| AuthFailure.SignatureExpire | 签名过期。Timestamp 和服务器时间相差不得超过五分钟，请检查本地时间是否和标准时间同步。 |
| AuthFailure.SignatureFailure | 签名错误。签名计算错误，请对照调用方式中的签名方法文档检查签名计算过程。 |
| AuthFailure.TokenFailure | token 错误。 |
| AuthFailure.UnauthorizedOperation | 请求未授权。请参考 CAM 文档对鉴权的说明。 |
| DryRunOperation | DryRun 操作，代表请求将会是成功的，只是多传了 DryRun 参数。 |
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidAction | 接口不存在。 |
| InvalidParameter | 参数错误（包括参数格式、类型等错误）。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidRequest | 请求 body 的 multipart 格式错误。 |
| IpInBlacklist | IP地址在黑名单中。 |
| IpNotInWhitelist | IP地址不在白名单中。 |
| LimitExceeded | 超过配额限制。 |
| MissingParameter | 缺少参数。 |
| NoSuchProduct | 产品不存在 |
| NoSuchVersion | 接口版本不存在。 |
| RequestLimitExceeded | 请求的次数超过了频率限制。 |
| RequestLimitExceeded.GlobalRegionUinLimitExceeded | 主账号超过频率限制。 |
| RequestLimitExceeded.IPLimitExceeded | IP限频。 |
| RequestLimitExceeded.UinLimitExceeded | 主账号限频。 |
| RequestSizeLimitExceeded | 请求包超过限制大小。 |
| ResourceInUse | 资源被占用。 |
| ResourceInsufficient | 资源不足。 |
| ResourceNotFound | 资源不存在。 |
| ResourceUnavailable | 资源不可用。 |
| ResponseSizeLimitExceeded | 返回包超过限制大小。 |
| ServiceUnavailable | 当前服务暂时不可用。 |
| UnauthorizedOperation | 未授权操作。 |
| UnknownParameter | 未知参数错误，用户多传未定义的参数会导致错误。 |
| UnsupportedOperation | 操作不支持。 |
| UnsupportedProtocol | http(s) 请求协议错误，只支持 GET 和 POST 请求。 |
| UnsupportedRegion | 接口不支持所传地域。 |
业务错误码
| 错误码 | 说明 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| FailedOperation.AccessKeyExist | 自定义密钥已存在。 |
| FailedOperation.ApiBindEnvironmen | 该api绑定了使用计划。 |
| FailedOperation.ApiBindEnvironment | Apis 绑定了使用计划，请先解绑再试。 |
| FailedOperation.ApiError | api类错误。 |
| FailedOperation.ApiInOperation | 当前API正在操作中，请稍后再试。 |
| FailedOperation.BackendDomainError | 返回域名错误 |
| FailedOperation.CamException | CAM异常 |
| FailedOperation.CertificateIdBindError | 证书绑定错误。 |
| FailedOperation.CertificateIdEnterpriseWaitSubmit | 该证书为企业证书，待提交。 |
| FailedOperation.CertificateIdError | 证书不存在或者您没有权限查看，请在ssl证书管理平台上传有效证书。 |
| FailedOperation.CertificateIdExpired | 证书已过期，请上传其他有效证书。 |
| FailedOperation.CertificateIdInfoError | 该证书信息内容为空，请联系证书同事。 |
| FailedOperation.CertificateIdUnderVerify | 该证书处于审核中状态，请上传其他有效证书。 |
| FailedOperation.CertificateIdUnknownError | 证书处于未知状态，请联系证书同事查看具体状态。 |
| FailedOperation.CertificateIdVerifyFail | 证书处于审核失败状态，请上传其他有效证书。 |
| FailedOperation.CertificateIsNull | Apis 证书为空，请上传证书。 |
| FailedOperation.ClsError | 调用CLS服务失败。 |
| FailedOperation.CodingError | API文档操作失败。 |
| FailedOperation.DefineMappingEnvironmentError | Apis 环境配置错误。 |
| FailedOperation.DefineMappingNotNull | Apis自定义路径映射不能为空。 |
| FailedOperation.DefineMappingParamRepeat | Apis 参数重复。 |
| FailedOperation.DefineMappingPathError | Apis自定义路径配置错误。 |
| FailedOperation.DeletePathMappingSetError | 删除自定义域名错误。 |
| FailedOperation.DescribeServiceSubDomainsError | 服务自定义域名错误。 |
| FailedOperation.DomainAlreadyBindOtherService | 该域名已经绑定其他服务。 |
| FailedOperation.DomainAlreadyBindService | 该域名已经绑定该服务。 |
| FailedOperation.DomainInBlackList | 当前域名不满足合规要求，无法进行接入。 |
| FailedOperation.DomainNeedBeian | 该域名还未在腾讯云备案，请备案之后再绑定域名。 |
| FailedOperation.DomainNotBindService | 自定义域名解绑失败，域名未绑定该服务。 |
| FailedOperation.DomainResolveError | 该域名未配置cname到默认域名，或者解析未生效。 |
| FailedOperation.EIAMError | EIAM返回错误。 |
| FailedOperation.EbError | 事件总线绑定/解绑失败。 |
| FailedOperation.FormatError | 域名格式错误。 |
| FailedOperation.GetRoleError | 获取角色失败，请确认完成API网关相关服务接口授权。 |
| FailedOperation.InstanceNotExist | 实例不存在，或者无效状态。 |
| FailedOperation.InvalidInputJSON | 无效的输入json |
| FailedOperation.IsDefaultMapping | Apis 自定义路径与默认路径冲突。 |
| FailedOperation.NetSubDomainError | 默认的二级域名输入错误。 |
| FailedOperation.OperateUpstream | 操作后端通道失败。 |
| FailedOperation.PathMappingSetError | 设置路径映射错误。 |
| FailedOperation.ScfError | SCF触发器绑定/解绑操作失败。 |
| FailedOperation.ServiceError | 服务相关的错误。 |
| FailedOperation.ServiceInOperation | 当前Service正在操作中, 请稍后再试。 |
| FailedOperation.ServiceNotExist | 服务不存在。 |
| FailedOperation.SetCustomPathMappingError | 自定义域名已使用默认路径映射，不支持设置自定义路径。 |
| FailedOperation.SubDomainFormatError | 自定义域名格式错误。 |
| FailedOperation.TagBindServiceError | 标签绑定服务失败。 |
| FailedOperation.TaskAlreadyExist | 迁移任务重复 |
| FailedOperation.UnknownProtocolTypeError | 协议类型错误。 |
| InternalError.ApigwException | API网关内部请求错误，请稍后重试。若无法解决，请联系智能客服或提交工单。 |
| InternalError.CamException | CAM内部请求错误，请稍后重试。若无法解决，请联系智能客服或提交工单。 |
| InternalError.CauthException | CAuth内部请求错误，请稍后重试。若无法解决，请联系智能客服或提交工单。 |
| InternalError.ClbException | CLB内部请求错误，请稍后重试。若无法解决，请联系智能客服或提交工单。 |
| InternalError.DbException | 数据库操作失败，请稍后重试。若无法解决，请联系智能客服或提交工单。 |
| InternalError.OssException | oss内部请求错误，请稍后重试。若无法解决，请联系智能客服或提交工单。 |
| InternalError.ReturnableException | 标签回调失败。 |
| InternalError.ScfException | SCF内部请求错误，请稍后重试。若无法解决，请联系智能客服或提交工单。 |
| InternalError.TsfException | TSF内部请求错误，请稍后重试。若无法解决，请联系智能客服或提交工单。 |
| InternalError.VpcException | vpc内部请求错误，请稍后重试。若无法解决，请联系智能客服或提交工单。 |
| InvalidParameter.BasicServiceNotAllowAttachPlugin | 基础版服务不能绑定插件。 |
| InvalidParameter.DuplicatePluginConfig | 当前绑定插件和已有插件冲突。 |
| InvalidParameter.FormatError | 参数格式错误。 |
| InvalidParameterValue.DuplicatePluginConfig | 插件定义参数取值重复，请修改后重新操作。 |
| InvalidParameterValue.IllegalProxyIp | 非法的后端ip地址。 |
| InvalidParameterValue.InvalidAccessKeyIds | 密钥错误。 |
| InvalidParameterValue.InvalidApiBusinessType | 传入的Api业务类型必须为OAUTH。 |
| InvalidParameterValue.InvalidApiIds | API Id错误。 |
| InvalidParameterValue.InvalidApiRequestConfig | 无效的API配置。 |
| InvalidParameterValue.InvalidApiType | API类型错误，微服务API只支持TSF后端服务类型。 |
| InvalidParameterValue.InvalidBackendPath | 后端服务路径配置错误。 |
| InvalidParameterValue.InvalidClb | 不合法的clb。 |
| InvalidParameterValue.InvalidCondition | 策略错误。 |
| InvalidParameterValue.InvalidConstantParameters | 不合法的常量参数。 |
| InvalidParameterValue.InvalidEnv | 参数Env取值错误，取值范围为（release, prepub, test）。 |
| InvalidParameterValue.InvalidEnvStatus | 服务当前环境状态，不支持此操作。 |
| InvalidParameterValue.InvalidFilterNotSupportedName | 参数取值错误。 |
| InvalidParameterValue.InvalidIPAddress | 参数后端地址取值错误。 |
| InvalidParameterValue.InvalidMaxRequestNum | 参数请求配额总数取值错误。 |
| InvalidParameterValue.InvalidMethod | 方法错误。仅支持 ANY, BEGIN, GET, POST, DELETE, HEAD, PUT, OPTIONS, TRACE, PATCH，请修改后重新操作。 |
| InvalidParameterValue.InvalidPluginConfig | 插件定义参数取值错误，请修改后重新操作。 |
| InvalidParameterValue.InvalidPort | 后端服务端口错误。 |
| InvalidParameterValue.InvalidProcotol | 无效的协议类型参数。 |
| InvalidParameterValue.InvalidPublicKey | OAUTH2.0 API 公钥参数格式错误。 |
| InvalidParameterValue.InvalidRegion | 地域错误。 |
| InvalidParameterValue.InvalidRequestParameters | 不合法的请求参数。 |
| InvalidParameterValue.InvalidScfConfig | SCF类型API参数错误。 |
| InvalidParameterValue.InvalidServiceConfig | 不合法的服务配置。 |
| InvalidParameterValue.InvalidServiceMockReturnMessage | 参数ServiceMockReturnMessage错误。 |
| InvalidParameterValue.InvalidServiceParam | 参数配置错误，未配置在后端参数配置列表中。 |
| InvalidParameterValue.InvalidServiceParameters | 参数ServiceParameters错误。 |
| InvalidParameterValue.InvalidServiceType | 后端服务类型错误。WEBSOCKET类型的后端服务，前端协议需要配置为WEBSOCKET。 |
| InvalidParameterValue.InvalidTagValues | 标签参数错误。 |
| InvalidParameterValue.InvalidTsfConfig | TSF类型API配置错误。 |
| InvalidParameterValue.InvalidUpstream | 当前后端通道不存在或者是无效状态。 |
| InvalidParameterValue.InvalidUrl | URL参数错误。 |
| InvalidParameterValue.InvalidVpcConfig | 无效vpc信息。 |
| InvalidParameterValue.InvalidWSMethod | 方法错误。WEBSOCKET类型的后端服务，前端方法需要配置为GET。 |
| InvalidParameterValue.LengthExceeded | 参数的长度超出限制。 |
| InvalidParameterValue.LimitExceeded | 参数个数超出限制，上限为100。 |
| InvalidParameterValue.NotInOptions | 参数取值错误。当前值不在可选范围内。 |
| InvalidParameterValue.NothingModifyForOauth | OAuth接口无可用修改项。 |
| InvalidParameterValue.ParameterNotMatch | 后端参数配置错误，未配置相关前端参数。 |
| InvalidParameterValue.ParameterValueLimitExceeded | 参数个数超过限制。 |
| InvalidParameterValue.RangeExceeded | 参数取值错误，不在参数范围内。 |
| InvalidParameterValue.TrafficControl | 无效的参数值 |
| InvalidParameterValue.UnsupportedParameter | 参数取值错误。 |
| LimitExceeded.APIDocLimitExceeded | API文档数量超出限制。 |
| LimitExceeded.AccessKeyCountInUsagePlanLimitExceeded | 访问密钥数量超出限制。 |
| LimitExceeded.ApiAppCountLimitExceeded | 服务绑定的应用数量超过限制。 |
| LimitExceeded.ApiCountLimitExceeded | API数量超过限制。 |
| LimitExceeded.ApiKeyCountLimitExceeded | 密钥数量超出限制。 |
| LimitExceeded.ExceededDefineMappingLimit | 自定义路径映射，最多三组。 |
| LimitExceeded.ExceededDomainLimit | 绑定域名数量超出限制，默认最多5个。 |
| LimitExceeded.IpStrategyLimitExceeded | IP策略数量超出限制。 |
| LimitExceeded.RequestLimitExceeded | 请求频率超限制，请稍等再试。 |
| LimitExceeded.ServiceCountForPluginLimitExceeded | 插件绑定的服务数量超出限制，请解绑服务或提升限额后重试。 |
| LimitExceeded.ServiceCountLimitExceeded | 服务数量超过限制，请删除服务或提升限额后重试。 |
| LimitExceeded.UsagePlanLimitExceeded | 使用计划数量超出限制。 |
| MissingParameter.BackendSpecificParam | 缺少后端服务参数。 |
| MissingParameter.PluginConfig | 插件缺少参数，请按规则重新操作。 |
| OperationDenied | 操作被拒绝。 |
| ResourceNotFound.InvalidAccessKeyId | 密钥不存在。 |
| ResourceNotFound.InvalidApi | ApiId错误。 |
| ResourceNotFound.InvalidApiApp | 应用ID错误。 |
| ResourceNotFound.InvalidApiDoc | API文档不存在。 |
| ResourceNotFound.InvalidIPStrategy | IP策略不存在。 |
| ResourceNotFound.InvalidOauthApi | OAuth业务API错误。 |
| ResourceNotFound.InvalidPlugin | 插件不存在。 |
| ResourceNotFound.InvalidService | 对应服务不可见。 |
| ResourceNotFound.InvalidUsagePlan | 使用计划不存在。 |
| ResourcesSoldOut | 资源售罄。 |
| UnauthorizedOperation.AccessResource | 您没有权限访问资源。 |
| UnauthorizedOperation.UncertifiedUser | 用户未实名制。 |
| UnsupportedOperation.AccountArrears | 账号余额不足 |
| UnsupportedOperation.AlreadyBindUsagePlan | 密钥已绑定使用计划。 |
| UnsupportedOperation.ApiListNotEmpty | API列表不为空 |
| UnsupportedOperation.AttachPlugin | 当前插件不支持绑定。 |
| UnsupportedOperation.BasicServiceNoMoreApi | 基础版服务不能创建超过一个API。 |
| UnsupportedOperation.BasicServiceNotAllowAttachPlugin | 基础服务不允许连接插件 |
| UnsupportedOperation.ClsSearchTime | 日志检索起始时间间隔。 |
| UnsupportedOperation.ExistingOnlineEnvironment | 存在现网环境 |
| UnsupportedOperation.ForceHttps | 协议为HTTP时，不支持强制Https。 |
| UnsupportedOperation.InvalidAction | 接口错误。 |
| UnsupportedOperation.InvalidEndpointType | 不支持后端类型。 |
| UnsupportedOperation.InvalidInstanceState | 当前实例状态，不支持当前操作。 |
| UnsupportedOperation.InvalidServiceTrade | 当前服务处于隔离中，暂不支持此操作。 |
| UnsupportedOperation.InvalidStatus | 当前密钥状态不支持此操作。 |
| UnsupportedOperation.ModifyEIAMAuthApi | 不支持修改EIAM类型授权API。 |
| UnsupportedOperation.ModifyNetType | 网络类型不支持修改。 |
| UnsupportedOperation.ModifyProtocol | 前端协议类型不支持修改。 |
| UnsupportedOperation.NoUsagePlanEnv | 当前使用计划未绑定环境。 |
| UnsupportedOperation.ReduceNetTypes | 不支持减少网络类型的操作。 |
| UnsupportedOperation.RequestPostError | 请求Post失败 |
| UnsupportedOperation.ResourceAssociated | 资源已关联，请先解除。 |
| UnsupportedOperation.ResourceIsInUse | 密钥已绑定使用计划，请先解绑再试。 |
| UnsupportedOperation.ResourceUnassociated | 资源未关联。 |
| UnsupportedOperation.ServiceExist | 服务不存在 |
| UnsupportedOperation.TagsNotEmpty | 标签不为空 |
| UnsupportedOperation.UinNotInWhiteList | 当前Uin未在手工密钥白名单列表内。 |
| UnsupportedOperation.UnpackError | Unpack函数错误 |
| UnsupportedOperation.UnsupportedBindApiKey | 密钥已绑定使用计划。 |
| UnsupportedOperation.UnsupportedBindEnvironment | 不支持绑定环境。 |
| UnsupportedOperation.UnsupportedDeleteApi | 当前API已绑定业务API，请先解绑再试。 |
| UnsupportedOperation.UnsupportedDeleteService | 服务使用中，不能被删除。 |
| UnsupportedOperation.UnsupportedDeleteUpstream | 当前VPC通道存在绑定关系，不支持当前操作。 |
| UnsupportedOperation.UnsupportedNetType | 不支持网络类型。 |
| UnsupportedOperation.UnsupportedUnBindEnvironment | 不支持解绑环境，存在未绑定使用计划的API。 |
| UnsupportedOperation.UnsupportedUpdateApiKey | 当前密钥状态不支持此操作。 |
| UnsupportedOperation.UsagePlanInUse | 当前使用计划在使用中，请先解绑再试。 |
