<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">描述</strong></p> <p class="p">申请删除一个指定的主用户密钥（CMK）。</p> <div class="note note note_note"><span class="note__title">说明：</span> <ul class="ul" id="ScheduleKeyDeletion__ul_zt2_fcj_mlb"> <li class="li">在密钥预删除期间，该密钥状态为待删除状态，处于待删除状态的密钥不能进行加解密操作。</li> <li class="li">一旦某一个主用户密钥被删除后将无法进行恢复操作，从而导致利用该主用户密钥进行加密后的数据内容以及产生的数据密钥（DataKey）均无法再被解密。所以我们采用预申请删除主用户密钥的方式，不采用直接删除主用户密钥的方式，并且我们建议您尽可能选择密钥禁用功能。</li> <li class="li">指定预删除周期，最少为7天。到达删除周期之前，可以通过API接口cancelKeyDeletion取消计划密钥删除。密钥会在到达预删除时间后的24小时内被删除。</li> </ul> </div> <p class="p"><strong class="ph b">请求参数</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">名称</th> <th class="entry" id="ScheduleKeyDeletion__table_a52_fcj_mlb__entry__2">类型</th> <th class="entry" id="ScheduleKeyDeletion__table_a52_fcj_mlb__entry__3">是否必需</th> <th class="entry" id="ScheduleKeyDeletion__table_a52_fcj_mlb__entry__4">描述</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">是</p> </td> <td class="entry" headers="ScheduleKeyDeletion__table_a52_fcj_mlb__entry__4 "> <p class="p">密钥的全局唯一标识符</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">是</p> </td> <td class="entry" headers="ScheduleKeyDeletion__table_a52_fcj_mlb__entry__4 "> <p class="p">密钥预删除周期。在这段时间内，您可以撤销删除处于待删除状态的密钥；预删除时间过后无法撤销删除。取值范围是7~30。</p> </td> </tr> </tbody></table> <p class="p"><strong class="ph b">返回参数</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">名称</th> <th class="entry" id="ScheduleKeyDeletion__table_b52_fcj_mlb__entry__2">类型</th> <th class="entry" id="ScheduleKeyDeletion__table_b52_fcj_mlb__entry__3">描述</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">返回码，成功返回"SUCCESS"</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</p> </td> </tr> </tbody></table> <p class="p"><strong class="ph b">请求示例</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">返回示例</strong></p> <pre class="pre codeblock"><code>{ "code": "SUCCESS", "requestId": "f19a82df-f0a3-4b5f-83e0-c37bd117e0e0" }</code></pre> </section>