Error Codes

最終更新日:2021-04-28 11:10:01

Feature Description

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 List

Common Error Codes

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.
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.
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.
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.

Service Error Codes

Error Code Description
AuthFailure.UnRealNameAuthenticated Identity verification has not been completed, so this operation is not allowed.
FailedOperation.MixSessionNotExist No On-Cloud MixTranscoding template is set for this room.
FailedOperation.RequestRejection The TencentCloud API On-Cloud MixTranscoding template conflicts with On-Cloud MixTranscoding settings in the SDK.
FailedOperation.RoomNotExist The room does not exist.
FailedOperation.SdkAppIdNotExist Application ID does not exist.
InternalError.BackendFail Failed to access the backend service.
InternalError.BackendTimeOut Backend service access timed out.
InternalError.DBError An error occurred while querying the database.
InternalError.EsQueryError An error occurred while querying ES.
InternalError.GetRoomCacheIpError Failed to query the room.
InternalError.GetRoomFromCacheError Failed to get room information.
InternalError.HttpParaseFalied Failed to parse the HTTP request.
InternalError.InterfaceErr API error.
InternalError.MethodErr Unsupported method.
InternalError.MonitorQueryErr Failed to query seconds-level monitoring data.
InvalidParameter.AudioEncodeParams Invalid audio codec parameter.
InvalidParameter.BodyParamsError Failed to parse the body parameter.
InvalidParameter.CheckContentFailed The image is too large.
InvalidParameter.CheckSuffixFailed Invalid file extension.
InvalidParameter.EncodeParams Invalid EncodeParams.
InvalidParameter.EndTs Invalid EndTs.
InvalidParameter.MainVideoRightAlign Invalid MainVideoRightAlign (parameter specifying whether to display the big image on the right).
InvalidParameter.MainVideoStreamType Invalid stream type of the big image.
InvalidParameter.OutputParams Incorrect OutputParams parameter.
InvalidParameter.PageNumber Invalid PageNumber.
InvalidParameter.PageSize Invalid PageSize.
InvalidParameter.PageSizeOversize The value of PageSize exceeds 100.
InvalidParameter.PresetLayoutConfig Incorrect parameters for custom layout.
InvalidParameter.PureAudioStream Incorrect parameters for audio-only stream pushing.
InvalidParameter.QueryScaleOversize The query time range exceeds 1 hour.
InvalidParameter.RecordAudioOnly Incorrect parameters for audio-only recording.
InvalidParameter.RecordId Incorrect RecordId parameter.
InvalidParameter.RoomId RoomId is incorrect.
InvalidParameter.SdkAppId SdkAppId is incorrect.
InvalidParameter.SdkAppid Inoperable SdkAppid.
InvalidParameter.SmallVideoLayoutParams Invalid small image layout parameter.
InvalidParameter.SmallVideoStreamType Invalid StreamType under SmallVideoLayoutParams.
InvalidParameter.StartTimeExpire The query start time is more than 24 hours earlier than now.
InvalidParameter.StartTs Invalid StartTs.
InvalidParameter.StartTsOversize The query start time is more than 5 days earlier than now.
InvalidParameter.StreamId Incorrect StreamId parameter.
InvalidParameter.UrlParamsError Failed to parse the URL parameter.
InvalidParameter.UserId Invalid UserId.
InvalidParameter.UserIds UserIds is incorrect.
InvalidParameter.UserIdsMorethanSix The number of users exceeds 6.
InvalidParameter.VideoResolution Invalid video resolution.
InvalidParameterValue.RoomId Invalid RoomId.
MissingParameter.AppId AppId missing.
MissingParameter.AudioEncodeParams Audio output parameters are missing in EncodeParams.
MissingParameter.BizId BizId missing in relayed push parameters.
MissingParameter.CommId CommId is missing.
MissingParameter.CommIdOrSdkAppId SdkAppId or CommID missing.
MissingParameter.EncodeParams Missing EncodeParams parameter.
MissingParameter.EndTs endTS_s is missing.
MissingParameter.OutputParams Missing OutputParams parameter.
MissingParameter.PresetLayoutConfig Custom layout parameter missing.
MissingParameter.PublishCdnParams Relaying parameter missing.
MissingParameter.PublishCdnUrls Destination missing in relayed push parameters.
MissingParameter.RoomId RoomId is missing.
MissingParameter.RoomNum RoomNum is missing.
MissingParameter.SdkAppId SdkAppId is missing.
MissingParameter.StartTs startTS_s is missing.
MissingParameter.StreamId The StreamId parameter is missing in OutputParams.
MissingParameter.UserId Missing UserId parameter.
MissingParameter.UserIds UserIds is missing.
MissingParameter.VideoEncodeParams Video output parameters are missing in EncodeParams.
UnauthorizedOperation.SdkAppId No permission to manipulate SdkAppId.