<p class="shortdesc"></p> <section class="section" id="ScheduleKeyDeletion__section_qtk_2cj_mlb"><h2 class="doc-tairway">ScheduleKeyDeletion </h2> <p class="p"><strong class="ph b">Description</strong></p> <p class="p">Scheduling the deletion of a specified customer master key (CMK). </p> <div class="note note note_note"><span class="note__title">Note:</span> <ul class="ul" id="ScheduleKeyDeletion__ul_zt2_fcj_mlb"> <li class="li">During the scheduled deletion period, the CMK is pending deletion. You cannot use a CMK that is pending deletion in any cryptographic operations. </li> <li class="li">You cannot restore a CMK once it is deleted. As a result, you can no longer decrypt the data encrypted under and the data keys generated by that CMK. Therefore, KMS offers scheduled key deletion instead of instant key deletion. We recommend that you disable a CMK rather than deleting it. </li> <li class="li">The minimum number of days for scheduled key deletion is seven. Before the scheduled deletion period expires, you can cancel the deletion through the cancelKeyDeletion API. KMS deletes the CMK within 24 hours after the scheduled deletion period expires. </li> </ul> </div> <p class="p"><strong class="ph b">Request Parameters</strong></p> <table class="table" id="ScheduleKeyDeletion__table_a52_fcj_mlb"><caption></caption><colgroup><col><col><col><col></colgroup><thead class="thead"> <tr class="row"> <th class="entry" id="ScheduleKeyDeletion__table_a52_fcj_mlb__entry__1">Name </th> <th class="entry" id="ScheduleKeyDeletion__table_a52_fcj_mlb__entry__2">Type </th> <th class="entry" id="ScheduleKeyDeletion__table_a52_fcj_mlb__entry__3">Necessary or Not </th> <th class="entry" id="ScheduleKeyDeletion__table_a52_fcj_mlb__entry__4">Description </th> </tr> </thead><tbody class="tbody"> <tr class="row"> <td class="entry" headers="ScheduleKeyDeletion__table_a52_fcj_mlb__entry__1 "> <p class="p">keyId </p> </td> <td class="entry" headers="ScheduleKeyDeletion__table_a52_fcj_mlb__entry__2 "> <p class="p">String </p> </td> <td class="entry" headers="ScheduleKeyDeletion__table_a52_fcj_mlb__entry__3 "> <p class="p">Yes </p> </td> <td class="entry" headers="ScheduleKeyDeletion__table_a52_fcj_mlb__entry__4 "> <p class="p">Globally unique identifier of the CMK. </p> </td> </tr> <tr class="row"> <td class="entry" headers="ScheduleKeyDeletion__table_a52_fcj_mlb__entry__1 "> <p class="p">pendingWindowInDays </p> </td> <td class="entry" headers="ScheduleKeyDeletion__table_a52_fcj_mlb__entry__2 "> <p class="p">Integer </p> </td> <td class="entry" headers="ScheduleKeyDeletion__table_a52_fcj_mlb__entry__3 "> <p class="p">Yes </p> </td> <td class="entry" headers="ScheduleKeyDeletion__table_a52_fcj_mlb__entry__4 "> <p class="p">Scheduled key deletion period. You can cancel the deletion of a CMK that is pending deletion within this period; you cannot cancel the deletion after the scheduled period expires. The value range is 7 to 30. </p> </td> </tr> </tbody></table> <p class="p"><strong class="ph b">Return Parameters</strong></p> <table class="table" id="ScheduleKeyDeletion__table_b52_fcj_mlb"><caption></caption><colgroup><col><col><col></colgroup><thead class="thead"> <tr class="row"> <th class="entry" id="ScheduleKeyDeletion__table_b52_fcj_mlb__entry__1">Name </th> <th class="entry" id="ScheduleKeyDeletion__table_b52_fcj_mlb__entry__2">Type </th> <th class="entry" id="ScheduleKeyDeletion__table_b52_fcj_mlb__entry__3">Description </th> </tr> </thead><tbody class="tbody"> <tr class="row"> <td class="entry" headers="ScheduleKeyDeletion__table_b52_fcj_mlb__entry__1 "> <p class="p">code </p> </td> <td class="entry" headers="ScheduleKeyDeletion__table_b52_fcj_mlb__entry__2 "> <p class="p">String </p> </td> <td class="entry" headers="ScheduleKeyDeletion__table_b52_fcj_mlb__entry__3 "> <p class="p">Return code. “SUCCESS” will be returned if the request is succeeded. </p> </td> </tr> <tr class="row"> <td class="entry" headers="ScheduleKeyDeletion__table_b52_fcj_mlb__entry__1 "> <p class="p">requestId </p> </td> <td class="entry" headers="ScheduleKeyDeletion__table_b52_fcj_mlb__entry__2 "> <p class="p">String </p> </td> <td class="entry" headers="ScheduleKeyDeletion__table_b52_fcj_mlb__entry__3 "> <p class="p">ID of the current request. </p> </td> </tr> </tbody></table> <p class="p"><strong class="ph b">Request Example</strong></p> <pre class="pre codeblock"><code>https://kms-cn-shanghai.yun.pingan.com/?action=ScheduleKeyDeletion &pendingWindowInDays=<pendingWindowInDays> &keyId=<cmkid> &<公共请求参数> </code></pre> <p class="p"><strong class="ph b">Return Example</strong></p> <pre class="pre codeblock"><code>{ "code": "SUCCESS", "requestId": "f19a82df-f0a3-4b5f-83e0-c37bd117e0e0" } </code></pre> </section>