tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CancelKeyDeletion

Last updated: 2023-03-24 16:02:41

1. API Description

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

Cancel the scheduled deletion of CMK

A maximum of 100 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 Params. The value used for this API: CancelKeyDeletion.
Version Yes String Common Params. The value used for this API: 2019-01-18.
Region No String Common Params. This parameter is not required for this API.
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 a scheduled deletion task

This example shows you how to cancel a scheduled deletion task of a CMK.

Input Example

POST / HTTP/1.1
Host: kms.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CancelKeyDeletion
<Common request parameters>

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

Output Example

{
    "Response": {
        "RequestId": "8e8f23a7-50b2-4c8e-bd23-0a98cb643f88",
        "KeyId": "23e80852-1e38-11e9-b129-5cb9019b4b01"
    }
}

5. Developer Resources

SDK

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

Command Line Interface

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.
UnsupportedOperation.ServiceTemporaryUnavailable The service is temporarily unavailable.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy