forked from docs/doc-exports
qiaoli
18397ded73
Reviewed-by: Belejkanic, Lukas <lukas.belejkanic@t-systems.com> Co-authored-by: qiaoli <qiaoli@huawei.com> Co-committed-by: qiaoli <qiaoli@huawei.com>
145 lines
13 KiB
HTML
145 lines
13 KiB
HTML
<a name="kms_02_0040"></a><a name="kms_02_0040"></a>
|
|
|
|
<h1 class="topictitle1">Disabling Rotation for a CMK</h1>
|
|
<div id="body1511418825778"><div class="section" id="kms_02_0040__en-us_topic_0112992347_s1731a14fb0144c79bf0fa90c694f34f7"><h4 class="sectiontitle">Function</h4><p id="kms_02_0040__en-us_topic_0112992347_en-us_topic_0020091565_p23115188">This API allows you to disable rotation for a CMK.</p>
|
|
</div>
|
|
<div class="section" id="kms_02_0040__en-us_topic_0112992347_se70c3e5518a04f60b06032524dddfef4"><h4 class="sectiontitle">URI</h4><ul id="kms_02_0040__en-us_topic_0112992347_en-us_topic_0020091565_ul60390938"><li id="kms_02_0040__en-us_topic_0112992347_en-us_topic_0020091565_li6647531">URI format<p id="kms_02_0040__en-us_topic_0112992347_p138073181080"><a name="kms_02_0040__en-us_topic_0112992347_en-us_topic_0020091565_li6647531"></a><a name="en-us_topic_0112992347_en-us_topic_0020091565_li6647531"></a>POST /v1.0/{project_id}/kms/disable-key-rotation</p>
|
|
</li><li id="kms_02_0040__en-us_topic_0112992347_en-us_topic_0020091565_li14211994">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0040__en-us_topic_0112992347_t982da1e0196d4ec1a28d1fbff2cc8191" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameter</caption><thead align="left"><tr id="kms_02_0040__en-us_topic_0112992347_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_0040__en-us_topic_0112992347_p2739096916511">Parameter</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_0040__en-us_topic_0112992347_p407603016511">Mandatory</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_0040__en-us_topic_0112992347_p6172299916511">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_0040__en-us_topic_0112992347_p3350702116511">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="kms_02_0040__en-us_topic_0112992347_r69bf37b65d3f446eab7b3f4d1b2fcec0"><td class="cellrowborder" valign="top" width="19.170000000000005%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="kms_02_0040__en-us_topic_0112992347_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_0040__en-us_topic_0112992347_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_0040__en-us_topic_0112992347_p4386100291125">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_0040__en-us_topic_0112992347_a1314869d2dc147b38461e037d622f7b4">Project ID</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="kms_02_0040__en-us_topic_0112992347_seb7b7901701247fab30a59b76f1c7f93"><h4 class="sectiontitle">Request Message</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0040__en-us_topic_0112992347_en-us_topic_0000001176937539_HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="kms_02_0040__en-us_topic_0112992347_en-us_topic_0000001176937539_row209291944115219"><th align="left" class="cellrowborder" valign="top" width="20.080000000000002%" id="mcps1.3.3.2.2.5.1.1"><p id="kms_02_0040__en-us_topic_0112992347_en-us_topic_0000001176937539_p17930194414521">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.919999999999998%" id="mcps1.3.3.2.2.5.1.2"><p id="kms_02_0040__en-us_topic_0112992347_en-us_topic_0000001176937539_p15930244195213">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="kms_02_0040__en-us_topic_0112992347_en-us_topic_0000001176937539_p39301444155210">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="kms_02_0040__en-us_topic_0112992347_en-us_topic_0000001176937539_p109301444105220">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="kms_02_0040__en-us_topic_0112992347_en-us_topic_0000001176937539_row1292934416529"><td class="cellrowborder" valign="top" width="20.080000000000002%" headers="mcps1.3.3.2.2.5.1.1 "><p id="kms_02_0040__en-us_topic_0112992347_en-us_topic_0000001176937539_p109311444155211">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.919999999999998%" headers="mcps1.3.3.2.2.5.1.2 "><p id="kms_02_0040__en-us_topic_0112992347_en-us_topic_0000001176937539_p9931104412528">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="kms_02_0040__en-us_topic_0112992347_en-us_topic_0000001176937539_p193104485212">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="kms_02_0040__en-us_topic_0112992347_en-us_topic_0000001176937539_p1093134420527">User token. It can be obtained by calling an IAM API. The value of <strong id="kms_02_0040__en-us_topic_0112992347_b1458774519105154">X-Subject-Token</strong> in the response header is the user token.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0040__en-us_topic_0112992347_row17121816165912"><td class="cellrowborder" valign="top" width="20.080000000000002%" headers="mcps1.3.3.2.2.5.1.1 "><p id="kms_02_0040__en-us_topic_0112992347_p1279425073711">Content-Type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.919999999999998%" headers="mcps1.3.3.2.2.5.1.2 "><p id="kms_02_0040__en-us_topic_0112992347_p2794195010376">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="kms_02_0040__en-us_topic_0112992347_p9794195015373">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="kms_02_0040__en-us_topic_0112992347_p5617163694719">application/json</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0040__en-us_topic_0112992347_table46221022101230" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request parameters</caption><thead align="left"><tr id="kms_02_0040__en-us_topic_0112992347_row9315574101230"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.3.3.2.5.1.1"><p id="kms_02_0040__en-us_topic_0112992347_p842479145612">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.3.3.2.5.1.2"><p id="kms_02_0040__en-us_topic_0112992347_p1442499105614">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.3.3.2.5.1.3"><p id="kms_02_0040__en-us_topic_0112992347_p342459125610">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.3.2.5.1.4"><p id="kms_02_0040__en-us_topic_0112992347_p34241396569">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="kms_02_0040__en-us_topic_0112992347_row2638193101722"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.3.2.5.1.1 "><p id="kms_02_0040__en-us_topic_0112992347_p41908563105428">key_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.3.2.5.1.2 "><p id="kms_02_0040__en-us_topic_0112992347_p17072096105428">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.3.2.5.1.3 "><p id="kms_02_0040__en-us_topic_0112992347_p8728818814">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.3.2.5.1.4 "><p id="kms_02_0040__en-us_topic_0112992347_p21929114422">36-byte key ID that matches the regular expression <span class="parmvalue" id="kms_02_0040__en-us_topic_0112992347_parmvalue20425896574333"><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_0040__en-us_topic_0112992347_p11134104114149">For example, <strong id="kms_02_0040__en-us_topic_0112992347_b6487460134616">0d0466b0-e727-4d9c-b35d-f84bb474a37f</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0040__en-us_topic_0112992347_row35142504101726"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.3.2.5.1.1 "><p id="kms_02_0040__en-us_topic_0112992347_p269135101746">sequence</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.3.2.5.1.2 "><p id="kms_02_0040__en-us_topic_0112992347_p20967256101746">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.3.2.5.1.3 "><p id="kms_02_0040__en-us_topic_0112992347_p05452032083">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.3.2.5.1.4 "><p id="kms_02_0040__en-us_topic_0112992347_p13871143202914">A 36-byte serial number of a request message.</p>
|
|
<p id="kms_02_0040__en-us_topic_0112992347_p20626198101746">For example, <strong id="kms_02_0040__en-us_topic_0112992347_b43669654642512">919c82d4-8046-4722-9094-35c3c6524cff</strong></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="kms_02_0040__en-us_topic_0112992347_sfadd53a5f4714e8f87811818d62d0296"><h4 class="sectiontitle">Response Message</h4><p id="kms_02_0040__en-us_topic_0112992347_p20275240174234">None</p>
|
|
</div>
|
|
<div class="section" id="kms_02_0040__en-us_topic_0112992347_section9910129105318"><h4 class="sectiontitle">Example</h4><p id="kms_02_0040__en-us_topic_0112992347_p0297174720532">The following example describes how to disable rotation for a CMK (ID: <span class="parmvalue" id="kms_02_0040__en-us_topic_0112992347_parmvalue19739413241729"><b>0d0466b0-e727-4d9c-b35d-f84bb474a37f</b></span>).</p>
|
|
<ul id="kms_02_0040__en-us_topic_0112992347_ul792392918538"><li id="kms_02_0040__en-us_topic_0112992347_li11923629185310">Example request<pre class="screen" id="kms_02_0040__en-us_topic_0112992347_screen4923192917534">{
|
|
"key_id": "0d0466b0-e727-4d9c-b35d-f84bb474a37f"
|
|
}</pre>
|
|
</li><li id="kms_02_0040__en-us_topic_0112992347_li119238295537">Example response<pre class="screen" id="kms_02_0040__en-us_topic_0112992347_screen19923112920537">{
|
|
}</pre>
|
|
<p id="kms_02_0040__en-us_topic_0112992347_p1923829155317">or</p>
|
|
<pre class="screen" id="kms_02_0040__en-us_topic_0112992347_screen13923629135315">{
|
|
"error": {
|
|
"error_code": "KMS.XXXX",
|
|
"error_msg": "XXX"
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="kms_02_0040__en-us_topic_0112992347_section655115613254"><h4 class="sectiontitle">Status Codes</h4><div class="p" id="kms_02_0040__en-us_topic_0112992347_en-us_topic_0112992294_en-us_topic_0079615001_p17772351"><a href="#kms_02_0040__en-us_topic_0112992347_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_0040__en-us_topic_0112992347_en-us_topic_0112992294_en-us_topic_0079615001_table20596071"></a><a name="en-us_topic_0112992347_en-us_topic_0112992294_en-us_topic_0079615001_table20596071"></a><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0040__en-us_topic_0112992347_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_0040__en-us_topic_0112992347_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_0040__en-us_topic_0112992347_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_0040__en-us_topic_0112992347_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_0040__en-us_topic_0112992347_en-us_topic_0112992294_p30689603203043">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="kms_02_0040__en-us_topic_0112992347_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_0040__en-us_topic_0112992347_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_0040__en-us_topic_0112992347_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_0040__en-us_topic_0112992347_en-us_topic_0112992294_p1885682315512">Request processed successfully.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<p id="kms_02_0040__en-us_topic_0112992347_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>
|
|
|