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>
147 lines
14 KiB
HTML
147 lines
14 KiB
HTML
<a name="kms_02_0038"></a><a name="kms_02_0038"></a>
|
|
|
|
<h1 class="topictitle1">Enabling Rotation for a CMK</h1>
|
|
<div id="body1511418825777"><div class="section" id="kms_02_0038__en-us_topic_0112992318_s1731a14fb0144c79bf0fa90c694f34f7"><h4 class="sectiontitle">Function</h4><p id="kms_02_0038__en-us_topic_0112992318_en-us_topic_0020091565_p23115188">This API allows you to enable rotation for a CMK.</p>
|
|
<div class="note" id="kms_02_0038__en-us_topic_0112992318_note5633572415214"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="kms_02_0038__en-us_topic_0112992318_ul9981192173413"><li id="kms_02_0038__en-us_topic_0112992318_li1298132114341">The default rotation interval is 365 days.</li><li id="kms_02_0038__en-us_topic_0112992318_li2098112123414">CMKs created using imported key materials and Default Master Keys do not support rotation.</li></ul>
|
|
</div></div>
|
|
</div>
|
|
<div class="section" id="kms_02_0038__en-us_topic_0112992318_se70c3e5518a04f60b06032524dddfef4"><h4 class="sectiontitle">URI</h4><ul id="kms_02_0038__en-us_topic_0112992318_en-us_topic_0020091565_ul60390938"><li id="kms_02_0038__en-us_topic_0112992318_en-us_topic_0020091565_li6647531">URI format<p id="kms_02_0038__en-us_topic_0112992318_p138073181080"><a name="kms_02_0038__en-us_topic_0112992318_en-us_topic_0020091565_li6647531"></a><a name="en-us_topic_0112992318_en-us_topic_0020091565_li6647531"></a>POST /v1.0/{project_id}/kms/enable-key-rotation</p>
|
|
</li><li id="kms_02_0038__en-us_topic_0112992318_en-us_topic_0020091565_li14211994">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0038__en-us_topic_0112992318_t982da1e0196d4ec1a28d1fbff2cc8191" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameter</caption><thead align="left"><tr id="kms_02_0038__en-us_topic_0112992318_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_0038__en-us_topic_0112992318_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_0038__en-us_topic_0112992318_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_0038__en-us_topic_0112992318_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_0038__en-us_topic_0112992318_p3350702116511">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="kms_02_0038__en-us_topic_0112992318_r69bf37b65d3f446eab7b3f4d1b2fcec0"><td class="cellrowborder" valign="top" width="19.170000000000005%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="kms_02_0038__en-us_topic_0112992318_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_0038__en-us_topic_0112992318_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_0038__en-us_topic_0112992318_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_0038__en-us_topic_0112992318_a1314869d2dc147b38461e037d622f7b4">Project ID</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="kms_02_0038__en-us_topic_0112992318_seb7b7901701247fab30a59b76f1c7f93"><h4 class="sectiontitle">Request Message</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0038__en-us_topic_0112992318_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_0038__en-us_topic_0112992318_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_0038__en-us_topic_0112992318_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_0038__en-us_topic_0112992318_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_0038__en-us_topic_0112992318_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_0038__en-us_topic_0112992318_en-us_topic_0000001176937539_p109301444105220">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="kms_02_0038__en-us_topic_0112992318_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_0038__en-us_topic_0112992318_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_0038__en-us_topic_0112992318_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_0038__en-us_topic_0112992318_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_0038__en-us_topic_0112992318_en-us_topic_0000001176937539_p1093134420527">User token. It can be obtained by calling an IAM API. The value of <strong id="kms_02_0038__en-us_topic_0112992318_b1536676513105152">X-Subject-Token</strong> in the response header is the user token.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0038__en-us_topic_0112992318_row17121816165912"><td class="cellrowborder" valign="top" width="20.080000000000002%" headers="mcps1.3.3.2.2.5.1.1 "><p id="kms_02_0038__en-us_topic_0112992318_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_0038__en-us_topic_0112992318_p2794195010376">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="kms_02_0038__en-us_topic_0112992318_p9794195015373">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="kms_02_0038__en-us_topic_0112992318_p5617163694719">application/json</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0038__en-us_topic_0112992318_table46221022101230" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request parameters</caption><thead align="left"><tr id="kms_02_0038__en-us_topic_0112992318_row9315574101230"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.3.3.2.5.1.1"><p id="kms_02_0038__en-us_topic_0112992318_p6295219551">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_0038__en-us_topic_0112992318_p329192117559">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_0038__en-us_topic_0112992318_p72922185510">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_0038__en-us_topic_0112992318_p830921115511">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="kms_02_0038__en-us_topic_0112992318_row2638193101722"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.3.2.5.1.1 "><p id="kms_02_0038__en-us_topic_0112992318_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_0038__en-us_topic_0112992318_p17072096105428">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.3.2.5.1.3 "><p id="kms_02_0038__en-us_topic_0112992318_p361711421378">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.3.2.5.1.4 "><p id="kms_02_0038__en-us_topic_0112992318_p21929114422">36-byte key ID that matches the regular expression <span class="parmvalue" id="kms_02_0038__en-us_topic_0112992318_parmvalue743639504332"><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_0038__en-us_topic_0112992318_p11134104114149">For example, <strong id="kms_02_0038__en-us_topic_0112992318_b7217263864615">0d0466b0-e727-4d9c-b35d-f84bb474a37f</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0038__en-us_topic_0112992318_row35142504101726"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.3.2.5.1.1 "><p id="kms_02_0038__en-us_topic_0112992318_p269135101746">sequence</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.3.2.5.1.2 "><p id="kms_02_0038__en-us_topic_0112992318_p20967256101746">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.3.2.5.1.3 "><p id="kms_02_0038__en-us_topic_0112992318_p21799971101746">string</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.3.2.5.1.4 "><p id="kms_02_0038__en-us_topic_0112992318_p18788932152917">A 36-byte serial number of a request message.</p>
|
|
<p id="kms_02_0038__en-us_topic_0112992318_p20626198101746">For example, <strong id="kms_02_0038__en-us_topic_0112992318_b144010329642511">919c82d4-8046-4722-9094-35c3c6524cff</strong></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="kms_02_0038__en-us_topic_0112992318_sfadd53a5f4714e8f87811818d62d0296"><h4 class="sectiontitle">Response Message</h4><p id="kms_02_0038__en-us_topic_0112992318_p20275240174234">None</p>
|
|
</div>
|
|
<div class="section" id="kms_02_0038__en-us_topic_0112992318_section144391756163416"><h4 class="sectiontitle">Example</h4><p id="kms_02_0038__en-us_topic_0112992318_p4157111943512">The following example describes how to enable rotation for a CMK (ID: <span class="parmvalue" id="kms_02_0038__en-us_topic_0112992318_parmvalue19739413241729"><b>0d0466b0-e727-4d9c-b35d-f84bb474a37f</b></span>).</p>
|
|
<ul id="kms_02_0038__en-us_topic_0112992318_ul446095610344"><li id="kms_02_0038__en-us_topic_0112992318_li7460205620348">Example request<pre class="screen" id="kms_02_0038__en-us_topic_0112992318_screen19460356183412">{
|
|
"key_id": "0d0466b0-e727-4d9c-b35d-f84bb474a37f"
|
|
}</pre>
|
|
</li><li id="kms_02_0038__en-us_topic_0112992318_li3460756113417">Example response<pre class="screen" id="kms_02_0038__en-us_topic_0112992318_screen1346013560344">{
|
|
}</pre>
|
|
<p id="kms_02_0038__en-us_topic_0112992318_p1746045663415">or</p>
|
|
<pre class="screen" id="kms_02_0038__en-us_topic_0112992318_screen154605563347">{
|
|
"error": {
|
|
"error_code": "KMS.XXXX",
|
|
"error_msg": "XXX"
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="kms_02_0038__en-us_topic_0112992318_section655115613254"><h4 class="sectiontitle">Status Codes</h4><div class="p" id="kms_02_0038__en-us_topic_0112992318_en-us_topic_0112992294_en-us_topic_0079615001_p17772351"><a href="#kms_02_0038__en-us_topic_0112992318_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_0038__en-us_topic_0112992318_en-us_topic_0112992294_en-us_topic_0079615001_table20596071"></a><a name="en-us_topic_0112992318_en-us_topic_0112992294_en-us_topic_0079615001_table20596071"></a><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0038__en-us_topic_0112992318_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_0038__en-us_topic_0112992318_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_0038__en-us_topic_0112992318_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_0038__en-us_topic_0112992318_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_0038__en-us_topic_0112992318_en-us_topic_0112992294_p30689603203043">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="kms_02_0038__en-us_topic_0112992318_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_0038__en-us_topic_0112992318_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_0038__en-us_topic_0112992318_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_0038__en-us_topic_0112992318_en-us_topic_0112992294_p1885682315512">Request processed successfully.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<p id="kms_02_0038__en-us_topic_0112992318_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>
|
|
|