功能说明
如果返回结果中存在 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.ApiAuthorizationNotFound | 未找到此应用该api授权信息 |
| AuthFailure.TokenExpired | token已过期,请重新申请 |
| AuthFailure.TokenNotFound | 未找到该token信息 |
| FailedOperation.ApiRuleConfigError | Api规则配置信息错误 |
| FailedOperation.DBError | 操作DB失败 |
| FailedOperation.GetTagsFailed | 获取标签错误 |
| FailedOperation.LockRedisCacheFailed | 锁定Redis缓存错误 |
| FailedOperation.ModifyDeviceError | 修改设备信息失败 |
| FailedOperation.RedisOperationFailed | redis操作错误 |
| FailedOperation.SendMsgError | 消息发送错误 |
| FailedOperation.SendMsgToIOTFailed | 向IOT服务发送消息失败 |
| FailedOperation.StorageInitFailed | 对象存储 - 初始化失败 |
| FailedOperation.URLGenerateFailed | 对象存储 - url生成失败 |
| InternalError.ApiGatewayInternalError | API网关内部错误 |
| InternalError.ApiRequestPathParameterError | 该api访问路径匹配参数异常,请检查请求路径 |
| InternalError.AppApiNoSpacePermission | 该应用未关联该项目空间数据,无法获取该项目空间数据 |
| InternalError.BIMAppInternalError | BIM服务内部错误 |
| InternalError.BusinessLogicError | 业务逻辑错误 |
| InternalError.ManagerSrvFailed | manager服务操作失败 |
| InternalError.Timeout | 超时 |
| InternalError.UnknownError | 未知错误 |
| InternalError.UpdateParkInfoFailed | 更新工作空间下园区信息错误 |
| InvalidParameter.DuplicateParkCode | 园区编码重复 |
| InvalidParameter.ExceedParkLengthLimit | 园区名字或园区编码长度超过50字符 |
| InvalidParameter.InvalidAlarmContent | 告警content无效 |
| InvalidParameter.InvalidMediaData | 错误的媒体数据 |
| InvalidParameter.InvalidMetaData | 错误的Meta数据,无法构建握手参数 |
| InvalidParameter.InvalidRequestTime | 请求时间非法 |
| InvalidParameter.ParamNotMatch | 参数不匹配 |
| InvalidParameter.StatusNotMatchProcessType | 状态与处理类型不符 |
| InvalidParameter.TokenFieldNotFound | 未找到token字段 |
| InvalidParameterValue.EmptyAdministrativeCode | 行政区编码长度为0 |
| InvalidParameterValue.InvalidAlarmStatus | 告警状态无效 |
| InvalidParameterValue.InvalidApplicationId | 应用id非法 |
| InvalidParameterValue.InvalidElementIdOrProjectId | 项目id或构件id取值错误 |
| InvalidParameterValue.InvalidGB28181Config | 网络视频录像机GB28181协议错误 |
| InvalidParameterValue.InvalidNonce | 申请应用token时,传递的nonce参数非法 |
| InvalidParameterValue.InvalidProtocol | 非法protocol协议参数 |
| InvalidParameterValue.InvalidRequestTime | 请求时间非法 |
| InvalidParameterValue.InvalidSaveType | 保存类型参数错误 |
| InvalidParameterValue.InvalidSignature | 签名非法 |
| InvalidParameterValue.InvalidStreamId | 非法StreamId,StreamId仅支持0或1 |
| InvalidParameterValue.InvalidTenantId | metadata租户信息无效 |
| InvalidParameterValue.InvalidTimeRange | 时间范围参数错误 |
| InvalidParameterValue.InvalidVideoPlayRate | 播放速率错误,需要等于0.5、1、1.5、2、4、8或16 |
| InvalidParameterValue.InvalidWorkspaceId | 错误的工作空间Id |
| LimitExceeded.ApiLimitExceeded | api接口批量最大个数超限 |
| LimitExceeded.DeviceLimitExceeded | 设备数量超过限制 |
| LimitExceeded.VideoStreamThresholdExceeded | 视频流超过阈值 |
| LimitExceeded.VideoTranscode | 视频转码超出阈值 |
| MissingParameter.EmptyAlarmId | 告警id为空 |
| MissingParameter.EmptyStream | stream参数缺失 |
| MissingParameter.EmptyWID | WID参数缺失 |
| OperationDenied.ApiPermissionDenied | Api没有操作权限 |
| ResourceNotFound.AlarmIDNotFound | 告警id找不到 |
| ResourceNotFound.AlarmIdNotExist | 告警id不存在 |
| ResourceNotFound.CameraBaseInfoNotExist | 摄像头基础信息不存在 |
| ResourceNotFound.CameraInfoNotExist | 摄像头信息不存在 |
| ResourceNotFound.CameraStatusNotExist | 摄像头状态不存在 |
| ResourceNotFound.ElementNotFound | 未查询到构件信息 |
| ResourceNotFound.EmptyDeviceList | 空设备列表 |
| ResourceNotFound.NVROrCVRConfigNotExist | 网络视频录像机或中心级视频网络存储设备相关配置信息缺失 |
| ResourceNotFound.SRSHookServiceNode | srs_hook服务节点缺失 |
| ResourceNotFound.SRSNotExist | 该deviceId的srs信息缺失 |
| ResourceNotFound.StreamNotExist | 视频流缺失 |
| ResourceNotFound.VideoPushServiceNode | VideoPush服务节点缺失 |
| ResourceNotFound.WIDNotExist | 设备WId不存在 |
| ResourceUnavailable.DeviceOffline | 设备已离线 |
| UnauthorizedOperation.APIAuthFailed | wId 未找到或被应用api未被授权 |
| UnauthorizedOperation.UnauthorizedApi | 应用api的数据授权未配置,请先配置权限 |
| UnsupportedOperation.NotStreaming | 未推流 |
| UnsupportedOperation.UnsupportedCMD | 不支持的控制指令 |