If there is an Error field in the response, it means that the API call failed. For example:
{
"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"
}
}Code in Error indicates the error code, and Message indicates the specific information of the error.
| Error Code | Description |
|---|---|
| ActionOffline | This API has been deprecated. |
| AuthFailure.InvalidAuthorization | Authorization in the request header is invalid. |
| AuthFailure.InvalidSecretId | Invalid key (not a TencentCloud API key type). |
| AuthFailure.MFAFailure | MFA failed. |
| AuthFailure.SecretIdNotFound | Key does not exist. Check if the key has been deleted or disabled in the console, and if not, check if the key is correctly entered. Note that whitespaces should not exist before or after the key. |
| AuthFailure.SignatureExpire | Signature expired. Timestamp and server time cannot differ by more than five minutes. Please ensure your current local time matches the standard time. |
| AuthFailure.SignatureFailure | Invalid signature. Signature calculation error. Please ensure you’ve followed the signature calculation process described in the Signature API documentation. |
| AuthFailure.TokenFailure | Token error. |
| AuthFailure.UnauthorizedOperation | The request is not authorized. For more information, see the CAM documentation. |
| DryRunOperation | DryRun Operation. It means that the request would have succeeded, but the DryRun parameter was used. |
| FailedOperation | Operation failed. |
| InternalError | Internal error. |
| InvalidAction | The API does not exist. |
| InvalidParameter | Incorrect parameter. |
| InvalidParameterValue | Invalid parameter value. |
| InvalidRequest | The multipart format of the request body is incorrect. |
| IpInBlacklist | Your IP is in uin IP blacklist. |
| IpNotInWhitelist | Your IP is not in uin IP whitelist. |
| LimitExceeded | Quota limit exceeded. |
| MissingParameter | A parameter is missing. |
| NoSuchProduct | The product does not exist. |
| NoSuchVersion | The API version does not exist. |
| RequestLimitExceeded | The number of requests exceeds the frequency limit. |
| RequestLimitExceeded.GlobalRegionUinLimitExceeded | Uin exceeds the frequency limit. |
| RequestLimitExceeded.IPLimitExceeded | The number of ip requests exceeds the frequency limit. |
| RequestLimitExceeded.UinLimitExceeded | The number of uin requests exceeds the frequency limit. |
| RequestSizeLimitExceeded | The request size exceeds the upper limit. |
| ResourceInUse | Resource is in use. |
| ResourceInsufficient | Insufficient resource. |
| ResourceNotFound | The resource does not exist. |
| ResourceUnavailable | Resource is unavailable. |
| ResponseSizeLimitExceeded | The response size exceeds the upper limit. |
| ServiceUnavailable | Service is unavailable now. |
| UnauthorizedOperation | Unauthorized operation. |
| UnknownParameter | Unknown parameter. |
| UnsupportedOperation | Unsupported operation. |
| UnsupportedProtocol | HTTP(S) request protocol error; only GET and POST requests are supported. |
| UnsupportedRegion | API does not support the requested region. |
| Error Code | Description |
|---|---|
| AuthFailure.ContainUnauthorizedChannelId | Contains a channel ID that you do not have permission to operate. |
| AuthFailure.OrganizationUnauthorized | No access permission for the organization |
| FailedOperation.ChannelAlreadyAssigned | Contains an associated channel ID. Do not associate it again. |
| FailedOperation.ChannelNotAssigned | Contains unassociated channel IDs. Unable to disassociate. |
| FailedOperation.DatabaseError | Database error. |
| FailedOperation.DeviceResponseTimeOut | timeout for the device |
| FailedOperation.DeviceResultTimeOut | timeout for the device response |
| FailedOperation.NotHaveSubUser | No such sub-user |
| FailedOperation.RequestTimeout | Request timeout. |
| FailedOperation.TemplateInUse | AI scenario template is associated with a plan and cannot be deleted. |
| InternalError.ServerInternalError | Internal server error. |
| InvalidParameter.DownloadUrlError | Illegal download URL |
| InvalidParameter.DownloadUrlHasExpired | Download URL expired |
| InvalidParameter.InvalidAction | Invalid operation type. |
| InvalidParameter.InvalidBodyFormat | Invalid message body format |
| InvalidParameter.InvalidChannels | Invalid channel parameters |
| InvalidParameter.InvalidLifeRuleParam | Invalid lifecycle parameter |
| InvalidParameter.InvalidOrganizationParam | Invalid organization parameter |
| InvalidParameter.InvalidParameter | Invalid input parameter |
| InvalidParameter.InvalidParameterFormat | Incorrect parameter format or missing required parameters |
| InvalidParameter.InvalidTimeSection | Invalid time segment |
| InvalidParameter.RequiredHeaderParameterEmpty | Required request header parameter cannot be empty |
| InvalidParameter.TaskIdNotExist | TaskId not found |
| InvalidParameterValue.BakTimeNotEnough | Existence of a setting failing to satisfy (Cloud Upload Time Period = previous day's recording time period/cloud upload playback speed). Please check and confirm. |
| InvalidParameterValue.ChannelsExceedsRange | Number of channels exceeds the limit range. |
| InvalidParameterValue.ContainInvalidChannelId | Contains an invalid ChannelId. |
| InvalidParameterValue.ContainInvalidDeviceId | Contains an invalid device ID |
| InvalidParameterValue.ContainInvalidImageId | Contains an invalid image ID |
| InvalidParameterValue.ContainInvalidSnapshotTime | Contains an invalid screenshot time range |
| InvalidParameterValue.ContainInvalidToken | Contains an invalid Token. |
| InvalidParameterValue.ContainNonexistentChannelId | Contains a non-existing channel ID |
| InvalidParameterValue.DataOutOfRange | Period exceeds the limit (1-7) |
| InvalidParameterValue.DeviceMismatchChannel | Device ID and channel ID do not match |
| InvalidParameterValue.EmptyChannelId | Channel ID cannot be empty. |
| InvalidParameterValue.EmptyChannelIds | ChannelIds cannot be empty. At least 1 channel ID is required. |
| InvalidParameterValue.EmptyDeviceId | Device ID cannot be empty. |
| InvalidParameterValue.EmptyName | Name cannot be empty |
| InvalidParameterValue.EmptyOrganizationId | Organization ID cannot be empty. |
| InvalidParameterValue.EmptyTemplateId | Associated template cannot be empty. |
| InvalidParameterValue.EndTimeZero | End time cannot be empty. |
| InvalidParameterValue.IllegalChannelId | Channel ID contains illegal characters |
| InvalidParameterValue.IllegalDescribe | Description contains non-compliant characters (only Chinese, English, digits, _, and - are supported) |
| InvalidParameterValue.IllegalDeviceId | Device ID contains illegal characters |
| InvalidParameterValue.IllegalName | Name contains non-compliant characters (only Chinese, English, digits, _, and - are supported) |
| InvalidParameterValue.IllegalOrganizationId | Organization ID contains illegal characters |
| InvalidParameterValue.IllegalStreamType | Stream type contains invalid characters (only English, digits, _, and - are supported) |
| InvalidParameterValue.ImageVLPlanIDNotExisted | InvalidParameterValue.ImageVLPlanIDNotExisted |
| InvalidParameterValue.ImageVLPlanNameContainIllegalCharacter | InvalidParameterValue.ImageVLPlanNameContainIllegalCharacter |
| InvalidParameterValue.InvalidAIModel | InvalidParameterValue.InvalidAIModel |
| InvalidParameterValue.InvalidAccessProtocol | Invalid device access protocol. |
| InvalidParameterValue.InvalidBeginTime | Invalid start time |
| InvalidParameterValue.InvalidCallbackToken | Invalid callback Token. |
| InvalidParameterValue.InvalidCallbackUrl | Invalid callback URL |
| InvalidParameterValue.InvalidCaptureType | Invalid screenshot type filter value. Only realtime/low is supported. |
| InvalidParameterValue.InvalidChannelId | Invalid channel ID |
| InvalidParameterValue.InvalidChannelIdOrDeviceId | Contains an invalid channel ID or device ID |
| InvalidParameterValue.InvalidChannelName | Channel name is empty or incorrect. |
| InvalidParameterValue.InvalidClusterId | Invalid cluster ID. The length or content does not conform to rules. |
| InvalidParameterValue.InvalidCmd | Invalid command |
| InvalidParameterValue.InvalidConfigId | Invalid configuration ID |
| InvalidParameterValue.InvalidDescribe | Invalid description. |
| InvalidParameterValue.InvalidDescription | Incorrect description. |
| InvalidParameterValue.InvalidDeviceId | Invalid device ID |
| InvalidParameterValue.InvalidDeviceName | Device name is empty or incorrect. |
| InvalidParameterValue.InvalidDevicePasswordLength | The device password must be greater than 1 character and less than 64 characters in length. |
| InvalidParameterValue.InvalidDeviceStatus | Invalid device status |
| InvalidParameterValue.InvalidDeviceType | Invalid device type |
| InvalidParameterValue.InvalidDomainType | Invalid domain type parameter |
| InvalidParameterValue.InvalidEnalbeValue | Invalid enable parameter |
| InvalidParameterValue.InvalidEndTime | Invalid end time |
| InvalidParameterValue.InvalidExpiration | Invalid replica validity period. Valid values: 1-365 days |
| InvalidParameterValue.InvalidExpirationRange | Cold storage must be at least 60 days, and the total days of hot and cold storage cannot exceed 3650 days. |
| InvalidParameterValue.InvalidExpire | Invalid expiration time. It must be more than 0 and less than 60. |
| InvalidParameterValue.InvalidFileExpires | Invalid file storage days |
| InvalidParameterValue.InvalidFileType | Invalid file format |
| InvalidParameterValue.InvalidGatewayProtocolType | Invalid gateway access protocol. |
| InvalidParameterValue.InvalidImageConfigIntervalForLowFreq | The value range of the infrequent frame capturing frequency is [30, 36000] seconds. |
| InvalidParameterValue.InvalidImageConfigIntervalForRealtime | The value range of the real-time frame capturing frequency is [5, 180] seconds. |
| InvalidParameterValue.InvalidImageConfigType | Invalid screenshot type |
| InvalidParameterValue.InvalidImageVLPlanDescribe | InvalidParameterValue.InvalidImageVLPlanDescribe |
| InvalidParameterValue.InvalidImageVLPlanID | InvalidParameterValue.InvalidImageVLPlanID |
| InvalidParameterValue.InvalidImageVLPlanName | InvalidParameterValue.InvalidImageVLPlanName |
| InvalidParameterValue.InvalidIpv4 | Invalid Ipv4 addresses. |
| InvalidParameterValue.InvalidKeyword | Invalid keyword |
| InvalidParameterValue.InvalidMediaType | Invalid media type |
| InvalidParameterValue.InvalidName | Name is empty or incorrect. |
| InvalidParameterValue.InvalidOrgName | Organization name is empty or incorrect. |
| InvalidParameterValue.InvalidOrganizationId | Invalid organization ID |
| InvalidParameterValue.InvalidPageNumber | Invalid PageNumber |
| InvalidParameterValue.InvalidPageParameter | Invalid page parameter value |
| InvalidParameterValue.InvalidPageSize | Invalid PageSize |
| InvalidParameterValue.InvalidPlanId | Invalid plan ID |
| InvalidParameterValue.InvalidPrompt | Invalid prompt |
| InvalidParameterValue.InvalidPullState | Invalid pull authentication switch value |
| InvalidParameterValue.InvalidPushState | Invalid push authentication switch value |
| InvalidParameterValue.InvalidRTMPAppName | Invalid RTMP push AppName |
| InvalidParameterValue.InvalidRTMPStreamName | Invalid RTMP push StreamName |
| InvalidParameterValue.InvalidRepairMode | Invalid video recording supplement parameter |
| InvalidParameterValue.InvalidRetrievalMode | Invalid retrieval mode |
| InvalidParameterValue.InvalidRetrieveTaskId | Invalid retrieval task ID. |
| InvalidParameterValue.InvalidSecret | Invalid secret key value. The length or content does not conform to rules. |
| InvalidParameterValue.InvalidStartTimeOrEndTime | Invalid start or end time |
| InvalidParameterValue.InvalidStatus | Invalid status |
| InvalidParameterValue.InvalidStreamType | Invalid stream type |
| InvalidParameterValue.InvalidTemplateId | Invalid template ID |
| InvalidParameterValue.InvalidTimeFormat | Time format error. |
| InvalidParameterValue.InvalidTimeSectionValue | Invalid time segment value |
| InvalidParameterValue.InvalidTimes | InvalidParameterValue.InvalidTimes |
| InvalidParameterValue.InvalidTransitionRange | Hot storage must be at least 1 day and at most 3650 days. |
| InvalidParameterValue.InvalidUserParam | Invalid user parameter |
| InvalidParameterValue.InvalidUsername | Invalid username. The length or content does not conform to rules. |
| InvalidParameterValue.InvalidVLPlanResultID | InvalidParameterValue.InvalidVLPlanResultID |
| InvalidParameterValue.InvalidVLPlanResultIds | InvalidParameterValue.InvalidVLPlanResultIds |
| InvalidParameterValue.LimitRepairTransition | Enable video recording supplementary hot storage for at least 3 days. |
| InvalidParameterValue.MissingImageConfig | InvalidParameterValue.MissingImageConfig |
| InvalidParameterValue.MissingTimes | InvalidParameterValue.MissingTimes |
| InvalidParameterValue.NonSameDay | Time cannot span across days. |
| InvalidParameterValue.OrgNameRepeat | Organization name must be unique |
| InvalidParameterValue.OrganizationCountExceedsRange | The number of organizations cannot be greater than 1,000. |
| InvalidParameterValue.OrganizationIDNotExisted | Organization ID does not exist. |
| InvalidParameterValue.OrganizationIdsNotAllowedForUnAssign | OrganizationIds does not allow input when Cmd=2 (unbind). |
| InvalidParameterValue.OutOfTimeRange | Time range exceeds the limit |
| InvalidParameterValue.PageSizeExceedLimit | Page size exceeds the limit |
| InvalidParameterValue.PlanChannelsExceedsRange | Add up to 5,000 channels at a time |
| InvalidParameterValue.PlanNameRepeat | Plan name must be unique |
| InvalidParameterValue.RTMPPushStreamParamRepeat | Custom RTMP push AppName and StreamName cannot be duplicated |
| InvalidParameterValue.RetrieveTaskChannelsExceedsRange | Add up to 32 device channels to a retrieval task. |
| InvalidParameterValue.StartOverEndTime | Start time cannot be greater than end time. |
| InvalidParameterValue.StartOverNowTime | Start time cannot be greater than the current time. |
| InvalidParameterValue.StartTimeGreaterThanOrEqualEndTime | Start time cannot be greater than or equal to end time. |
| InvalidParameterValue.StartTimeZero | Start time cannot be empty. |
| InvalidParameterValue.TaskTypeNotSupported | Unsupported task type |
| InvalidParameterValue.TemplateIDNotExisted | Visual understanding analysis template ID does not exist |
| InvalidParameterValue.TimeLessThanTenMinutes | Time interval cannot be less than 10 minutes. |
| InvalidParameterValue.TooLongDescribe | Description field too long |
| InvalidParameterValue.TooLongName | Name is too long |
| InvalidParameterValue.TooLongStreamType | Stream type too long. |
| InvalidParameterValue.TooManyChannelIds | Number of ChannelIds exceeds the limit. |
| InvalidParameterValue.UnSupportOperateCMD | Unsupported operation command. |
| InvalidParameterValue.UnSupportScale | Playback speed not supported |
| InvalidParameterValue.UnSupportedAccessType | Unsupported access type |
| InvalidParameterValue.UnSupportedPTZCMD | Unsupported gimbal control command. |
| InvalidParameterValue.UnSupportedPresetCMD | Unsupported preset position control command. |
| InvalidParameterValue.UnSupportedScaleParam | Unsupported playback speed parameter |
| InvalidParameterValue.UnsupportedFileExpireTime | Unsupported file storage expiry time |
| InvalidParameterValue.UnsupportedImageUrlExpireTime | Unsupported image download url expiration time |
| InvalidParameterValue.UnsupportedInterval | Unsupported frame capturing frequency configuration |
| InvalidParameterValue.UnsupportedSnapshotTotal | Unsupported frame count configuration |
| InvalidParameterValue.UnsupportedSnapshotType | Unsupported screenshot type |
| InvalidParameterValue.UnsupportedSortRule | Unsupported sorting rule. |
| InvalidParameterValue.UnsupportedStreamProtocol | Unsupported stream protocol |
| InvalidParameterValue.VLPlanResultIDNotExisted | InvalidParameterValue.VLPlanResultIDNotExisted |
| InvalidParameterValue.VLPlanResultIdsExceedLimit | InvalidParameterValue.VLPlanResultIdsExceedLimit |
| LimitExceeded.BatchAddChannelNumExceeded | The number of channels added to the configuration in a single bulk operation exceeds the limit. |
| LimitExceeded.ChannelNumExceeded | Number of channels exceeds the limit. |
| LimitExceeded.DeiceIdQuantityExceededLimit | The number of queried devices cannot exceed 200. |
| LimitExceeded.GBDeviceNumExceeded | The number of queried national standard devices cannot exceed 500. |
| LimitExceeded.ImageIdSliceExceedLimit | Image ID quantity exceeds the limit. |
| LimitExceeded.SnapshotConfigNumExceeded | The creatable screenshot configuration quantity exceeds the limit. |
| LimitExceeded.SnapshotTemplateNumExceeded | The creatable screenshot template quantity exceeds the limit. |
| LimitExceeded.TimelineSliceExceedLimit | Number of time periods exceeds the limit |
| MissingParameter.EmptyTimeSection | Time segment not found |
| MissingParameter.MissingLifeRuleParam | Lack of lifecycle parameters |
| MissingParameter.MissingMustParameter | Lack of required parameters |
| MissingParameter.MissingRetrieveTaskParam | Lack of retrieval task parameter |
| MissingParameter.MissingUpdatedInfo | No update information. |
| MissingParameter.MissingUserInfo | Lack of user information |
| OperationDenied.BandwidthLimitZero | Bandwidth limitation |
| OperationDenied.ConcurrentDownloadsOverLimit | Concurrent download limit exceeded |
| OperationDenied.ConfigChanging | Configuration is changing. Please try again later. |
| OperationDenied.ConnectsLimitZero | Number of connections limited |
| OperationDenied.ExceededMaximumDepth | Failed to add the organization tree. The maximum depth of the organization tree is exceeded. |
| OperationDenied.InputDuplicateChannelId | Duplicate channel ID detected |
| OperationDenied.NoWhitelist | The feature requires allowlist configuration. To use it, you need to apply. |
| OperationDenied.PlayAuthNotEnabled | Playback authentication is not enabled |
| RegionError.ResourceUnreachable | Resource unreachable. The resource is not within this region. |
| ResourceInUse.ChannelRepeatAdd | Existent channel with duplicate addition |
| ResourceInUse.PlanDeleting | Cannot be modified during scheduled deletion. |
| ResourceInUse.PlanLinkTemplate | This template is associated with a plan and cannot be deleted. |
| ResourceInUse.PlanNameRepeat | Plan name must be unique |
| ResourceInUse.RetrieveTaskExecuting | Retrieval task is in progress and cannot be deleted. |
| ResourceInUse.RetrieveTaskNameRepeat | Retrieval task names cannot be duplicated. |
| ResourceInUse.TemplateIsUsed | Template is currently in use and cannot be deleted. |
| ResourceInUse.TemplateNameRepeat | Template name must be unique. |
| ResourceNotFound.AccessUnauthorized | Unable to access unauthorized devices |
| ResourceNotFound.ChannelNotExist | Channel not found |
| ResourceNotFound.DeviceNotExist | Device does not exist |
| ResourceNotFound.NotFoundCluster | No available service nodes were found. |
| ResourceNotFound.OrganizationIdNotExist | Organization ID does not exist. |
| ResourceNotFound.PlanNotExist | Plan not found |
| ResourceNotFound.RetrieveTaskNotExist | The retrieval task does not exist. |
| ResourceNotFound.SnapshotConfigNotExist | Screenshot configuration not found |
| ResourceNotFound.TemplateNotExist | The template does not exist. |
| ResourceNotFound.VideoNotFound | Video recording not found. |
| ResourceUnavailable.ChannelOffline | Channel offline |
| ResourceUnavailable.DevDisable | Device disabled |
| ResourceUnavailable.DevNoRegister | Device not registered. |
| ResourceUnavailable.DevOffline | Device offline |
| ResourceUnavailable.VideoArchived | Video recording archived |
| UnsupportedOperation.ImageDomainNotExist | Image domain name not found |
| UnsupportedOperation.OrgLinkDev | Devices added by the root account or other sub-accounts still exist in the organization. You cannot view or delete the organization. |
| UnsupportedOperation.OrgLinkOrg | Deletion is not allowed when an organization has affiliated organizations. |
| UnsupportedOperation.PushDomainNotExist | RTMP streaming domain not found |
| UnsupportedOperation.StreamTypeOrResolution | StreamType and Resolution parameters are not supported to be delivered simultaneously. |
| UnsupportedOperation.UnopenedIntranetServicesInRegion | Intranet services are not enabled in this region. |
피드백