vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/kms/api-ref/kms_02_0015.html
Li, Qiao dfe65b9551 KMS API 20230817 version. 
Reviewed-by: Belejkanic, Lukas <lukas.belejkanic@t-systems.com>
Co-authored-by: Li, Qiao <qiaoli@huawei.com>
Co-committed-by: Li, Qiao <qiaoli@huawei.com>
2024-04-02 13:42:22 +00:00

157 lines
15 KiB
HTML
Raw Blame History

<a name="kms_02_0015"></a><a name="kms_02_0015"></a>
<h1 class="topictitle1">Scheduling the Deletion of a CMK</h1>
<div id="body1474684560505"><div class="section" id="kms_02_0015__en-us_topic_0112992297_s1731a14fb0144c79bf0fa90c694f34f7"><h4 class="sectiontitle">Function</h4><p id="kms_02_0015__en-us_topic_0112992297_en-us_topic_0020091565_p23115188">This API enables you to schedule the deletion of a CMK. A CMK can be scheduled to be deleted after 7 to 1096 days.</p>
</div>
<div class="section" id="kms_02_0015__en-us_topic_0112992297_se70c3e5518a04f60b06032524dddfef4"><h4 class="sectiontitle">URI</h4><ul id="kms_02_0015__en-us_topic_0112992297_en-us_topic_0020091565_ul60390938"><li id="kms_02_0015__en-us_topic_0112992297_en-us_topic_0020091565_li6647531">URI format<p id="kms_02_0015__en-us_topic_0112992297_p138073181080"><a name="kms_02_0015__en-us_topic_0112992297_en-us_topic_0020091565_li6647531"></a><a name="en-us_topic_0112992297_en-us_topic_0020091565_li6647531"></a>POST /v1.0/{project_id}/kms/schedule-key-deletion</p>
</li><li id="kms_02_0015__en-us_topic_0112992297_en-us_topic_0020091565_li14211994">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0015__en-us_topic_0112992297_t982da1e0196d4ec1a28d1fbff2cc8191" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters</caption><thead align="left"><tr id="kms_02_0015__en-us_topic_0112992297_r6e963322c1e740d181726d2f0e91df5a"><th align="left" class="cellrowborder" valign="top" width="22.74%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="kms_02_0015__en-us_topic_0112992297_a3b5bbe5a7f644fd3a74cecbfb3f7ed60"><strong id="kms_02_0015__en-us_topic_0112992297_b84235270617131">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.37%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="kms_02_0015__en-us_topic_0112992297_ad98d2f62bd064b4e96ea922645197c24"><strong id="kms_02_0015__en-us_topic_0112992297_b84235270617135">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.1%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="kms_02_0015__en-us_topic_0112992297_a3becf0b3aec9468984c2efc8d5abbea5">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="37.79%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="kms_02_0015__en-us_topic_0112992297_a6bb6f1fe56a2454982832e8d56d354d8">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="kms_02_0015__en-us_topic_0112992297_r69bf37b65d3f446eab7b3f4d1b2fcec0"><td class="cellrowborder" valign="top" width="22.74%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="kms_02_0015__en-us_topic_0112992297_ae42d73592f58424ea93a11e52d2478dd">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="22.37%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="kms_02_0015__en-us_topic_0112992297_a56440c0f0ae34ba3b8033d1247673984">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.1%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="kms_02_0015__en-us_topic_0112992297_a1a4a71c11a4a45a58d0de2fbe009e9d9">String</p>
</td>
<td class="cellrowborder" valign="top" width="37.79%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="kms_02_0015__en-us_topic_0112992297_a1314869d2dc147b38461e037d622f7b4">Project ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="kms_02_0015__en-us_topic_0112992297_seb7b7901701247fab30a59b76f1c7f93"><h4 class="sectiontitle">Requests</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0015__en-us_topic_0112992297_table46221022101230" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="kms_02_0015__en-us_topic_0112992297_row9315574101230"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.3.2.2.5.1.1"><p id="kms_02_0015__en-us_topic_0112992297_p16364058101230">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.3.2.2.5.1.2"><p id="kms_02_0015__en-us_topic_0112992297_p57514295101230"><strong id="kms_02_0015__en-us_topic_0112992297_b842352706171349">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.3.2.2.5.1.3"><p id="kms_02_0015__en-us_topic_0112992297_p50420322101230"><strong id="kms_02_0015__en-us_topic_0112992297_b842352706171341">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.2.2.5.1.4"><p id="kms_02_0015__en-us_topic_0112992297_p28146304101230">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="kms_02_0015__en-us_topic_0112992297_row57603225101653"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.2.5.1.1 "><p id="kms_02_0015__en-us_topic_0112992297_p36087066115218">key_id</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.5.1.2 "><p id="kms_02_0015__en-us_topic_0112992297_p7169794115218">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.2.5.1.3 "><p id="kms_02_0015__en-us_topic_0112992297_p37371218115218">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.2.5.1.4 "><p id="kms_02_0015__en-us_topic_0112992297_p19381341173132">36-byte ID of a CMK that matches the regular expression <span class="parmvalue" id="kms_02_0015__en-us_topic_0112992297_parmvalue80435593163333"><b>^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$</b></span></p>
<p id="kms_02_0015__en-us_topic_0112992297_p43882451115218">Example: 0d0466b0-e727-4d9c-b35d-f84bb474a37f</p>
</td>
</tr>
<tr id="kms_02_0015__en-us_topic_0112992297_row2638193101722"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.2.5.1.1 "><p id="kms_02_0015__en-us_topic_0112992297_p19049283115226">pending_days</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.5.1.2 "><p id="kms_02_0015__en-us_topic_0112992297_p25641212115226">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.2.5.1.3 "><p id="kms_02_0015__en-us_topic_0112992297_p66596917115226">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.2.5.1.4 "><p id="kms_02_0015__en-us_topic_0112992297_p63672320115226">Number of days after which a CMK is scheduled to be deleted (The value ranges from <span class="parmvalue" id="kms_02_0015__en-us_topic_0112992297_parmvalue555125744172652"><b>7</b></span> to <span class="parmvalue" id="kms_02_0015__en-us_topic_0112992297_parmvalue55512574417270"><b>1096</b></span>.)</p>
</td>
</tr>
<tr id="kms_02_0015__en-us_topic_0112992297_row35142504101726"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.2.5.1.1 "><p id="kms_02_0015__en-us_topic_0112992297_p269135101746">sequence</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.5.1.2 "><p id="kms_02_0015__en-us_topic_0112992297_p20967256101746">No</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.2.5.1.3 "><p id="kms_02_0015__en-us_topic_0112992297_p21799971101746">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.2.5.1.4 "><p id="kms_02_0015__en-us_topic_0112992297_p12309878173138">36-byte serial number of a request message</p>
<p id="kms_02_0015__en-us_topic_0112992297_p20626198101746">Example: 919c82d4-8046-4722-9094-35c3c6524cff</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="kms_02_0015__en-us_topic_0112992297_sfadd53a5f4714e8f87811818d62d0296"><h4 class="sectiontitle">Responses</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0015__en-us_topic_0112992297_t98d238e10953421e84a073707024c329" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameters</caption><thead align="left"><tr id="kms_02_0015__en-us_topic_0112992297_r144a2c52c5054c6d9243eb2ef3875a21"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.4.2.2.5.1.1"><p id="kms_02_0015__en-us_topic_0112992297_a9156e0b03f054d4e8547e0787f88a51b">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.4.2.2.5.1.2"><p id="kms_02_0015__en-us_topic_0112992297_a1851157c81e14d7f82db752a5737195a"><strong id="kms_02_0015__en-us_topic_0112992297_b842352706171422">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.4.2.2.5.1.3"><p id="kms_02_0015__en-us_topic_0112992297_a39360acf5daf4c01a1ebddeff5d68a1c"><strong id="kms_02_0015__en-us_topic_0112992297_b842352706171418">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.2.2.5.1.4"><p id="kms_02_0015__en-us_topic_0112992297_a0097000016b14857972b7929bcaaa038">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="kms_02_0015__en-us_topic_0112992297_r3c4af7b36e9240d197ab56255e37b83c"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.2.5.1.1 "><p id="kms_02_0015__en-us_topic_0112992297_p43705601102713">key_id</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.2.2.5.1.2 "><p id="kms_02_0015__en-us_topic_0112992297_p63384753102713">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.2.5.1.3 "><p id="kms_02_0015__en-us_topic_0112992297_p50492797102713">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.5.1.4 "><p id="kms_02_0015__en-us_topic_0112992297_p33891398102713">CMK ID</p>
</td>
</tr>
<tr id="kms_02_0015__en-us_topic_0112992297_rf212a916c502452a8e151eba2f118272"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.2.5.1.1 "><p id="kms_02_0015__en-us_topic_0112992297_p39475323115255">key_state</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.2.2.5.1.2 "><p id="kms_02_0015__en-us_topic_0112992297_p24490295115255">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.2.5.1.3 "><p id="kms_02_0015__en-us_topic_0112992297_p43384583115255">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.5.1.4 "><p id="kms_02_0015__en-us_topic_0112992297_p37556851115255">CMK status:</p>
<ul id="kms_02_0015__en-us_topic_0112992297_ul38541215195435"><li id="kms_02_0015__en-us_topic_0112992297_li28636169195440"><span class="parmvalue" id="kms_02_0015__en-us_topic_0112992297_parmvalue555125744163642"><b>2</b></span> indicates that the CMK is enabled.</li><li id="kms_02_0015__en-us_topic_0112992297_li26805340195444"><span class="parmvalue" id="kms_02_0015__en-us_topic_0112992297_parmvalue890467586163649"><b>3</b></span> indicates that the CMK is disabled.</li><li id="kms_02_0015__en-us_topic_0112992297_li12152497195435"><span class="parmvalue" id="kms_02_0015__en-us_topic_0112992297_parmvalue7929059216370"><b>4</b></span> indicates that the CMK is scheduled for deletion.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="kms_02_0015__en-us_topic_0112992297_section156913331184"><h4 class="sectiontitle">Examples</h4><p id="kms_02_0015__en-us_topic_0112992297_p1830017471788">The following example describes how to schedule deletion of a CMK whose ID is <span class="parmvalue" id="kms_02_0015__en-us_topic_0112992297_parmvalue19739413241729"><b>0d0466b0-e727-4d9c-b35d-f84bb474a37f</b></span>.</p>
<ul id="kms_02_0015__en-us_topic_0112992297_ul759112331084"><li id="kms_02_0015__en-us_topic_0112992297_li155887334814">Example request<pre class="screen" id="kms_02_0015__en-us_topic_0112992297_screen5588633688">{
"key_id": "0d0466b0-e727-4d9c-b35d-f84bb474a37f",
"pending_days": "7"
}</pre>
</li><li id="kms_02_0015__en-us_topic_0112992297_li85914331812">Example response<pre class="screen" id="kms_02_0015__en-us_topic_0112992297_screen1558815334810">{
"key_id": "0d0466b0-e727-4d9c-b35d-f84bb474a37f",
"key_state": "4"
}</pre>
<p id="kms_02_0015__en-us_topic_0112992297_p85889331385">or</p>
<pre class="screen" id="kms_02_0015__en-us_topic_0112992297_screen135915331186">{
"error": {
"error_code": "KMS.XXXX",
"error_msg": "XXX"
}
}</pre>
</li></ul>
</div>
<div class="section" id="kms_02_0015__en-us_topic_0112992297_section3454223421"><h4 class="sectiontitle">Status Codes</h4><div class="p" id="kms_02_0015__en-us_topic_0112992297_en-us_topic_0112992294_en-us_topic_0079615001_p17772351"><a href="#kms_02_0015__en-us_topic_0112992297_en-us_topic_0112992294_en-us_topic_0079615001_table20596071">Table 4</a> lists the normal status code returned by the response.
<div class="tablenoborder"><a name="kms_02_0015__en-us_topic_0112992297_en-us_topic_0112992294_en-us_topic_0079615001_table20596071"></a><a name="en-us_topic_0112992297_en-us_topic_0112992294_en-us_topic_0079615001_table20596071"></a><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0015__en-us_topic_0112992297_en-us_topic_0112992294_en-us_topic_0079615001_table20596071" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Status codes</caption><thead align="left"><tr id="kms_02_0015__en-us_topic_0112992297_en-us_topic_0112992294_en-us_topic_0079615001_row9746163"><th align="left" class="cellrowborder" valign="top" width="16.16%" id="mcps1.3.6.2.2.2.4.1.1"><p id="kms_02_0015__en-us_topic_0112992297_en-us_topic_0112992294_p57545694203043">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="28.28%" id="mcps1.3.6.2.2.2.4.1.2"><p id="kms_02_0015__en-us_topic_0112992297_en-us_topic_0112992294_p4531342288">Status</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.559999999999995%" id="mcps1.3.6.2.2.2.4.1.3"><p id="kms_02_0015__en-us_topic_0112992297_en-us_topic_0112992294_p30689603203043">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="kms_02_0015__en-us_topic_0112992297_en-us_topic_0112992294_en-us_topic_0079615001_row48621261"><td class="cellrowborder" valign="top" width="16.16%" headers="mcps1.3.6.2.2.2.4.1.1 "><p id="kms_02_0015__en-us_topic_0112992297_en-us_topic_0112992294_en-us_topic_0079615001_p46008046">200</p>
</td>
<td class="cellrowborder" valign="top" width="28.28%" headers="mcps1.3.6.2.2.2.4.1.2 "><p id="kms_02_0015__en-us_topic_0112992297_en-us_topic_0112992294_p7538425819">OK</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.6.2.2.2.4.1.3 "><p id="kms_02_0015__en-us_topic_0112992297_en-us_topic_0112992294_p1885682315512">Request processed successfully.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<p id="kms_02_0015__en-us_topic_0112992297_en-us_topic_0112992294_p5626181018551">Exception status code. For details, see <a href="kms_02_0301.html#kms_02_0301">Status Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0011.html">CMK Management</a></div>
</div>
</div>
View Git Blame Copy Permalink