功能说明
如果返回结果中存在 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.AccountIsolated | 操作失败,账号已欠费隔离。 |
FailedOperation.AlreadyDistributionDevice | 已分发设备,不能再次创建。 |
FailedOperation.BindDeviceOverLimit | 绑定设备超过限制。 |
FailedOperation.BindDevicePerOnceOverLimit | 单次绑定的设备数量超过限制。 |
FailedOperation.BroadcastTaskIsRunning | 广播任务正在执行。 |
FailedOperation.DeviceAlreadyDisabled | 设备已经被禁用。 |
FailedOperation.DeviceFirmwareTaskAlreadDone | 设备固件升级任务已经完成。 |
FailedOperation.DeviceIsUpdating | 设备正在升级中。 |
FailedOperation.DeviceNoSubscription | 设备没有订阅相应的topic。 |
FailedOperation.DeviceOffline | 设备离线。 |
FailedOperation.DeviceRunningOtherOtaTask | 设备已经运行其他ota升级任务。 |
FailedOperation.DuplicationOfFunctionItem | 不能创建重复的函数。 |
FailedOperation.FunctionFileNotExist | 函数文件不存在。 |
FailedOperation.InvalidMsgLen | 消息长度非法。 |
FailedOperation.InvalidTopicName | 消息topic非法。 |
FailedOperation.ProductNotBind | 产品未绑定,无法代理订阅。 |
FailedOperation.ProductResourceDuplicate | 同名产品资源已存在。 |
FailedOperation.ProxyIPIsNotEnough | 代理ip或端口资源不足。 |
FailedOperation.RRPCTimeout | RRPC接口未收到设备端响应。 |
FailedOperation.ResourceFileNotMatch | 资源文件MD5或者大小不一致。 |
FailedOperation.RuleAlreadyDisabled | 该规则引擎已经是禁用状态,不需要再被禁用。 |
FailedOperation.RuleAlreadyEnabled | 规则已经是启用状态。 |
FailedOperation.TidWhiteListNotOpen | 白名单校验未开启,用户不可创建设备,平台会根据设备认证时携带的设备名称自动创建设备。 |
FailedOperation.UpdateVersionNotMatch | 更新版本不匹配。 |
InternalError.DBOperationError | 数据库内部错误。 |
InvalidParameterValue.ActionNil | 规则行为未配置。 |
InvalidParameterValue.CACertInvalid | CA证书内容错误。 |
InvalidParameterValue.CACertNotMatch | CA验证证书不匹配。 |
InvalidParameterValue.CheckForwardURLFail | 检查第三方URL超时或失败。 |
InvalidParameterValue.CloudComponentAlreadyExist | 保存失败,行为操作和转发错误行为数据目标不可一致。 |
InvalidParameterValue.DefinedPskNotBase64 | 格式错误,DefinedPsk需为Base64格式的字符串。 |
InvalidParameterValue.DeviceAlreadyExist | 创建的设备名已存在。 |
InvalidParameterValue.DeviceIsNotGateway | 设备不是网关类型。 |
InvalidParameterValue.FailActionHasSameDevice | 存失败,行为操作和转发错误行为数据目标不可为同一设备。 |
InvalidParameterValue.FirmwareAlreadyExist | 固件已存在。 |
InvalidParameterValue.ForwardRedirectDenied | 不允许转发重定向。 |
InvalidParameterValue.InvalidJSON | JSON参数非法。 |
InvalidParameterValue.InvalidSQL | SQL语句含有非法字符。 |
InvalidParameterValue.JSONHasInvalidNode | State JSON对象中包含非法节点。 |
InvalidParameterValue.JSONSizeExceedLimit | State JSON对象超过大小限制,最大为 8k。 |
InvalidParameterValue.NotMergeAble | 不可合并。 |
InvalidParameterValue.OperationDenied | 修改规则的操作被禁止。 |
InvalidParameterValue.ParamIncomplete | 请求中缺少关键字段信息。 |
InvalidParameterValue.PayloadOverLimit | 消息Payload超出限制。 |
InvalidParameterValue.PrefixInvalid | prefix不合法。 |
InvalidParameterValue.ProductAlreadyExist | 创建的产品名已存在。 |
InvalidParameterValue.ProductTypeNotSupport | 产品类型不支持。 |
InvalidParameterValue.RepublishTopicFormatError | 转发的topic格式错误。 |
InvalidParameterValue.RuleNumberBeyondLimit | 规则数量超过限制。 |
InvalidParameterValue.TidProductAlreadyExist | 该TID产品已存在。 |
InvalidParameterValue.TopicPolicyAlreadyExist | Topic已存在。 |
InvalidParameterValue.TopicRuleAlreadyExist | 规则已存在。 |
InvalidParameterValue.TopicRuleSqlNotEdited | 规则sql未编辑。 |
InvalidParameterValue.UpdateTopicRuleDBFail | 请确认规则相关数据是否有更新。 |
LimitExceeded.CAAlreadyBindProduct | CA证书已经绑定了产品,无法操作。 |
LimitExceeded.CACertLimit | CA证书达到上限。 |
LimitExceeded.CACertNameRepeat | CA证书名称重复。 |
LimitExceeded.CACertNotSupport | 不支持私有证书操作。 |
LimitExceeded.CARepeat | CA证书重复。 |
LimitExceeded.DeviceExceedLimit | 设备数量超过限制。 |
LimitExceeded.FirmwareExceedLimit | 固件数量超出限制。 |
LimitExceeded.MessageSaved | 消息已经保存到离线队列。 |
LimitExceeded.OfflineMessageExceedLimit | qos为1的离线消息超过数量限制。 |
LimitExceeded.ProductExceedLimit | 超过产品数量限制。 |
LimitExceeded.TopicPolicyExceedLimit | Topic数量超出限制。 |
OperationDenied.GetTDMQProInternalEndpointFail | TDMQ缺少内网接入点,无法转发,请咨询TDMQ产品 |
ResourceNotFound.CACertNotExist | CA证书不存在。 |
ResourceNotFound.CreateMultiDeviceTaskNotExist | 批量创建设备任务不存在。 |
ResourceNotFound.DeviceFirmwareTaskNotExist | 设备固件升级任务不存在。 |
ResourceNotFound.DeviceHasNoFirmware | 设备无固件版本。 |
ResourceNotFound.DeviceNotExist | 设备不存在。 |
ResourceNotFound.DeviceResourceNotExist | 设备资源不存在。 |
ResourceNotFound.DeviceShadowNotExist | 设备影子不存在。 |
ResourceNotFound.FirmwareNotExist | 固件不存在。 |
ResourceNotFound.FirmwareTaskNotExist | 固件升级任务不存在。 |
ResourceNotFound.ProductNotExist | 产品不存在。 |
ResourceNotFound.ProductOrDeviceNotExist | 用户不存在此产品或设备。 |
ResourceNotFound.ProductResourceNotExist | 产品资源不存在。 |
ResourceNotFound.ResourceFileNotExist | 资源文件不存在。 |
ResourceNotFound.TaskNotExist | 任务不存在。 |
ResourceNotFound.ThingModelNotExist | 物模型不存在。 |
ResourceNotFound.TopicPolicyNotExist | Topic不存在。 |
ResourceNotFound.TopicRuleNotExist | 规则不存在。 |
UnauthorizedOperation.DeleteTidFail | 该产品已存在TID申请,禁止删除。 |
UnauthorizedOperation.DeviceHasAlreadyBindGateway | 该设备绑定了网关设备,无法删除。 |
UnauthorizedOperation.DeviceIsNotEnabled | 设备未启用。 |
UnauthorizedOperation.DevicesExistUnderProduct | 删除的产品下还包括未删除的设备。 |
UnauthorizedOperation.GatewayHasBindedDevices | 该设备下仍有绑定的设备。 |
UnauthorizedOperation.PermissionDenied | 没有权限。 |
UnauthorizedOperation.ProductCantHaveLoRaDevice | 该产品类型不能创建LoRa设备。 |
UnauthorizedOperation.ProductCantHaveNormalDevice | NB-IoT产品不允许创建普通设备。 |
UnauthorizedOperation.ProductCantHaveNotLoRaDevice | 该产品类型只能创建LoRa设备。 |
UnauthorizedOperation.ProductIsForbidden | 产品禁用了该功能。 |
UnauthorizedOperation.ProductNotSupportPSK | 产品不支持密钥认证。 |
UnauthorizedOperation.UserNotAuthenticaed | 用户未通过实名认证。 |
UnsupportedOperation.ClientCertAlreadyGot | 设备私钥已被获取。 |
UnsupportedOperation.DeviceOtaTaskInProgress | 设备ota升级中。 |
UnsupportedOperation.GatewayProductHasBindedProduct | 网关产品下存在绑定的子产品,无法删除。 |
UnsupportedOperation.ProductHasBindGateway | 存在网关设备绑定当前产品,无法删除。 |
UnsupportedOperation.ProductHasBindedGatewayProduct | 产品存在绑定的网关产品,无法删除。 |
UnsupportedOperation.SuiteTokenNoCreate | 产品为Suite token类型,无法创建新设备。 |
UnsupportedOperation.WrongProductAuthType | 不支持的认证类型。 |