ScheduleDataKeyDeletion

最后更新时间：2025-12-04 15:44:08

ScheduleDataKeyDeletion

最后更新时间： 2025-12-04 15:44:08

1. API Description

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

Schedule deletion for a data key.

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 Params. The value used for this API: ScheduleDataKeyDeletion.
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.
DataKeyId	Yes	String	Unique id of a data key.
PendingWindowInDays	Yes	Integer	Schedule deletion time range: [7,30].

3. Output Parameters

Parameter Name	Type	Description
DeletionDate	Integer	Schedule deletion execution time.
DataKeyId	String	Unique identifier of the data key 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 Example of Scheduling a Data Key for Deletion

Schedule deletion for a data key

Input Example

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

{
    "DataKeyId": "2a87094f-4c0e-11f0-8c25-52540073b995",
    "PendingWindowInDays": 7
}

Output Example

{
    "Response": {
        "DataKeyId": "2a87094f-4c0e-11f0-8c25-52540073b995",
        "DeletionDate": 1751276581,
        "RequestId": "f610236f-580d-49d3-a766-71163d9108eb"
    }
}

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
InternalError	Internal error.
InvalidParameter.InvalidPendingWindowInDays	The schedule deletion time parameter is invalid.
InvalidParameterValue.InvalidDataKeyId	Invalid data key ID.
ResourceUnavailable.DataKeyNotFound	The data key does not exist.
ResourceUnavailable.DataKeyStateNotSupport	Data operation is not supported for the data key status.

本页内容是否解决了您的问题？

您也可以联系销售或提交工单以寻求帮助。

是

否

文档反馈

tencent cloud