Product Introduction

Product Overview

Product Strengths

Use Cases

Concepts

Purchase Guide

Billing Overview

Purchase Method

Renewal Instructions

Payment Overdue

Console Guide

Getting Started

Key Management

Access Control

Audit

TCCLI Management Guide

Operation Overview

Creating Key

Viewing Key

Editing Key

Enabling/Disabling Key

Key Rotation

Encryption and Decryption

Asymmetric key decryption

Deleting Key

Practical Tutorial

Symmetrical Encryption and Decryption

Asymmetric Encryption and Decryption

Post-Quantum Cryptography Practice In KMS

Importing External Key

Implementing Exponential Backoff to Deal with Service Frequency

Cloud Product Integration with KMS for Transparent Encryption

API documentation

History

Introduction

API Category

Key APIs

Making API Requests

Asymmetric Key APIs

Data Types

Error Codes

Service Level Agreement

FAQS

FAQs

General

KMS Policy

Data Processing And Security Agreement

Glossary

ScheduleKeyDeletion

PDF

Focus Mode

Font Size

Last updated: 2026-03-18 14:14:13

1. API Description

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

CMK planned deletion API, used to specify the time of CMK deletion, the optional time interval is [7,30] days

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: ScheduleKeyDeletion.
Version	Yes	String	Common Params. The value used for this API: 2019-01-18.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
KeyId	Yes	String	Unique CMK ID
PendingWindowInDays	Yes	Integer	Schedule deletion time range. Value range: [7,30]
MemberAccount	No	MemberAccount	Trusted service member account information. valid at that time when the current account is admin or delegated admin.

3. Output Parameters

Parameter Name	Type	Description
DeletionDate	Integer	Schedule deletion execution time
KeyId	String	Unique ID of the CMK scheduled for deletion
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Scheduling deletion

This example shows you how to delete a specified CMK on the 7th day upon schedule deletion.

Input Example

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

{
    "PendingWindowInDays": "7",
    "KeyId": "\"23e80852-1e38-11e9-b129-5cb9019b4b01\""
}

Output Example

{
    "Response": {
        "RequestId": "8e8f23a7-50b2-4c8e-bd23-0a98cb643f88",
        "DeletionDate": 1559318399,
        "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

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
FailedOperation.CmkUsedByCloudProduct	The CMK is being used by a Tencent Cloud product.
InternalError	Internal error.
InvalidParameter.InvalidPendingWindowInDays	The schedule deletion time parameter is invalid.
InvalidParameterValue.InvalidKeyId	Invalid `KeyId`.
ResourceUnavailable.CmkNotFound	The CMK does not exist.
ResourceUnavailable.CmkShouldBeDisabled	An enabled CMK cannot be scheduled for deletion.
ResourceUnavailable.CmkStateNotSupport	This operation cannot be performed under the current CMK status.
UnauthorizedOperation	Unauthorized operation.
UnsupportedOperation.NotRoleOperation	Unsupported operations for user roles.
UnsupportedOperation.ServiceTemporaryUnavailable	The service is temporarily unavailable.

Help and Support

Was this page helpful?

You can also Contact sales or Submit a Ticket for help.

Help us improve! Rate your documentation experience in 5 mins.

Feedback

tencent cloud

Key Management Service