Documentation|Tencent Cloud

Recent Pages

Documentation

CancelKeyDeletion

Last updated: 2020-07-17 11:10:57

1. API Description

Domain name for API request: kms.tencentcloudapi.com.

Cancel the scheduled deletion of CMK

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common parameter. The value used for this API: CancelKeyDeletion.
Version	Yes	String	Common parameter. The value used for this API: 2019-01-18.
Region	Yes	String	Common parameter. For more information, please see the list of regions supported by the product.
KeyId	Yes	String	Unique ID of the CMK for which to cancel schedule deletion

3. Output Parameters

Parameter Name	Type	Description
KeyId	String	Unique ID of the CMK for which the schedule deletion is canceled
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Canceling schedule deletion

This example shows you how to cancel the schedule deletion for a CMK.

Input Example

https://kms.tencentcloudapi.com/?Action=CancelKeyDeletion
&KeyId="23e80852-1e38-11e9-b129-5cb9019b4b01"
&<common request parameters>

Output Example

{
  "Response": {
    "KeyId": "23e80852-1e38-11e9-b129-5cb9019b4b01"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

API 3.0 Explorer

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
InternalError	Internal error.
InvalidParameterValue.InvalidKeyId	Invalid `KeyId`.
ResourceUnavailable.CmkNotFound	The CMK does not exist.
ResourceUnavailable.CmkNotPendingDelete	As the CMK is not scheduled for deletion, you cannot cancel the schedule deletion.
UnauthorizedOperation	Unauthorized operation.