International
中国站
Console
PrevNext
search by keyword

Recent Pages

Documentation
Key Management Service
    Documentation
    Download PDF

    ScheduleKeyDeletion

    Last updated: 2020-12-02 11:27:26
    Download PDF

    1. API Description

    Domain name for API request: kms.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 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: ScheduleKeyDeletion.
    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 CMK ID
    PendingWindowInDays Yes Integer Schedule deletion time range. Value range: [7,30]

    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, which is returned for each request. 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 scheduled deletion.

    Input Example

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

    Output Example

    {
  "Response": {
    "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

    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.ServiceTemporaryUnavailable The service is temporarily unavailable.
    tencent
    Copyright © 2013-2021 Tencent Cloud. All Rights Reserved.
    Privacy PolicyTerms of ServiceCookie Policy