forked from docs/doc-exports
Li, Qiao
dfe65b9551
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>
174 lines
16 KiB
HTML
174 lines
16 KiB
HTML
<a name="kms_02_0014"></a><a name="kms_02_0014"></a>
|
|
|
|
<h1 class="topictitle1">Disabling a CMK</h1>
|
|
<div id="body1474684560495"><div class="section" id="kms_02_0014__en-us_topic_0112992300_s1731a14fb0144c79bf0fa90c694f34f7"><h4 class="sectiontitle">Function</h4><p id="kms_02_0014__en-us_topic_0112992300_en-us_topic_0020091565_p23115188">This API allows you to disable a CMK. A disabled CMK cannot be used.</p>
|
|
<div class="note" id="kms_02_0014__en-us_topic_0112992300_note587453316"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="kms_02_0014__en-us_topic_0112992300_p1681345138">Only an enabled CMK can be disabled.</p>
|
|
</div></div>
|
|
</div>
|
|
<div class="section" id="kms_02_0014__en-us_topic_0112992300_se70c3e5518a04f60b06032524dddfef4"><h4 class="sectiontitle">URI</h4><ul id="kms_02_0014__en-us_topic_0112992300_en-us_topic_0020091565_ul60390938"><li id="kms_02_0014__en-us_topic_0112992300_en-us_topic_0020091565_li6647531">URI format<p id="kms_02_0014__en-us_topic_0112992300_p138073181080"><a name="kms_02_0014__en-us_topic_0112992300_en-us_topic_0020091565_li6647531"></a><a name="en-us_topic_0112992300_en-us_topic_0020091565_li6647531"></a>POST /v1.0/{project_id}/kms/disable-key</p>
|
|
</li><li id="kms_02_0014__en-us_topic_0112992300_en-us_topic_0020091565_li14211994">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0014__en-us_topic_0112992300_t982da1e0196d4ec1a28d1fbff2cc8191" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters</caption><thead align="left"><tr id="kms_02_0014__en-us_topic_0112992300_r6e963322c1e740d181726d2f0e91df5a"><th align="left" class="cellrowborder" valign="top" width="19.170000000000005%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="kms_02_0014__en-us_topic_0112992300_a3b5bbe5a7f644fd3a74cecbfb3f7ed60"><strong id="kms_02_0014__en-us_topic_0112992300_b84235270617744">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="22.180000000000003%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="kms_02_0014__en-us_topic_0112992300_ad98d2f62bd064b4e96ea922645197c24"><strong id="kms_02_0014__en-us_topic_0112992300_b84235270617750">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.610000000000003%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="kms_02_0014__en-us_topic_0112992300_a3becf0b3aec9468984c2efc8d5abbea5">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40.040000000000006%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="kms_02_0014__en-us_topic_0112992300_a6bb6f1fe56a2454982832e8d56d354d8">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="kms_02_0014__en-us_topic_0112992300_r69bf37b65d3f446eab7b3f4d1b2fcec0"><td class="cellrowborder" valign="top" width="19.170000000000005%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="kms_02_0014__en-us_topic_0112992300_ae42d73592f58424ea93a11e52d2478dd">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.180000000000003%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="kms_02_0014__en-us_topic_0112992300_a56440c0f0ae34ba3b8033d1247673984">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.610000000000003%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="kms_02_0014__en-us_topic_0112992300_a1a4a71c11a4a45a58d0de2fbe009e9d9">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.040000000000006%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="kms_02_0014__en-us_topic_0112992300_a1314869d2dc147b38461e037d622f7b4">Project ID</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="kms_02_0014__en-us_topic_0112992300_seb7b7901701247fab30a59b76f1c7f93"><h4 class="sectiontitle">Requests</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0014__en-us_topic_0112992300_table46221022101230" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="kms_02_0014__en-us_topic_0112992300_row9315574101230"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.3.2.2.5.1.1"><p id="kms_02_0014__en-us_topic_0112992300_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_0014__en-us_topic_0112992300_p57514295101230"><strong id="kms_02_0014__en-us_topic_0112992300_b84235270617821">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_0014__en-us_topic_0112992300_p50420322101230"><strong id="kms_02_0014__en-us_topic_0112992300_b84235270617818">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_0014__en-us_topic_0112992300_p28146304101230">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="kms_02_0014__en-us_topic_0112992300_row2638193101722"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.2.5.1.1 "><p id="kms_02_0014__en-us_topic_0112992300_p41908563105428">key_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.5.1.2 "><p id="kms_02_0014__en-us_topic_0112992300_p17072096105428">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.2.5.1.3 "><p id="kms_02_0014__en-us_topic_0112992300_p39150477105428">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.2.5.1.4 "><p id="kms_02_0014__en-us_topic_0112992300_p65699359161410">36-byte ID of a CMK that matches the regular expression <span class="parmvalue" id="kms_02_0014__en-us_topic_0112992300_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_0014__en-us_topic_0112992300_p40662515105428">Example: 0d0466b0-e727-4d9c-b35d-f84bb474a37f</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0014__en-us_topic_0112992300_row35142504101726"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.2.5.1.1 "><p id="kms_02_0014__en-us_topic_0112992300_p269135101746">sequence</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.5.1.2 "><p id="kms_02_0014__en-us_topic_0112992300_p20967256101746">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.2.5.1.3 "><p id="kms_02_0014__en-us_topic_0112992300_p21799971101746">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.2.5.1.4 "><p id="kms_02_0014__en-us_topic_0112992300_p833612113227">36-byte serial number of a request message</p>
|
|
<p id="kms_02_0014__en-us_topic_0112992300_p20626198101746">Example: 919c82d4-8046-4722-9094-35c3c6524cff</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="kms_02_0014__en-us_topic_0112992300_sfadd53a5f4714e8f87811818d62d0296"><h4 class="sectiontitle">Responses</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0014__en-us_topic_0112992300_table7517184618545" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameters</caption><thead align="left"><tr id="kms_02_0014__en-us_topic_0112992300_row55181746125413"><th align="left" class="cellrowborder" valign="top" width="18.04%" id="mcps1.3.4.2.2.5.1.1"><p id="kms_02_0014__en-us_topic_0112992300_p1151811468544">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.67%" id="mcps1.3.4.2.2.5.1.2"><p id="kms_02_0014__en-us_topic_0112992300_p145186465549">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.35%" id="mcps1.3.4.2.2.5.1.3"><p id="kms_02_0014__en-us_topic_0112992300_p13518194615547">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="49.94%" id="mcps1.3.4.2.2.5.1.4"><p id="kms_02_0014__en-us_topic_0112992300_p18518194625416">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="kms_02_0014__en-us_topic_0112992300_row951818462548"><td class="cellrowborder" valign="top" width="18.04%" headers="mcps1.3.4.2.2.5.1.1 "><p id="kms_02_0014__en-us_topic_0112992300_p1651844612541">key_info</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.67%" headers="mcps1.3.4.2.2.5.1.2 "><p id="kms_02_0014__en-us_topic_0112992300_p7518184665412">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.35%" headers="mcps1.3.4.2.2.5.1.3 "><p id="kms_02_0014__en-us_topic_0112992300_p165181046115411">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.94%" headers="mcps1.3.4.2.2.5.1.4 "><p id="kms_02_0014__en-us_topic_0112992300_p85181246135416">Information about keys. For details, see <a href="#kms_02_0014__en-us_topic_0112992300_t98d238e10953421e84a073707024c329">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="kms_02_0014__en-us_topic_0112992300_t98d238e10953421e84a073707024c329"></a><a name="en-us_topic_0112992300_t98d238e10953421e84a073707024c329"></a><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0014__en-us_topic_0112992300_t98d238e10953421e84a073707024c329" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="kms_02_0014__en-us_topic_0112992300_b17191418105914">key_info</strong> field description</caption><thead align="left"><tr id="kms_02_0014__en-us_topic_0112992300_r144a2c52c5054c6d9243eb2ef3875a21"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.4.3.2.5.1.1"><p id="kms_02_0014__en-us_topic_0112992300_a9156e0b03f054d4e8547e0787f88a51b">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.4.3.2.5.1.2"><p id="kms_02_0014__en-us_topic_0112992300_a1851157c81e14d7f82db752a5737195a">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.4.3.2.5.1.3"><p id="kms_02_0014__en-us_topic_0112992300_a39360acf5daf4c01a1ebddeff5d68a1c"><strong id="kms_02_0014__en-us_topic_0112992300_b8423527061793">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.5.1.4"><p id="kms_02_0014__en-us_topic_0112992300_a0097000016b14857972b7929bcaaa038">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="kms_02_0014__en-us_topic_0112992300_r3c4af7b36e9240d197ab56255e37b83c"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.1 "><p id="kms_02_0014__en-us_topic_0112992300_p43705601102713">key_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.3.2.5.1.2 "><p id="kms_02_0014__en-us_topic_0112992300_p63384753102713">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.3 "><p id="kms_02_0014__en-us_topic_0112992300_p50492797102713">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.5.1.4 "><p id="kms_02_0014__en-us_topic_0112992300_p33891398102713">CMK ID</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0014__en-us_topic_0112992300_rf212a916c502452a8e151eba2f118272"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.1 "><p id="kms_02_0014__en-us_topic_0112992300_p35452559105521">key_state</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.3.2.5.1.2 "><p id="kms_02_0014__en-us_topic_0112992300_p4922216105521">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.3 "><p id="kms_02_0014__en-us_topic_0112992300_p53085055105521">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.5.1.4 "><p id="kms_02_0014__en-us_topic_0112992300_p63155185105521">CMK status:</p>
|
|
<ul id="kms_02_0014__en-us_topic_0112992300_ul38541215195435"><li id="kms_02_0014__en-us_topic_0112992300_li28636169195440"><span class="parmvalue" id="kms_02_0014__en-us_topic_0112992300_parmvalue555125744163642"><b>2</b></span> indicates that the CMK is enabled.</li><li id="kms_02_0014__en-us_topic_0112992300_li26805340195444"><span class="parmvalue" id="kms_02_0014__en-us_topic_0112992300_parmvalue890467586163649"><b>3</b></span> indicates that the CMK is disabled.</li><li id="kms_02_0014__en-us_topic_0112992300_li12152497195435"><span class="parmvalue" id="kms_02_0014__en-us_topic_0112992300_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_0014__en-us_topic_0112992300_section7178111660"><h4 class="sectiontitle">Examples</h4><p id="kms_02_0014__en-us_topic_0112992300_p132018269614">The following example describes how to disable a CMK whose ID is <span class="parmvalue" id="kms_02_0014__en-us_topic_0112992300_parmvalue19739413241729"><b>0d0466b0-e727-4d9c-b35d-f84bb474a37f</b></span>.</p>
|
|
<ul id="kms_02_0014__en-us_topic_0112992300_ul8371011763"><li id="kms_02_0014__en-us_topic_0112992300_li15377111167">Example request<pre class="screen" id="kms_02_0014__en-us_topic_0112992300_screen11374118612">{
|
|
"key_id": "0d0466b0-e727-4d9c-b35d-f84bb474a37f"
|
|
}</pre>
|
|
</li><li id="kms_02_0014__en-us_topic_0112992300_li1837161110613">Example response<pre class="screen" id="kms_02_0014__en-us_topic_0112992300_screen837101118613">{
|
|
"key_info": {
|
|
"key_id": "0d0466b0-e727-4d9c-b35d-f84bb474a37f",
|
|
"key_state": "3"
|
|
}
|
|
}</pre>
|
|
<p id="kms_02_0014__en-us_topic_0112992300_p43713113615">or</p>
|
|
<pre class="screen" id="kms_02_0014__en-us_topic_0112992300_screen93719116612">{
|
|
"error": {
|
|
"error_code": "KMS.XXXX",
|
|
"error_msg": "XXX"
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="kms_02_0014__en-us_topic_0112992300_section3454223421"><h4 class="sectiontitle">Status Codes</h4><div class="p" id="kms_02_0014__en-us_topic_0112992300_en-us_topic_0112992294_en-us_topic_0079615001_p17772351"><a href="#kms_02_0014__en-us_topic_0112992300_en-us_topic_0112992294_en-us_topic_0079615001_table20596071">Table 5</a> lists the normal status code returned by the response.
|
|
<div class="tablenoborder"><a name="kms_02_0014__en-us_topic_0112992300_en-us_topic_0112992294_en-us_topic_0079615001_table20596071"></a><a name="en-us_topic_0112992300_en-us_topic_0112992294_en-us_topic_0079615001_table20596071"></a><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0014__en-us_topic_0112992300_en-us_topic_0112992294_en-us_topic_0079615001_table20596071" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Status codes</caption><thead align="left"><tr id="kms_02_0014__en-us_topic_0112992300_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_0014__en-us_topic_0112992300_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_0014__en-us_topic_0112992300_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_0014__en-us_topic_0112992300_en-us_topic_0112992294_p30689603203043">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="kms_02_0014__en-us_topic_0112992300_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_0014__en-us_topic_0112992300_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_0014__en-us_topic_0112992300_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_0014__en-us_topic_0112992300_en-us_topic_0112992294_p1885682315512">Request processed successfully.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<p id="kms_02_0014__en-us_topic_0112992300_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>
|
|
|