Error Codes

Last updated: 2021-08-17 15:23:14

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 Error with CAM signature/authentication.
FailedOperation.AccessKeyExist The custom key already exists.
FailedOperation.ApiBindEnvironmen This API has been bound with a usage plan.
FailedOperation.ApiBindEnvironment The APIs have already been bound to a usage plan. Please unbind them and try again.
FailedOperation.ApiError API error.
FailedOperation.ApiInOperation The API is being manipulated. Please try again later.
FailedOperation.CertificateIdBindError An error occurred while binding a certificate.
FailedOperation.CertificateIdEnterpriseWaitSubmit The certificate is an enterprise certificate and waiting to be submitted.
FailedOperation.CertificateIdError The certificate does not exist or you do not have permission to view it. Please upload a valid certificate in the SSL Certificates Service Console.
FailedOperation.CertificateIdExpired The certificate has expired. Please upload a valid one.
FailedOperation.CertificateIdInfoError The certificate information is empty. Please submit a ticket for assistance.
FailedOperation.CertificateIdUnderVerify The certificate is under review. Please upload a valid one.
FailedOperation.CertificateIdUnknownError The certificate is in an unknown status. Please submit a ticket to check its specific status.
FailedOperation.CertificateIdVerifyFail The certificate has been rejected. Please upload a valid one.
FailedOperation.CertificateIsNull The Apis certificate is empty. Please upload a certificate.
FailedOperation.CodingError API document operation failed.
FailedOperation.DefineMappingEnvironmentError The Apis environment configuration is incorrect.
FailedOperation.DefineMappingNotNull The Apis custom path mapping cannot be empty.
FailedOperation.DefineMappingParamRepeat The Apis parameters are repeated.
FailedOperation.DefineMappingPathError The Apis custom path configuration is incorrect.
FailedOperation.DeletePathMappingSetError An error occurred while deleting the custom domain name.
FailedOperation.DescribeServiceSubDomainsError The custom domain name of the service is incorrect.
FailedOperation.DomainAlreadyBindOtherService The domain name has been bound to another service.
FailedOperation.DomainAlreadyBindService The domain name has already been bound to this service.
FailedOperation.DomainNeedBeian The domain name does not have an ICP filing through Tencent Cloud. Please get the ICP filing before binding the domain name.
FailedOperation.DomainNotBindService Failed to unbind the custom domain name, as the domain name is not bound to the service.
FailedOperation.DomainResolveError The domain name is not configured with a CNAME record resolving to the default domain name, or the resolution has not taken effect yet.
FailedOperation.EbError Failed to bind/unbind EventBridge.
FailedOperation.FormatError The domain name format is incorrect.
FailedOperation.GenerateApiDocumentError Failed to generate the API documentation.
FailedOperation.GetRoleError Failed to get the role. Please make sure that relevant API Gateway service APIs have been authorized.
FailedOperation.InstanceNotExist The instance does not exist or is invalid.
FailedOperation.IsDefaultMapping The Apis custom path conflicts with the default path.
FailedOperation.NetSubDomainError The entered default second-level domain name is incorrect.
FailedOperation.PathMappingSetError An error occurred while setting the path mapping.
FailedOperation.ScfError Failed to bind/unbind SCF trigger.
FailedOperation.ServiceError Service error.
FailedOperation.ServiceInOperation The service is in use. Please try again later.
FailedOperation.ServiceNotExist The service does not exist.
FailedOperation.SetCustomPathMappingError The custom domain name already uses the default path mapping, so no custom path can be set.
FailedOperation.SubDomainFormatError The custom domain name format is incorrect.
FailedOperation.TagBindServiceError The tag was not bound to the specified service.
FailedOperation.UnknownProtocolTypeError The protocol type is incorrect.
InternalError.ApigwException API Gateway internal request error. Please try again later. If the problem persists, please contact the smart customer service or submit a ticket.
InternalError.OssException OSS internal request error. Please try again. If the problem persists, please contact the smart customer service or submit a ticket.
InternalError.ScfException SCF internal request error. Please try again. If the problem persists, please contact the smart customer service or submit a ticket.
InternalError.TsfException TSF internal request error. Please try again. If the problem persists, please contact the smart customer service or submit a ticket.
InternalError.VpcException VPC internal request error. Please try again. If the problem persists, please contact the smart customer service or submit a ticket.
InvalidParameter.FormatError Incorrect parameter format.
InvalidParameterValue.InvalidAccessKeyIds Incorrect key.
InvalidParameterValue.InvalidApiBusinessType The API business type passed in must be OAUTH.
InvalidParameterValue.InvalidApiIds Incorrect API ID
InvalidParameterValue.InvalidApiRequestConfig Invalid API configuration.
InvalidParameterValue.InvalidApiType The API type is incorrect. The microservice API only supports the TSF backend service type.
InvalidParameterValue.InvalidBackendPath The backend service path configuration is incorrect.
InvalidParameterValue.InvalidClb Invalid CLB configuration.
InvalidParameterValue.InvalidConstantParameters The constant parameter is invalid.
InvalidParameterValue.InvalidEnv The value of the Env parameter is incorrect. Its valid values are (release, prepub, test).
InvalidParameterValue.InvalidEnvStatus Invalid service environment status
InvalidParameterValue.InvalidFilterNotSupportedName The parameter value is incorrect.
InvalidParameterValue.InvalidGenLanguage The GenLanguage parameter value is incorrect.
InvalidParameterValue.InvalidIPAddress The value of the backend address parameter is incorrect.
InvalidParameterValue.InvalidMethod The method is incorrect. For backend services in the WEBSOCKET type, the frontend method should be configured as GET.
InvalidParameterValue.InvalidPort The backend service port is incorrect.
InvalidParameterValue.InvalidProcotol Invalid protocol type parameter.
InvalidParameterValue.InvalidPublicKey The OAUTH 2.0 API public key parameter is in an incorrect format.
InvalidParameterValue.InvalidRegion Incorrect region.
InvalidParameterValue.InvalidRequestParameters Invalid request parameter.
InvalidParameterValue.InvalidScfConfig The SCF API parameters are invalid.
InvalidParameterValue.InvalidServiceConfig Invalid service configuration.
InvalidParameterValue.InvalidServiceMockReturnMessage The ServiceMockReturnMessage parameter is incorrect.
InvalidParameterValue.InvalidServiceParam The parameter configuration is incorrect, as the parameter is not configured in the backend parameter configuration list.
InvalidParameterValue.InvalidServiceParameters The ServiceParameters parameter is incorrect.
InvalidParameterValue.InvalidServiceType The backend service type is incorrect. For backend services in WEBSOCKET type, the frontend protocol should be configured as WEBSOCKET.
InvalidParameterValue.InvalidTagValues Incorrect tag parameters
InvalidParameterValue.InvalidTsfConfig Incorrect configuration of the TSF-type API.
InvalidParameterValue.InvalidUrl The URL parameters are invalid.
InvalidParameterValue.InvalidWSMethod The method is incorrect. For backend services in the WEBSOCKET type, the frontend method should be configured as GET.
InvalidParameterValue.LengthExceeded The length of the parameter exceeds the limit.
InvalidParameterValue.LimitExceeded The number of parameters has reached the limit (100).
InvalidParameterValue.NotInOptions The parameter value is incorrect, as it is not an available option.
InvalidParameterValue.NothingModifyForOauth There are no modifiable items for the OAuth API.
InvalidParameterValue.ParameterNotMatch The backend parameter configuration is incorrect, as the related frontend parameters are not configured.
InvalidParameterValue.ParameterValueLimitExceeded The number of parameters exceeded limit.
InvalidParameterValue.RangeExceeded The parameter value is incorrect, as it is not within the valid value range.
LimitExceeded.APIDocLimitExceeded The number of API documents exceeds the limit.
LimitExceeded.ApiAppCountLimitExceeded The number of applications exceeds the limit.
LimitExceeded.ApiCountLimitExceeded The number of APIs exceeds the limit.
LimitExceeded.ApiKeyCountLimitExceeded The number of keys exceeds the limit.
LimitExceeded.ExceededDefineMappingLimit You can set up to 3 sets of custom path mappings.
LimitExceeded.ExceededDomainLimit The number of bound domain names exceeds the limit. You can bind up to 5 domain names by default.
LimitExceeded.IpStrategyLimitExceeded The number of IP policies exceeds the limit.
LimitExceeded.RequestLimitExceeded The request frequency has reached the limit. Please try again later.
LimitExceeded.ServiceCountForPluginLimitExceeded Too many services are bound to the plugin. Unbind some services or increase the quota, and try again.
LimitExceeded.ServiceCountLimitExceeded The number of services exceeds the limit. Please delete some services or increase the limit and try again.
LimitExceeded.UsagePlanLimitExceeded The number of usage plans exceeds the limit.
OperationDenied Operation denied.
ResourceNotFound.InvalidAccessKeyId The key does not exist.
ResourceNotFound.InvalidApi Incorrect ApiId.
ResourceNotFound.InvalidApiApp The application ID is incorrect.
ResourceNotFound.InvalidApiDoc The API document does not exist.
ResourceNotFound.InvalidIPStrategy The IP policy does not exist.
ResourceNotFound.InvalidOauthApi Error with the OAuth service API.
ResourceNotFound.InvalidPlugin The plugin does not exist.
ResourceNotFound.InvalidService The corresponding service is invisible.
ResourceNotFound.InvalidUsagePlan The usage plan does not exist.
ResourcesSoldOut The resources have been sold out.
UnauthorizedOperation.AccessResource You do not have permission to access the resource.
UnauthorizedOperation.UncertifiedUser The user has not passed identity verification.
UnsupportedOperation.AlreadyBindUsagePlan The key has already been bound to a usage plan.
UnsupportedOperation.ForceHttps Cannot force HTTPS when the protocol is HTTP.
UnsupportedOperation.InvalidAction API error.
UnsupportedOperation.InvalidEndpointType Backend type not supported
UnsupportedOperation.InvalidServiceTrade The service is currently isolated and therefore the operation is not supported.
UnsupportedOperation.InvalidStatus The current key status does not support this operation.
UnsupportedOperation.ModifyEIAMAuthApi The EIAM authentication API cannot be modified.
UnsupportedOperation.ModifyProtocol The frontend protocol type cannot be changed.
UnsupportedOperation.NoUsagePlanEnv The current usage plan is not bound to an environment.
UnsupportedOperation.ReduceNetTypes Network types cannot be reduced.
UnsupportedOperation.ResourceAssociated The resource has been associated. Please disassociate it first.
UnsupportedOperation.ResourceIsInUse The key has already been bound to a usage plan. Please unbind it and try again.
UnsupportedOperation.UinNotInWhiteList The current Uin is not in the manual key allowlist.
UnsupportedOperation.UnsupportedBindApiKey The key has already been bound to a usage plan.
UnsupportedOperation.UnsupportedBindEnvironment The environment cannot be bound.
UnsupportedOperation.UnsupportedDeleteApi The current API has already been bound to a business API. Please unbind it and try again.
UnsupportedOperation.UnsupportedDeleteService This service is being used and cannot be deleted.
UnsupportedOperation.UnsupportedNetType Unsupported network type
UnsupportedOperation.UnsupportedUnBindEnvironment The environment cannot be unbound, as there are APIs that are not bound to a usage plan.
UnsupportedOperation.UnsupportedUpdateApiKey The current key status does not support this operation.
UnsupportedOperation.UsagePlanInUse The current plan is in use. Please unbind it and try again.