文档中心>API 中心

错误码

最近更新时间:2024-03-06 01:24:38

我的收藏

功能说明

如果返回结果中存在 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 接口不支持所传地域。

业务错误码

错误码 说明
FailedOperation.CallTrade 调用交易服务发生异常。
FailedOperation.CmqBackendError CMQ 后台服务错误。
FailedOperation.CreateCluster 创建集群失败。
FailedOperation.CreateEnvironment 环境创建失败。
FailedOperation.CreateEnvironmentRole 创建环境角色失败。
FailedOperation.CreateNamespace 创建命名空间失败。
FailedOperation.CreateProducerError 创建producer出错。
FailedOperation.CreatePulsarClientError 创建TDMQ client的出错。
FailedOperation.CreateRole 角色创建失败。
FailedOperation.CreateSecretKey 创建密钥失败。
FailedOperation.CreateSubscription 创建订阅关系失败。
FailedOperation.CreateTopic 主题创建失败。
FailedOperation.DeleteCluster 删除集群失败。
FailedOperation.DeleteEnvironmentRoles 删除环境角色失败。
FailedOperation.DeleteEnvironments 环境删除失败。
FailedOperation.DeleteNamespace 删除命名空间失败。
FailedOperation.DeleteRoles 角色删除失败。
FailedOperation.DeleteSubscriptions 删除订阅关系失败。
FailedOperation.DeleteTopics 主题删除失败。
FailedOperation.DescribeSubscription 查询订阅数据失败。
FailedOperation.GetEnvironmentAttributesFailed 获取环境属性失败。
FailedOperation.GetTopicPartitionsFailed 获取主题分区数失败。
FailedOperation.InstanceNotReady 实例尚未就绪,请稍后再试。
FailedOperation.MaxMessageSizeError 最大消息超过1MB。
FailedOperation.MessageIDError 上传的msgID错误。
FailedOperation.NamespaceInUse 必须先清除关联命名空间才能继续操作。
FailedOperation.PulsarAdminError PulsarAdminClient错误。
FailedOperation.ReceiveError 接收消息出错。
FailedOperation.ReceiveTimeout 接收消息超时,请重试。
FailedOperation.ResetMsgSubOffsetByTimestampFailed 消息回溯设置失败。
FailedOperation.RoleInUse 必须先清除关联角色数据才能继续操作。
FailedOperation.SaveSecretKey 保存密钥失败。
FailedOperation.SendMessageTimeoutError 消息发送超时。
FailedOperation.SendMsgFailed 发送消息失败。
FailedOperation.SetRetentionPolicy 设置消息保留策略失败。
FailedOperation.SetTTL 设置消息TTL失败。
FailedOperation.TopicInUse 必须先清除关联主题数据才能继续操作。
FailedOperation.TopicTypeError 请使用partition topic。
FailedOperation.UpdateEnvironment 环境更新失败。
FailedOperation.UpdateEnvironmentRole 更新环境角色失败。
FailedOperation.UpdateRole 角色更新失败。
FailedOperation.UpdateTopic 主题更新失败。
FailedOperation.VpcInUse 必须先清除关联VPC路由数据才能继续操作。
InternalError.BrokerService Broker服务异常。
InternalError.FailedOperation 操作失败。
InternalError.GetAttributesFailed 获取属性失败。
InternalError.IllegalMessage 内部错误。
InternalError.Retry 重试可以成功。
InternalError.SystemError 系统错误。
InvalidParameter.InvalidAdminUrl 无效的管理端接口地址。
InvalidParameter.Partition 错误的分区数。
InvalidParameter.TenantNotFound 上传的 tenant name 错误。
InvalidParameter.TokenNotFound 没有获取到正确的 token。
InvalidParameterValue.AtLeastOne 至少需要提供一个参数。
InvalidParameterValue.ClusterNameDuplication 与现有集群名称重复。
InvalidParameterValue.InvalidParams 参数值不在允许范围内。
InvalidParameterValue.NeedMoreParams 必要参数没有传递。
InvalidParameterValue.TTL 无效的消息TTL值。
InvalidParameterValue.TopicNotFound 上传的topic name错误。
LimitExceeded.Clusters 实例下集群数量超过限制。
LimitExceeded.Environments 实例下环境数量超过限制。
LimitExceeded.Namespaces 实例下命名空间数量超过限额。
LimitExceeded.RetentionSize 超过剩余额度,请重新调整。
LimitExceeded.RetentionTime 超过保留时间限制,请重新调整。
LimitExceeded.Subscriptions 实例下订阅者数量超过限制。
LimitExceeded.Topics 实例下主题数量超过限制。
MissingParameter.NeedMoreParams 必要参数没有传递。
OperationDenied.ConsumerRunning 订阅仍在消费中。
OperationDenied.DefaultEnvironment 默认环境不允许操作。
ResourceInUse.Cluster 集群已存在。
ResourceInUse.EnvironmentRole 环境角色已存在。
ResourceInUse.Namespace 重名,命名空间已存在。
ResourceInUse.Queue 队列已存在。
ResourceInUse.Role 角色已存在。
ResourceInUse.Subscription 重名,订阅关系已存在。
ResourceInUse.Topic 重名,主题已存在。
ResourceNotFound.BrokerCluster 服务的集群不存在。
ResourceNotFound.Cluster 集群不存在。
ResourceNotFound.Environment 环境不存在。
ResourceNotFound.EnvironmentRole 环境角色不存在。
ResourceNotFound.Instance 实例不存在。
ResourceNotFound.MigrationTask 迁移任务不存在。
ResourceNotFound.Msg 找不到指定消息。
ResourceNotFound.MsgProduceLog 消息生产日志不存在。
ResourceNotFound.Namespace 命名空间不存在。
ResourceNotFound.Role 角色不存在。
ResourceNotFound.Subscription 订阅关系不存在。
ResourceNotFound.Topic 主题不存在。
ResourceUnavailable.CreateFailed 发货异常。
ResourceUnavailable.FundRequired 需要充值才可继续操作。
ResourceUnavailable.SystemUpgrade 系统升级。
ResourcesSoldOut 资源售罄。
UnsupportedOperation.InstanceDowngrade 该实例不支持降配操作。