功能说明
如果返回结果中存在 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.AITaskStatusIsOff | AI任务状态已经是Off |
| FailedOperation.AITaskStatusIsOn | 不允许删除或更改状态为On的AI任务 |
| FailedOperation.DatabaseError | 数据库错误 |
| FailedOperation.DeviceResponseTimeOut | 设备响应超时 |
| FailedOperation.DeviceResultTimeOut | 设备端结果响应超时 |
| FailedOperation.NotHaveSubUser | 没有该子用户 |
| FailedOperation.RequestTimeout | 请求超时 |
| InternalError.ServerInternalError | 服务器内部错误 |
| InvalidParameter.DownloadUrlError | 非法的下载URL |
| InvalidParameter.DownloadUrlHasExpired | 下载URL已过期 |
| InvalidParameter.InvalidAction | 操作类型不合法 |
| InvalidParameter.InvalidBodyFormat | 无效的消息体格式 |
| InvalidParameter.InvalidChannels | 无效的通道参数 |
| InvalidParameter.InvalidLifeRuleParam | 无效的生命周期参数 |
| InvalidParameter.InvalidOrganizationParam | 无效的组织参数 |
| InvalidParameter.InvalidParameter | 无效的输入参数 |
| InvalidParameter.InvalidParameterFormat | 参数格式不对或缺少参数 |
| InvalidParameter.InvalidTimeSection | 无效的时间片段 |
| InvalidParameter.RequiredHeaderParameterEmpty | 必要请求头参数不能为空 |
| InvalidParameter.TaskIdNotExist | TaskId不存在 |
| InvalidParameterValue.BakTimeNotEnough | 存在不满足(上云时间段=前一天的录像时间段/上云倍速)的设定,请检查并确认 |
| InvalidParameterValue.CallbackURLContainIllegalCharacter | CallbackURL包含特殊字符 |
| InvalidParameterValue.ChannelIdAlreadyExistsInOtherAITasks | 包含已存在其他AI任务的ChannelId |
| InvalidParameterValue.ChannelIdMustBeNotEmpty | ChannelId不能为空 |
| InvalidParameterValue.ChannelListContainIllegalCharacter | ChannelList包含特殊字符 |
| InvalidParameterValue.ChannelListMustBeNotEmpty | ChannelList不能为空 |
| InvalidParameterValue.ChannelNumberMustBeLessThanOneThousand | ChannelList的数量必须小于1000 |
| InvalidParameterValue.ChannelsExceedsRange | 通道数量超过限制范围 |
| InvalidParameterValue.ContainInvalidChannelId | 包含无效的ChannelId |
| InvalidParameterValue.ContainInvalidDeviceId | 包含无效的设备ID |
| InvalidParameterValue.DataOutOfRange | 周期超出限制(1-7) |
| InvalidParameterValue.DeviceMismatchChannel | 设备ID和通道ID不匹配 |
| InvalidParameterValue.EmptyChannelId | 通道ID不能为空 |
| InvalidParameterValue.EmptyDeviceId | 设备ID不能为空 |
| InvalidParameterValue.EmptyName | 名称不能为空 |
| InvalidParameterValue.EmptyOrganizationId | 组织ID不能为空 |
| InvalidParameterValue.EmptyTemplateId | 关联模板不能为空 |
| InvalidParameterValue.EndTimeZero | 结束时间不能为空 |
| InvalidParameterValue.HasDuplicateOperTimeSlot | OperTimeSlot值有重复 |
| InvalidParameterValue.IllegalChannelId | 通道ID包含了非法字符 |
| InvalidParameterValue.IllegalDescribe | 描述中包含不符合要求的字符(仅支持中文、英文、数字、_、-) |
| InvalidParameterValue.IllegalDeviceId | 设备ID包含了非法字符 |
| InvalidParameterValue.IllegalName | 名称中包含不符合要求的字符(仅支持中文、英文、数字、_、-) |
| InvalidParameterValue.IllegalOrganizationId | 组织ID包含了非法字符 |
| InvalidParameterValue.IllegalStreamType | 码流类型包含非法字符(仅支持英文、数字、_、-) |
| InvalidParameterValue.InvalidAITaskDesc | 无效的AI任务描述信息 |
| InvalidParameterValue.InvalidAITaskID | 无效的AI任务ID |
| InvalidParameterValue.InvalidAITaskName | 无效的AI任务名称 |
| InvalidParameterValue.InvalidAITaskStatus | 无效的AI任务状态 |
| InvalidParameterValue.InvalidAccessProtocol | 无效的设备接入协议 |
| InvalidParameterValue.InvalidBeginAndEndTime | 无效的开始或结束时间 |
| InvalidParameterValue.InvalidBeginTime | 无效的开始时间 |
| InvalidParameterValue.InvalidChannelId | 无效的通道ID |
| InvalidParameterValue.InvalidChannelIdOrDeviceId | 包含无效的通道ID或者设备ID |
| InvalidParameterValue.InvalidChannelName | 通道名称为空或填写有误 |
| InvalidParameterValue.InvalidClusterId | 无效的集群ID,长度或内容不符合规则 |
| InvalidParameterValue.InvalidDescription | 描述填写有误 |
| InvalidParameterValue.InvalidDetectType | 无效的AI分析类型 |
| InvalidParameterValue.InvalidDeviceId | 无效的设备ID |
| InvalidParameterValue.InvalidDeviceName | 设备名称为空或填写有误 |
| InvalidParameterValue.InvalidDevicePasswordLength | 设备密码长度应当大于1位并且小于64位 |
| InvalidParameterValue.InvalidDeviceStatus | 无效的设备状态 |
| InvalidParameterValue.InvalidDeviceType | 无效的设备类型 |
| InvalidParameterValue.InvalidDomainType | 无效的域名类型参数 |
| InvalidParameterValue.InvalidEnalbeValue | 无效的使能参数 |
| InvalidParameterValue.InvalidEndTime | 无效的结束时间 |
| InvalidParameterValue.InvalidExpiration | 无效的副本有效期,范围是1-365天 |
| InvalidParameterValue.InvalidExpirationRange | 冷存储至少60天, 并且热存储和冷存储总天数不能超过3650天 |
| InvalidParameterValue.InvalidFileType | 无效的文件格式 |
| InvalidParameterValue.InvalidGatewayId | 无效的网关ID,长度或内容不符合规则 |
| InvalidParameterValue.InvalidGatewayProtocolType | 无效的网关接入协议 |
| InvalidParameterValue.InvalidIpv4 | 无效的Ipv4地址 |
| InvalidParameterValue.InvalidKeyword | 无效的关键字 |
| InvalidParameterValue.InvalidName | 名称为空或填写有误 |
| InvalidParameterValue.InvalidOperTimeSlotFormat | 无效的OperTimeSlot格式 |
| InvalidParameterValue.InvalidOrgName | 组织名称为空或填写有误 |
| InvalidParameterValue.InvalidOrganizationId | 无效的组织ID |
| InvalidParameterValue.InvalidPageNumber | 无效的PageNumber |
| InvalidParameterValue.InvalidPageParameter | 页参数取值错误 |
| InvalidParameterValue.InvalidPageSize | 无效的PageSize |
| InvalidParameterValue.InvalidPlanId | 无效的计划ID |
| InvalidParameterValue.InvalidPullState | 无效的拉流鉴权开关值 |
| InvalidParameterValue.InvalidPushState | 无效的推流鉴权开关值 |
| InvalidParameterValue.InvalidRTMPAppName | 无效的RTMP推流AppName |
| InvalidParameterValue.InvalidRTMPStreamName | 无效的RTMP推流StreamName |
| InvalidParameterValue.InvalidRepairMode | 无效的录像补录参数 |
| InvalidParameterValue.InvalidRetrievalMode | 无效的取回模式 |
| InvalidParameterValue.InvalidRetrieveTaskId | 无效的取回任务ID |
| InvalidParameterValue.InvalidSecret | 无效的密钥值,长度或内容不符合规则 |
| InvalidParameterValue.InvalidStartTimeOrEndTime | 无效的开始或结束时间 |
| InvalidParameterValue.InvalidStatus | 状态取值错误 |
| InvalidParameterValue.InvalidStreamType | 无效的流类型 |
| InvalidParameterValue.InvalidTemplateId | 无效的模板ID |
| InvalidParameterValue.InvalidTemplateTag | 无效的TemplateTag |
| InvalidParameterValue.InvalidTimeFormat | 时间格式错误 |
| InvalidParameterValue.InvalidTimeInterval | 无效的截图频率 |
| InvalidParameterValue.InvalidTimeSectionValue | 无效时间片段取值 |
| InvalidParameterValue.InvalidTransitionRange | 热存储至少1天, 最多3650天 |
| InvalidParameterValue.InvalidUserParam | 无效的用户参数 |
| InvalidParameterValue.InvalidUsername | 无效的用户名,长度或内容不符合规则 |
| InvalidParameterValue.LimitRepairTransition | 开启录像补录热存不能小于3天 |
| InvalidParameterValue.NonSameDay | 时间不能跨天 |
| InvalidParameterValue.ObjectContainIllegalCharacter | Object包含非法字符 |
| InvalidParameterValue.OperTimeSlotContainIllegalCharacter | OperTimeSlot包含特殊字符 |
| InvalidParameterValue.OperTimeSlotNumberMustBeLessThanFive | OperTimeSlot容量必须小于5 |
| InvalidParameterValue.OperTimeSlotStartMustBeLessThanEnd | OperTimeSlot开始时间必须小于结束时间 |
| InvalidParameterValue.OrgNameRepeat | 组织名称不能重复 |
| InvalidParameterValue.OrganizationCountExceedsRange | 组织数量不能大于1000个 |
| InvalidParameterValue.OutOfTimeRange | 时间范围超限 |
| InvalidParameterValue.PageSizeExceedLimit | 页面大小超出限制,单页最多请求2000条记录 |
| InvalidParameterValue.PlanChannelsExceedsRange | 通道数量一次最多添加5000路 |
| InvalidParameterValue.PlanNameRepeat | 计划名称不能重复 |
| InvalidParameterValue.RTMPPushStreamParamRepeat | RTMP推流自定义AppName及StreamName不能重复配置 |
| InvalidParameterValue.RetrieveTaskChannelsExceedsRange | 一个取回任务最多添加32个设备通道 |
| InvalidParameterValue.StartOverEndTime | 开始时间不能大于结束时间 |
| InvalidParameterValue.StartOverNowTime | 开始时间不能大于当前时间 |
| InvalidParameterValue.StartTimeGreaterThanOrEqualEndTime | 开始时间不能大于等于结束时间 |
| InvalidParameterValue.StartTimeZero | 开始时间不能为空 |
| InvalidParameterValue.StatusMustBeNotEmpty | AI任务状态不能为空 |
| InvalidParameterValue.TaskTypeNotSupported | 不支持任务类型 |
| InvalidParameterValue.TemplateTagMustBeConsistent | TemplateTag必须一致 |
| InvalidParameterValue.TimeLessThanTenMinutes | 时间间隔不能小于10分钟 |
| InvalidParameterValue.TooLongDescribe | 描述字段过长 |
| InvalidParameterValue.TooLongName | 名称过长 |
| InvalidParameterValue.TooLongStreamType | 码流类型过长 |
| InvalidParameterValue.UnSupportOperateCMD | 不支持的操作命令 |
| InvalidParameterValue.UnSupportScale | 不支持该倍速 |
| InvalidParameterValue.UnSupportedAccessType | 不支持的接入类型 |
| InvalidParameterValue.UnSupportedPTZCMD | 不支持的云台控制指令 |
| InvalidParameterValue.UnSupportedPresetCMD | 不支持的预置位控制指令 |
| InvalidParameterValue.UnSupportedScaleParam | 不支持的倍速播放参数 |
| InvalidParameterValue.UnsupportedStreamProtocol | 不支持的流协议 |
| LimitExceeded.ChannelNumExceeded | 查询的通道数量不能超过3000个 |
| LimitExceeded.DeiceIdQuantityExceededLimit | 查询的设备数量不能超过200个 |
| LimitExceeded.GBDeviceNumExceeded | 查询的国标设备数量不能超过500个 |
| MissingParameter.EmptyTimeSection | 时间片段不存在 |
| MissingParameter.MissingLifeRuleParam | 缺少生命周期参数 |
| MissingParameter.MissingMustParameter | 缺少必须参数 |
| MissingParameter.MissingRetrieveTaskParam | 缺少取回任务参数 |
| MissingParameter.MissingUpdatedInfo | 没有更新信息 |
| MissingParameter.MissingUserInfo | 缺少用户信息 |
| OperationDenied.BandwidthLimitZero | 带宽受限 |
| OperationDenied.ConcurrentDownloadsOverLimit | 并发下载数超限 |
| OperationDenied.ConnectsLimitZero | 链接数受限 |
| OperationDenied.ExceededMaximumDepth | 新增组织树失败,超出组织树的最大深度 |
| OperationDenied.NoWhitelist | 该功能需要申请白名单配置 |
| OperationDenied.PlayAuthNotEnabled | 播放鉴权未开启 |
| RegionError.ResourceUnreachable | 资源不可达,该资源不属于该地域 |
| ResourceInUse.ChannelRepeatAdd | 存在重复添加的通道 |
| ResourceInUse.PlanDeleting | 计划删除中无法修改 |
| ResourceInUse.PlanLinkTemplate | 该模板被计划关联,不允许删除 |
| ResourceInUse.PlanNameRepeat | 计划名称不能重复 |
| ResourceInUse.RetrieveTaskExecuting | 取回任务正在执行中,无法删除 |
| ResourceInUse.RetrieveTaskNameRepeat | 取回任务名称不能重复 |
| ResourceInUse.TemplateNameRepeat | 模板名称不能重复 |
| ResourceNotFound.AITaskNotExisted | AI任务不存在 |
| ResourceNotFound.ChannelNotExist | 通道不存在 |
| ResourceNotFound.DeviceNotExist | 设备不存在 |
| ResourceNotFound.NotFoundCluster | 没有找到可用的服务节点 |
| ResourceNotFound.OrganizationIdNotExist | 组织ID不存在 |
| ResourceNotFound.PlanNotExist | 计划不存在 |
| ResourceNotFound.RetrieveTaskNotExist | 取回任务不存在 |
| ResourceNotFound.StreamNotExistOrClose | 视频流不存在或已关闭 |
| ResourceNotFound.TemplateNotExist | 模板不存在 |
| ResourceNotFound.VideoNotFound | 录像不存在 |
| ResourceUnavailable.ChannelOffline | 通道离线 |
| ResourceUnavailable.DevDisable | 设备被禁用 |
| ResourceUnavailable.DevNoRegister | 设备未注册 |
| ResourceUnavailable.DevOffline | 设备离线 |
| ResourceUnavailable.VideoArchived | 录像已归档 |
| UnsupportedOperation.OrgLinkDev | 组织下仍有主账号或其他子账号添加的设备,您无法查看或删除组织 |
| UnsupportedOperation.OrgLinkOrg | 组织下有挂靠的组织,不允许删除 |
| UnsupportedOperation.PushDomainNotExist | RTMP推流域名不存在 |
| UnsupportedOperation.ScaleAndPosBothExist | Scale和Pos参数不支持同时下发 |
| UnsupportedOperation.StreamTypeOrResolution | StreamType和Resolution参数不支持同时下发 |
| UnsupportedOperation.UnopenedIntranetServicesInRegion | 该地域未开通内网服务 |