Error Codes

Last updated: 2020-08-20 18:05:41

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
UnsupportedOperation Unsupported operation.
ResourceInUse Resource is in use.
InternalError Internal error.
RequestLimitExceeded The number of requests exceeds the frequency limit.
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.
LimitExceeded Quota limit exceeded.
NoSuchVersion The API version does not exist.
ResourceNotFound The resource does not exist.
AuthFailure.SignatureFailure Invalid signature. Signature calculation error. Please ensure you’ve followed the signature calculation process described in the Signature API documentation.
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.
UnsupportedRegion API does not support the requested region.
UnauthorizedOperation Unauthorized operation.
InvalidParameter Incorrect parameter.
ResourceUnavailable Resource is unavailable.
AuthFailure.MFAFailure MFA failed.
AuthFailure.UnauthorizedOperation The request is not authorized. For more information, see the CAM documentation.
AuthFailure.InvalidSecretId Invalid key (not a TencentCloud API key type).
AuthFailure.TokenFailure Token error.
DryRunOperation DryRun Operation. It means that the request would have succeeded, but the DryRun parameter was used.
FailedOperation Operation failed.
UnknownParameter Unknown parameter.
UnsupportedProtocol HTTP(S) request protocol error; only GET and POST requests are supported.
InvalidParameterValue Invalid parameter value.
InvalidAction The API does not exist.
MissingParameter A parameter is missing.
ResourceInsufficient Insufficient resource.

Service Error Codes

Error Code Description
FailedOperation.ApiBindEnvironmen This API has been bound with a usage plan.
FailedOperation.ApiError API error.
FailedOperation.CertificateIdBindError An error occurred while binding a certificate.
FailedOperation.CertificateIdEnterpriseWaitSubmit The enterprise certificate is 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.
FailedOperation.CertificateIdInfoError The certificate information is empty. Please submit a ticket for assistance.
FailedOperation.CertificateIdUnderVerify The certificate is under review.
FailedOperation.CertificateIdUnknownError The certificate is in an unknown status. Please submit a ticket for assistance.
FailedOperation.CertificateIdVerifyFail Certificate review failed.
FailedOperation.CertificateIsNull The certificate ID is empty.
FailedOperation.DefineMappingEnvironmentError Environment in the custom path mapping can be set to only test,prepub, orrelease`.
FailedOperation.DefineMappingNotNull The custom path mapping is required.
FailedOperation.DefineMappingParamRepeat The custom path mapping value already exists.
FailedOperation.DefineMappingPathError The Path in the custom path mapping is non-compliant.
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 The custom domain name has not been bound to any services.
FailedOperation.DomainResolveError The custom domain name is not configured with a CNAME record pointing to the default domain name or the configuration has not taken effect yet.
FailedOperation.FormatError The domain name format is incorrect.
FailedOperation.IsDefaultMapping PathMappingSet cannot be entered if the default path mapping is used.
FailedOperation.NetSubDomainError The entered default second-level domain name is incorrect.
FailedOperation.PathMappingSetError An error occurred while setting the path mapping.
FailedOperation.ServiceError Service-related error.
FailedOperation.ServiceNotExist The service does not exist.
FailedOperation.SetCustomPathMappingError An error occurred while setting the path mapping for the custom domain name.
FailedOperation.SubDomainFormatError The custom domain name format is incorrect.
FailedOperation.UnknownProtocolTypeError Unknown network protocol type.
InternalError.OssException OSS internal error.
InvalidParameter.FormatError Incorrect parameter format.
InvalidParameterValue.InvalidApiBusinessType The API business type passed in must be OAUTH.
InvalidParameterValue.InvalidApiRequestConfig Invalid API configuration.
InvalidParameterValue.InvalidProcotol Invalid protocol type parameter.
InvalidParameterValue.InvalidRequestParameters Invalid request parameter.
InvalidParameterValue.InvalidServiceConfig Invalid service configuration.
InvalidParameterValue.NothingModifyForOauth The OAuth API has no available modification items.
LimitExceeded.ApiCountLimitExceeded Exceeded API quota.
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.ServiceCountLimitExceeded The total number of created services exceeds the limit.
ResourceNotFound.InvalidApi Incorrect ApiId.
ResourceNotFound.InvalidService The corresponding service is invisible.
ResourceNotFound.InvalidUsagePlan The usage plan does not exist.
UnauthorizedOperation.UncertifiedUser The user has not passed identity verification.
UnsupportedOperation.InvalidServiceTrade As the service is isolated, the operation is not supported currently.
UnsupportedOperation.InvalidStatus The operation is not supported by the apikey status.
UnsupportedOperation.ReduceNetTypes You are prohibited to reduce the network types.
UnsupportedOperation.ResourceIsInUse The resource is being used.
UnsupportedOperation.UnsupportedBindEnvironment You do not have the permission to bind environments.
UnsupportedOperation.UnsupportedDeleteService This service is being used and cannot be deleted.
UnsupportedOperation.UnsupportedUpdateApiKey The key status cannot be updated.
UnsupportedOperation.UsagePlanInUse The usage plan is being used and cannot be deleted.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback