youjiageng1/doc-exports
1
0
Fork 0
forked from laiweijian4/doc-exports
Code Pull Requests Activity
doc-exports/docs/kms/api-ref/kms_02_0018.html
gtema 83150ed5aa replacement of #300 
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: gtema <artem.goncharov@gmail.com>
Co-committed-by: gtema <artem.goncharov@gmail.com>
2022-11-21 08:53:44 +00:00

276 lines
25 KiB
HTML
Raw Blame History

<a name="kms_02_0018"></a><a name="kms_02_0018"></a>
<h1 class="topictitle1">Querying the Information About a CMK</h1>
<div id="body1474684560493"><div class="section" id="kms_02_0018__en-us_topic_0112992343_s1731a14fb0144c79bf0fa90c694f34f7"><h4 class="sectiontitle">Function</h4><p id="kms_02_0018__en-us_topic_0112992343_en-us_topic_0020091565_p23115188">This API allows you to query the details about a CMK.</p>
<div class="note" id="kms_02_0018__en-us_topic_0112992343_note1631151815537"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="kms_02_0018__en-us_topic_0112992343_p1131818135319">By default, the performance threshold for querying CMK details is 1000 TPS per customer. To apply for higher performance, submit a service ticket.</p>
</div></div>
</div>
<div class="section" id="kms_02_0018__en-us_topic_0112992343_se70c3e5518a04f60b06032524dddfef4"><h4 class="sectiontitle">URI</h4><ul id="kms_02_0018__en-us_topic_0112992343_en-us_topic_0020091565_ul60390938"><li id="kms_02_0018__en-us_topic_0112992343_en-us_topic_0020091565_li6647531">URI format<p id="kms_02_0018__en-us_topic_0112992343_p138073181080"><a name="kms_02_0018__en-us_topic_0112992343_en-us_topic_0020091565_li6647531"></a><a name="en-us_topic_0112992343_en-us_topic_0020091565_li6647531"></a>POST /v1.0/{project_id}/kms/describe-key</p>
</li><li id="kms_02_0018__en-us_topic_0112992343_en-us_topic_0020091565_li14211994">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0018__en-us_topic_0112992343_t982da1e0196d4ec1a28d1fbff2cc8191" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters</caption><thead align="left"><tr id="kms_02_0018__en-us_topic_0112992343_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_0018__en-us_topic_0112992343_a3b5bbe5a7f644fd3a74cecbfb3f7ed60"><strong id="kms_02_0018__en-us_topic_0112992343_b842352706173823">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.36%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="kms_02_0018__en-us_topic_0112992343_ad98d2f62bd064b4e96ea922645197c24"><strong id="kms_02_0018__en-us_topic_0112992343_b842352706173832">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.05%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="kms_02_0018__en-us_topic_0112992343_a3becf0b3aec9468984c2efc8d5abbea5">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="36.85%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="kms_02_0018__en-us_topic_0112992343_a6bb6f1fe56a2454982832e8d56d354d8">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="kms_02_0018__en-us_topic_0112992343_r69bf37b65d3f446eab7b3f4d1b2fcec0"><td class="cellrowborder" valign="top" width="22.74%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="kms_02_0018__en-us_topic_0112992343_ae42d73592f58424ea93a11e52d2478dd">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.36%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="kms_02_0018__en-us_topic_0112992343_a56440c0f0ae34ba3b8033d1247673984">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="21.05%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="kms_02_0018__en-us_topic_0112992343_a1a4a71c11a4a45a58d0de2fbe009e9d9">String</p>
</td>
<td class="cellrowborder" valign="top" width="36.85%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="kms_02_0018__en-us_topic_0112992343_a1314869d2dc147b38461e037d622f7b4">Project ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="kms_02_0018__en-us_topic_0112992343_seb7b7901701247fab30a59b76f1c7f93"><h4 class="sectiontitle">Requests</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0018__en-us_topic_0112992343_table46221022101230" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="kms_02_0018__en-us_topic_0112992343_row1239210313121"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.3.2.2.5.1.1"><p id="kms_02_0018__en-us_topic_0112992343_p93922314127">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_0018__en-us_topic_0112992343_p63928351216"><strong id="kms_02_0018__en-us_topic_0112992343_b842352706173926_1">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_0018__en-us_topic_0112992343_p2039263171212"><strong id="kms_02_0018__en-us_topic_0112992343_b842352706173922">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_0018__en-us_topic_0112992343_p1739363151218">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="kms_02_0018__en-us_topic_0112992343_row139316391219"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.2.5.1.1 "><p id="kms_02_0018__en-us_topic_0112992343_p839318315126">key_id</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.5.1.2 "><p id="kms_02_0018__en-us_topic_0112992343_p6393153101218">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.2.5.1.3 "><p id="kms_02_0018__en-us_topic_0112992343_p439315391210">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.2.5.1.4 "><p id="kms_02_0018__en-us_topic_0112992343_p139363101219">36-byte ID of a CMK that matches the regular expression <span class="parmvalue" id="kms_02_0018__en-us_topic_0112992343_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_0018__en-us_topic_0112992343_p1039323161219">Example: 0d0466b0-e727-4d9c-b35d-f84bb474a37f</p>
</td>
</tr>
<tr id="kms_02_0018__en-us_topic_0112992343_row1839312391218"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.2.5.1.1 "><p id="kms_02_0018__en-us_topic_0112992343_p1639317391213">sequence</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.5.1.2 "><p id="kms_02_0018__en-us_topic_0112992343_p839310318127">No</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.2.5.1.3 "><p id="kms_02_0018__en-us_topic_0112992343_p10393535125">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.2.5.1.4 "><p id="kms_02_0018__en-us_topic_0112992343_p143931034125">36-byte serial number of a request message</p>
<p id="kms_02_0018__en-us_topic_0112992343_p133931230121">Example: 919c82d4-8046-4722-9094-35c3c6524cff</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="kms_02_0018__en-us_topic_0112992343_sfadd53a5f4714e8f87811818d62d0296"><h4 class="sectiontitle">Responses</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0018__en-us_topic_0112992343_table7517184618545" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameters</caption><thead align="left"><tr id="kms_02_0018__en-us_topic_0112992343_row55181746125413"><th align="left" class="cellrowborder" valign="top" width="18.04%" id="mcps1.3.4.2.2.5.1.1"><p id="kms_02_0018__en-us_topic_0112992343_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_0018__en-us_topic_0112992343_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_0018__en-us_topic_0112992343_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_0018__en-us_topic_0112992343_p18518194625416">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="kms_02_0018__en-us_topic_0112992343_row951818462548"><td class="cellrowborder" valign="top" width="18.04%" headers="mcps1.3.4.2.2.5.1.1 "><p id="kms_02_0018__en-us_topic_0112992343_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_0018__en-us_topic_0112992343_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_0018__en-us_topic_0112992343_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_0018__en-us_topic_0112992343_p85181246135416">Information about keys. For details, see <a href="#kms_02_0018__en-us_topic_0112992343_t98d238e10953421e84a073707024c329">Table 4</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="kms_02_0018__en-us_topic_0112992343_t98d238e10953421e84a073707024c329"></a><a name="en-us_topic_0112992343_t98d238e10953421e84a073707024c329"></a><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0018__en-us_topic_0112992343_t98d238e10953421e84a073707024c329" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="kms_02_0018__en-us_topic_0112992343_b131183012592">key_info</strong> field description</caption><thead align="left"><tr id="kms_02_0018__en-us_topic_0112992343_row842320371212"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.4.3.2.5.1.1"><p id="kms_02_0018__en-us_topic_0112992343_p2042319314123">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_0018__en-us_topic_0112992343_p194231638123"><strong id="kms_02_0018__en-us_topic_0112992343_b842352706173926_3">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.4.3.2.5.1.3"><p id="kms_02_0018__en-us_topic_0112992343_p44231391216"><strong id="kms_02_0018__en-us_topic_0112992343_b84235270617406">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_0018__en-us_topic_0112992343_p3423123131211">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="kms_02_0018__en-us_topic_0112992343_row9423631125"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.1 "><p id="kms_02_0018__en-us_topic_0112992343_p34231838129">key_id</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.3.2.5.1.2 "><p id="kms_02_0018__en-us_topic_0112992343_p1342393181210">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.3 "><p id="kms_02_0018__en-us_topic_0112992343_p164231238124">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.5.1.4 "><p id="kms_02_0018__en-us_topic_0112992343_p34238381219">CMK ID</p>
</td>
</tr>
<tr id="kms_02_0018__en-us_topic_0112992343_row1423113121213"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.1 "><p id="kms_02_0018__en-us_topic_0112992343_p0423133111211">domain_id</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.3.2.5.1.2 "><p id="kms_02_0018__en-us_topic_0112992343_p042317320129">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.3 "><p id="kms_02_0018__en-us_topic_0112992343_p194231832126">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.5.1.4 "><p id="kms_02_0018__en-us_topic_0112992343_p54241034126">User domain ID</p>
</td>
</tr>
<tr id="kms_02_0018__en-us_topic_0112992343_row442410313125"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.1 "><p id="kms_02_0018__en-us_topic_0112992343_p184243311213">key_alias</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.3.2.5.1.2 "><p id="kms_02_0018__en-us_topic_0112992343_p2042413310129">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.3 "><p id="kms_02_0018__en-us_topic_0112992343_p84249361217">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.5.1.4 "><p id="kms_02_0018__en-us_topic_0112992343_p142412310128">Alias of a CMK</p>
</td>
</tr>
<tr id="kms_02_0018__en-us_topic_0112992343_row14240331218"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.1 "><p id="kms_02_0018__en-us_topic_0112992343_p1342453121214">realm</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.3.2.5.1.2 "><p id="kms_02_0018__en-us_topic_0112992343_p1442433171215">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.3 "><p id="kms_02_0018__en-us_topic_0112992343_p4424183131218">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.5.1.4 "><p id="kms_02_0018__en-us_topic_0112992343_p5424731127">Region where a CMK resides</p>
</td>
</tr>
<tr id="kms_02_0018__en-us_topic_0112992343_row12424134129"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.1 "><p id="kms_02_0018__en-us_topic_0112992343_p1242443191217">key_description</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.3.2.5.1.2 "><p id="kms_02_0018__en-us_topic_0112992343_p64241537126">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.3 "><p id="kms_02_0018__en-us_topic_0112992343_p164242036121">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.5.1.4 "><p id="kms_02_0018__en-us_topic_0112992343_p11424133101212">Description of a CMK</p>
</td>
</tr>
<tr id="kms_02_0018__en-us_topic_0112992343_row1424123171213"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.1 "><p id="kms_02_0018__en-us_topic_0112992343_p1142418316124">creation_date</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.3.2.5.1.2 "><p id="kms_02_0018__en-us_topic_0112992343_p1742433101212">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.3 "><p id="kms_02_0018__en-us_topic_0112992343_p54241631124">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.5.1.4 "><p id="kms_02_0018__en-us_topic_0112992343_p442412311128">Time when a key is created. The value is a timestamp expressed in the number of seconds since 00:00:00 UTC on January 1, 1970.</p>
</td>
</tr>
<tr id="kms_02_0018__en-us_topic_0112992343_row13424203111217"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.1 "><p id="kms_02_0018__en-us_topic_0112992343_p5424133131216">scheduled_deletion_date</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.3.2.5.1.2 "><p id="kms_02_0018__en-us_topic_0112992343_p1442411341219">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.3 "><p id="kms_02_0018__en-us_topic_0112992343_p104243318128">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.5.1.4 "><p id="kms_02_0018__en-us_topic_0112992343_p1442417391215">Time when a key will be deleted as scheduled. The value is a timestamp expressed in the number of seconds since 00:00:00 UTC on January 1, 1970.</p>
</td>
</tr>
<tr id="kms_02_0018__en-us_topic_0112992343_row1242543111216"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.1 "><p id="kms_02_0018__en-us_topic_0112992343_p104253316124">key_state</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.3.2.5.1.2 "><p id="kms_02_0018__en-us_topic_0112992343_p2042511341218">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.3 "><p id="kms_02_0018__en-us_topic_0112992343_p1742518312125">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.5.1.4 "><div class="p" id="kms_02_0018__en-us_topic_0112992343_p542593151215">State of a CMK:<ul id="kms_02_0018__en-us_topic_0112992343_ul184931831124"><li id="kms_02_0018__en-us_topic_0112992343_li174931132128"><span class="parmvalue" id="kms_02_0018__en-us_topic_0112992343_parmvalue63632845104232"><b>1</b></span> indicates that the CMK is waiting to be activated.</li><li id="kms_02_0018__en-us_topic_0112992343_li9493439122"><span class="parmvalue" id="kms_02_0018__en-us_topic_0112992343_parmvalue27931731104241"><b>2</b></span> indicates that the CMK is enabled.</li><li id="kms_02_0018__en-us_topic_0112992343_li1749317318129"><span class="parmvalue" id="kms_02_0018__en-us_topic_0112992343_parmvalue49067618104244"><b>3</b></span> indicates that the CMK is disabled.</li><li id="kms_02_0018__en-us_topic_0112992343_li134931336126"><span class="parmvalue" id="kms_02_0018__en-us_topic_0112992343_parmvalue28113363104247"><b>4</b></span> indicates that the CMK is scheduled for deletion.</li><li id="kms_02_0018__en-us_topic_0112992343_li3493103161215"><span class="parmvalue" id="kms_02_0018__en-us_topic_0112992343_parmvalue18075000104250"><b>5</b></span> indicates that the CMK is waiting to be imported.</li></ul>
</div>
</td>
</tr>
<tr id="kms_02_0018__en-us_topic_0112992343_row124257381216"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.1 "><p id="kms_02_0018__en-us_topic_0112992343_p11425633128">default_key_flag</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.3.2.5.1.2 "><p id="kms_02_0018__en-us_topic_0112992343_p15425338126">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.3 "><p id="kms_02_0018__en-us_topic_0112992343_p6425183151210">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.5.1.4 "><p id="kms_02_0018__en-us_topic_0112992343_p1042510391215">Identification of a Master Key. The value <strong id="kms_02_0018__en-us_topic_0112992343_b84235270615132">1</strong> indicates a Default Master Key, and the value <strong id="kms_02_0018__en-us_topic_0112992343_b84235270615136">0</strong> indicates a CMK.</p>
</td>
</tr>
<tr id="kms_02_0018__en-us_topic_0112992343_row342512381214"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.1 "><p id="kms_02_0018__en-us_topic_0112992343_p142512317121">key_type</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.3.2.5.1.2 "><p id="kms_02_0018__en-us_topic_0112992343_p542518341212">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.3 "><p id="kms_02_0018__en-us_topic_0112992343_p842518341220">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.5.1.4 "><p id="kms_02_0018__en-us_topic_0112992343_p8425236126">Type of a CMK</p>
</td>
</tr>
<tr id="kms_02_0018__en-us_topic_0112992343_row144251930121"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.1 "><p id="kms_02_0018__en-us_topic_0112992343_p642533161216">expiration_time</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.3.2.5.1.2 "><p id="kms_02_0018__en-us_topic_0112992343_p042619351214">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.3 "><p id="kms_02_0018__en-us_topic_0112992343_p4426932124">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.5.1.4 "><p id="kms_02_0018__en-us_topic_0112992343_p173691125119">Expiration time of the key material. It is expressed in the form of a time stamp, the total number of seconds since January 1, 1970.</p>
</td>
</tr>
<tr id="kms_02_0018__en-us_topic_0112992343_row1542614361215"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.1 "><p id="kms_02_0018__en-us_topic_0112992343_p74261938127">origin</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.3.2.5.1.2 "><p id="kms_02_0018__en-us_topic_0112992343_p1242611315120">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.3 "><p id="kms_02_0018__en-us_topic_0112992343_p54261339122">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.5.1.4 "><p id="kms_02_0018__en-us_topic_0112992343_p9426533128">Origin of a CMK. The default value is <span class="parmvalue" id="kms_02_0018__en-us_topic_0112992343_parmvalue5237346195350"><b>kms</b></span>. The following values are enumerated:</p>
<ul id="kms_02_0018__en-us_topic_0112992343_ul94267314129"><li id="kms_02_0018__en-us_topic_0112992343_li2042693111215"><span class="parmvalue" id="kms_02_0018__en-us_topic_0112992343_parmvalue1011124252141313_3"><b>kms</b></span> indicates that the CMK material is generated by KMS.</li><li id="kms_02_0018__en-us_topic_0112992343_li1442653171219"><span class="parmvalue" id="kms_02_0018__en-us_topic_0112992343_parmvalue501259129141335"><b>external</b></span> indicates that the CMK material is imported.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="kms_02_0018__en-us_topic_0112992343_section17883719132515"><h4 class="sectiontitle">Examples</h4><p id="kms_02_0018__en-us_topic_0112992343_p16431037152514">The following example describes how to query the information of a CMK whose ID is <span class="parmvalue" id="kms_02_0018__en-us_topic_0112992343_parmvalue19739413241729"><b>0d0466b0-e727-4d9c-b35d-f84bb474a37f</b></span>.</p>
<ul id="kms_02_0018__en-us_topic_0112992343_ul109131719172519"><li id="kms_02_0018__en-us_topic_0112992343_li2091151952511">Example request<pre class="screen" id="kms_02_0018__en-us_topic_0112992343_screen19911191952516">{
"key_id": "0d0466b0-e727-4d9c-b35d-f84bb474a37f"
}</pre>
</li><li id="kms_02_0018__en-us_topic_0112992343_li129136199258">Example response<pre class="screen" id="kms_02_0018__en-us_topic_0112992343_screen1291219199254">{
"key_info": {
"key_id": "0d0466b0-e727-4d9c-b35d-f84bb474a37f",
"domain_id": "b168fe00ff56492495a7d22974df2d0b",
"key_alias": "kms_test",
"realm": "aaa",
"key_description": "",
"creation_date": "1472442386000",
"scheduled_deletion_date": "",
"key_state": "2",
"default_key_flag": "0",
"key_type": "1",
"expiration_time":"1501578672000",
"origin":"kms"
,
}
}</pre>
<p id="kms_02_0018__en-us_topic_0112992343_p7912101932519">or</p>
<pre class="screen" id="kms_02_0018__en-us_topic_0112992343_screen691217195254">{
"error": {
"error_code": "KMS.XXXX",
"error_msg": "XXX"
}
}</pre>
</li></ul>
</div>
<div class="section" id="kms_02_0018__en-us_topic_0112992343_section3454223421"><h4 class="sectiontitle">Status Codes</h4><div class="p" id="kms_02_0018__en-us_topic_0112992343_en-us_topic_0112992294_en-us_topic_0079615001_p17772351"><a href="#kms_02_0018__en-us_topic_0112992343_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_0018__en-us_topic_0112992343_en-us_topic_0112992294_en-us_topic_0079615001_table20596071"></a><a name="en-us_topic_0112992343_en-us_topic_0112992294_en-us_topic_0079615001_table20596071"></a><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0018__en-us_topic_0112992343_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_0018__en-us_topic_0112992343_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_0018__en-us_topic_0112992343_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_0018__en-us_topic_0112992343_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_0018__en-us_topic_0112992343_en-us_topic_0112992294_p30689603203043">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="kms_02_0018__en-us_topic_0112992343_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_0018__en-us_topic_0112992343_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_0018__en-us_topic_0112992343_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_0018__en-us_topic_0112992343_en-us_topic_0112992294_p1885682315512">Request processed successfully.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<p id="kms_02_0018__en-us_topic_0112992343_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_0010.html">APIs</a></div>
</div>
</div>
View Git Blame Copy Permalink