Error Codes

Last updated: 2020-09-04 14:39:49

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.CmkUsedByCloudProduct The CMK is being used by a Tencent Cloud product.
FailedOperation.DecryptError Decryption failed.
InvalidParameter.DecryptMaterialError Decryption of EncryptedKeyMaterial failed.
InvalidParameter.InvalidPendingWindowInDays The schedule deletion time parameter is invalid.
InvalidParameterValue.AliasAlreadyExists The alias already exists.
InvalidParameterValue.DuplicatedKeyId Duplicate KeyId.
InvalidParameterValue.InvalidAlias Incorrect alias format
InvalidParameterValue.InvalidCiphertext Incorrect ciphertext format
InvalidParameterValue.InvalidKeyId Invalid KeyId.
InvalidParameterValue.InvalidKeyUsage Incorrect KeyUsage parameter.
InvalidParameterValue.InvalidPlaintext Invalid Plaintext.
InvalidParameterValue.InvalidType Incorrect Type parameter.
InvalidParameterValue.MaterialNotMatch The key material is different from the one previously imported.
InvalidParameterValue.TagKeysDuplicated Duplicate tag key.
InvalidParameterValue.TagsNotExisted The tag key or tag value does not exist.
LimitExceeded.CmkLimitExceeded The number of CMKs has reached the upper limit.
LimitExceeded.FingerprintsLimitExceeded The number of device fingerprints exceeded the limit.
LimitExceeded.KeyLimitExceeded The number of created keys exceeded the limit.
ResourceUnavailable.CloudResourceBindingNotFound The CMK is not bound with the Tencent Cloud resource
ResourceUnavailable.CmkArchived The CMK has been archived.
ResourceUnavailable.CmkDisabled The CMK has been disabled.
ResourceUnavailable.CmkNotFound The CMK does not exist.
ResourceUnavailable.CmkNotPendingDelete As the CMK is not scheduled for deletion, you cannot cancel the schedule deletion.
ResourceUnavailable.CmkShouldBeDisabled An enabled CMK cannot be scheduled for deletion.
ResourceUnavailable.CmkStateNotSupport This operation cannot be performed under the current CMK status.
ResourceUnavailable.KeyDisabled The key has been disabled.
ResourceUnavailable.NotPurchased The white-box key service has not been activated.
ResourceUnavailable.TokenExpired Token has expired.
UnsupportedOperation.ExternalCmkCanNotRotate External CMKs cannot be rotated.
UnsupportedOperation.NotExternalCmk Incorrect CMK type. Only External CMKs are supported.
UnsupportedOperation.NotUserCreatedCmk You can only update the CMKs created by you.
UnsupportedOperation.ServiceTemporaryUnavailable The service is temporarily unavailable.
UnsupportedOperation.UnsupportedKeyUsageInCurrentRegion The encryption method is not supported in the current region.

Was this page helpful?

Was this page helpful?

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