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>
293 lines
28 KiB
HTML
293 lines
28 KiB
HTML
<a name="kms_02_0031"></a><a name="kms_02_0031"></a>
|
|
|
|
<h1 class="topictitle1">Querying Grants on a CMK</h1>
|
|
<div id="body1497317398920"><div class="section" id="kms_02_0031__en-us_topic_0112992310_s1731a14fb0144c79bf0fa90c694f34f7"><h4 class="sectiontitle">Function</h4><p id="kms_02_0031__en-us_topic_0112992310_p3693098916421">This API enables you to query grants on a CMK.</p>
|
|
</div>
|
|
<div class="section" id="kms_02_0031__en-us_topic_0112992310_se70c3e5518a04f60b06032524dddfef4"><h4 class="sectiontitle">URI</h4><ul id="kms_02_0031__en-us_topic_0112992310_en-us_topic_0020091565_ul60390938"><li id="kms_02_0031__en-us_topic_0112992310_en-us_topic_0020091565_li6647531">URI format<p id="kms_02_0031__en-us_topic_0112992310_p138073181080"><a name="kms_02_0031__en-us_topic_0112992310_en-us_topic_0020091565_li6647531"></a><a name="en-us_topic_0112992310_en-us_topic_0020091565_li6647531"></a>POST /v1.0/{project_id}/kms/list-grants</p>
|
|
</li><li id="kms_02_0031__en-us_topic_0112992310_en-us_topic_0020091565_li14211994">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0031__en-us_topic_0112992310_t982da1e0196d4ec1a28d1fbff2cc8191" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="kms_02_0031__en-us_topic_0112992310_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_0031__en-us_topic_0112992310_p13230838154934"><strong id="kms_02_0031__en-us_topic_0112992310_b842352706193429">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="22.18%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="kms_02_0031__en-us_topic_0112992310_p65064970154934">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.49%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="kms_02_0031__en-us_topic_0112992310_p35771181154934">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="34.589999999999996%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="kms_02_0031__en-us_topic_0112992310_p11784586154934">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="kms_02_0031__en-us_topic_0112992310_r69bf37b65d3f446eab7b3f4d1b2fcec0"><td class="cellrowborder" valign="top" width="22.74%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="kms_02_0031__en-us_topic_0112992310_ae42d73592f58424ea93a11e52d2478dd">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.18%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="kms_02_0031__en-us_topic_0112992310_a56440c0f0ae34ba3b8033d1247673984">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.49%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="kms_02_0031__en-us_topic_0112992310_p4386100291125">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="34.589999999999996%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="kms_02_0031__en-us_topic_0112992310_a1314869d2dc147b38461e037d622f7b4">Project ID</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="kms_02_0031__en-us_topic_0112992310_seb7b7901701247fab30a59b76f1c7f93"><h4 class="sectiontitle">Requests</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0031__en-us_topic_0112992310_table46221022101230" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="kms_02_0031__en-us_topic_0112992310_row9315574101230"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.3.2.2.5.1.1"><p id="kms_02_0031__en-us_topic_0112992310_p20133141954612"><strong id="kms_02_0031__en-us_topic_0112992310_b1099190551">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.3.2.2.5.1.2"><p id="kms_02_0031__en-us_topic_0112992310_p9133171918460">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.3.2.2.5.1.3"><p id="kms_02_0031__en-us_topic_0112992310_p13133151913465">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.2.2.5.1.4"><p id="kms_02_0031__en-us_topic_0112992310_p5133161934610">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="kms_02_0031__en-us_topic_0112992310_row57603225101653"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.2.5.1.1 "><p id="kms_02_0031__en-us_topic_0112992310_p7106589164345">key_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.5.1.2 "><p id="kms_02_0031__en-us_topic_0112992310_p52781696164345">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.2.5.1.3 "><p id="kms_02_0031__en-us_topic_0112992310_p27799391411">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.2.5.1.4 "><p id="kms_02_0031__en-us_topic_0112992310_p47458964164345">36-byte ID of a CMK that matches the regular expression <span class="parmvalue" id="kms_02_0031__en-us_topic_0112992310_parmvalue80435593163333_1"><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_0031__en-us_topic_0112992310_p60245386164345">Example: 0d0466b0-e727-4d9c-b35d-f84bb474a37f</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0031__en-us_topic_0112992310_row2638193101722"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.2.5.1.1 "><p id="kms_02_0031__en-us_topic_0112992310_p5119285016439">limit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.5.1.2 "><p id="kms_02_0031__en-us_topic_0112992310_p6353760916439">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.2.5.1.3 "><p id="kms_02_0031__en-us_topic_0112992310_p297894117415">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.2.5.1.4 "><p id="kms_02_0031__en-us_topic_0112992310_p5221068611357">This parameter specifies the number of entries returned. If the specified number is smaller than the actual number of existing entries, <span class="parmvalue" id="kms_02_0031__en-us_topic_0112992310_parmvalue555125744154359"><b>true</b></span> will be returned for the response parameter <span class="parmname" id="kms_02_0031__en-us_topic_0112992310_parmname769647905154346"><b>truncated</b></span>, indicating that the query results will be displayed in separate pages.</p>
|
|
<p id="kms_02_0031__en-us_topic_0112992310_p4627274216439">The value is within the range of the maximum number of grants, for example, <span class="parmvalue" id="kms_02_0031__en-us_topic_0112992310_parmvalue581493328154547"><b>100</b></span>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0031__en-us_topic_0112992310_row35142504101726"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.2.5.1.1 "><p id="kms_02_0031__en-us_topic_0112992310_p2967402816439">marker</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.5.1.2 "><p id="kms_02_0031__en-us_topic_0112992310_p848971516439">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.2.5.1.3 "><p id="kms_02_0031__en-us_topic_0112992310_p5811174412414">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.2.5.1.4 "><p id="kms_02_0031__en-us_topic_0112992310_p3222420811429">This parameter marks the starting location in a pagination query.</p>
|
|
<p id="kms_02_0031__en-us_topic_0112992310_p1657829916439">If the <span class="parmname" id="kms_02_0031__en-us_topic_0112992310_parmname769647905155414"><b>truncated</b></span> value is <span class="parmvalue" id="kms_02_0031__en-us_topic_0112992310_parmvalue555125744155422"><b>true</b></span>, you can send consecutive requests to obtain more record entries. The <span class="parmname" id="kms_02_0031__en-us_topic_0112992310_parmname769647905155539"><b>marker</b></span> value must be set to the <span class="parmname" id="kms_02_0031__en-us_topic_0112992310_parmname769647905155552"><b>next_marker</b></span> value in the response, for example, <strong id="kms_02_0031__en-us_topic_0112992310_b7956061174331">10</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0031__en-us_topic_0112992310_row59920057164255"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.2.5.1.1 "><p id="kms_02_0031__en-us_topic_0112992310_p5386140416439">sequence</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.5.1.2 "><p id="kms_02_0031__en-us_topic_0112992310_p5650607916439">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.2.5.1.3 "><p id="kms_02_0031__en-us_topic_0112992310_p125415468416">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.2.5.1.4 "><p id="kms_02_0031__en-us_topic_0112992310_p1358971416439">36-byte serial number of a request message</p>
|
|
<p id="kms_02_0031__en-us_topic_0112992310_p5519856416439">Example: 919c82d4-8046-4722-9094-35c3c6524cff</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="kms_02_0031__en-us_topic_0112992310_sfadd53a5f4714e8f87811818d62d0296"><h4 class="sectiontitle">Responses</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0031__en-us_topic_0112992310_t98d238e10953421e84a073707024c329" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameters</caption><thead align="left"><tr id="kms_02_0031__en-us_topic_0112992310_r144a2c52c5054c6d9243eb2ef3875a21"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.4.2.2.5.1.1"><p id="kms_02_0031__en-us_topic_0112992310_p37751323114611"><strong id="kms_02_0031__en-us_topic_0112992310_b156889935">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.4.2.2.5.1.2"><p id="kms_02_0031__en-us_topic_0112992310_p177751023164619">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.4.2.2.5.1.3"><p id="kms_02_0031__en-us_topic_0112992310_p167751823124611">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.2.2.5.1.4"><p id="kms_02_0031__en-us_topic_0112992310_p4775323194612">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="kms_02_0031__en-us_topic_0112992310_r3c4af7b36e9240d197ab56255e37b83c"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.2.5.1.1 "><p id="kms_02_0031__en-us_topic_0112992310_p54751797164430">grants</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.2.2.5.1.2 "><p id="kms_02_0031__en-us_topic_0112992310_p63244409104212">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.2.5.1.3 "><p id="kms_02_0031__en-us_topic_0112992310_p37234992104212">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.5.1.4 "><p id="kms_02_0031__en-us_topic_0112992310_p22523510104212">Grant list. For details, see <a href="#kms_02_0031__en-us_topic_0112992310_table17099798154440">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0031__en-us_topic_0112992310_row1195616116587"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.2.5.1.1 "><p id="kms_02_0031__en-us_topic_0112992310_p5734209165853">next_marker</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.2.2.5.1.2 "><p id="kms_02_0031__en-us_topic_0112992310_p41184394165853">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.2.5.1.3 "><p id="kms_02_0031__en-us_topic_0112992310_p10107153514">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.5.1.4 "><p id="kms_02_0031__en-us_topic_0112992310_p5174976311616">This parameter indicates the <span class="parmname" id="kms_02_0031__en-us_topic_0112992310_parmname76964790515596"><b>marker</b></span> value required for obtaining the next page of query results.</p>
|
|
<p id="kms_02_0031__en-us_topic_0112992310_p47601640165853">If the <span class="parmname" id="kms_02_0031__en-us_topic_0112992310_parmname769647905155931"><b>truncated</b></span> value is <span class="parmvalue" id="kms_02_0031__en-us_topic_0112992310_parmvalue555125744155940"><b>false</b></span>, the <span class="parmname" id="kms_02_0031__en-us_topic_0112992310_parmname76964790516018"><b>next_marker</b></span> parameter is left blank.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0031__en-us_topic_0112992310_row63650114165815"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.2.5.1.1 "><p id="kms_02_0031__en-us_topic_0112992310_p6312998165853">truncated</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.2.2.5.1.2 "><p id="kms_02_0031__en-us_topic_0112992310_p13415518165853">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.2.5.1.3 "><p id="kms_02_0031__en-us_topic_0112992310_p3631073515">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.5.1.4 "><div class="p" id="kms_02_0031__en-us_topic_0112992310_p12915177165853">This parameter indicates whether there are more results displayed in another page.<ul id="kms_02_0031__en-us_topic_0112992310_ul49127730165853"><li id="kms_02_0031__en-us_topic_0112992310_li39496392165853">If the value is <span class="parmvalue" id="kms_02_0031__en-us_topic_0112992310_parmvalue5551257441629"><b>true</b></span>, there are more results.</li><li id="kms_02_0031__en-us_topic_0112992310_li19923211165853">If the value is <span class="parmvalue" id="kms_02_0031__en-us_topic_0112992310_parmvalue199802661016215"><b>false</b></span>, the current page is the last page.</li></ul>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0031__en-us_topic_0112992310_row20501437105542"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.2.5.1.1 "><p id="kms_02_0031__en-us_topic_0112992310_p50003685105542">total</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.2.2.5.1.2 "><p id="kms_02_0031__en-us_topic_0112992310_p46051398105542">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.2.5.1.3 "><p id="kms_02_0031__en-us_topic_0112992310_p23766661105542">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.5.1.4 "><p id="kms_02_0031__en-us_topic_0112992310_p39175759105542">This parameter indicates the total number of grants.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="kms_02_0031__en-us_topic_0112992310_table17099798154440"></a><a name="en-us_topic_0112992310_table17099798154440"></a><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0031__en-us_topic_0112992310_table17099798154440" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="kms_02_0031__en-us_topic_0112992310_b081497619">grants</strong> field description</caption><thead align="left"><tr id="kms_02_0031__en-us_topic_0112992310_row19888582154440"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.4.3.2.5.1.1"><p id="kms_02_0031__en-us_topic_0112992310_p102828329468"><strong id="kms_02_0031__en-us_topic_0112992310_b24483715">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.4.3.2.5.1.2"><p id="kms_02_0031__en-us_topic_0112992310_p32825325461">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_0031__en-us_topic_0112992310_p19282932124618">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.5.1.4"><p id="kms_02_0031__en-us_topic_0112992310_p92821132104612">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="kms_02_0031__en-us_topic_0112992310_row54890850154440"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.1 "><p id="kms_02_0031__en-us_topic_0112992310_p16973884154440">key_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.3.2.5.1.2 "><p id="kms_02_0031__en-us_topic_0112992310_p32050021154440">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.3 "><p id="kms_02_0031__en-us_topic_0112992310_p2457151017517">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.5.1.4 "><p id="kms_02_0031__en-us_topic_0112992310_p45914884154440">36-byte ID of a CMK that matches the regular expression <span class="parmvalue" id="kms_02_0031__en-us_topic_0112992310_parmvalue80435593163333_3"><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_0031__en-us_topic_0112992310_p62974560154440">Example: 0d0466b0-e727-4d9c-b35d-f84bb474a37f</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0031__en-us_topic_0112992310_row665708154440"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.1 "><p id="kms_02_0031__en-us_topic_0112992310_p53922413154440">grant_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.3.2.5.1.2 "><p id="kms_02_0031__en-us_topic_0112992310_p54135917154440">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.3 "><p id="kms_02_0031__en-us_topic_0112992310_p1665915121259">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.5.1.4 "><p id="kms_02_0031__en-us_topic_0112992310_p22933180154440">64-byte ID of a grant that meets the regular expression <strong id="kms_02_0031__en-us_topic_0112992310_b842352706105044">^[A-Fa-f0-9]{64}$</strong></p>
|
|
<p id="kms_02_0031__en-us_topic_0112992310_p45648287154440">Example: 7c9a3286af4fcca5f0a385ad13e1d21a50e27b6dbcab50f37f30f93b8939827d</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0031__en-us_topic_0112992310_row8181404154440"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.1 "><p id="kms_02_0031__en-us_topic_0112992310_p58713977154440">grantee_principal</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.3.2.5.1.2 "><p id="kms_02_0031__en-us_topic_0112992310_p17525492154440">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.3 "><p id="kms_02_0031__en-us_topic_0112992310_p127211151354">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.5.1.4 "><p id="kms_02_0031__en-us_topic_0112992310_p10278754154440">Indicates the ID of the authorized user. The value is between 1 to 64 bytes and meets the regular expression <strong id="kms_02_0031__en-us_topic_0112992310_b2067817137576">"^[a-zA-Z0-9]{1,64}$"</strong>.</p>
|
|
<p id="kms_02_0031__en-us_topic_0112992310_p44128481154440">Example: 0d0466b00d0466b00d0466b00d0466b0</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0031__en-us_topic_0112992310_row61612009154440"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.1 "><p id="kms_02_0031__en-us_topic_0112992310_p24516817154440">operations</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.3.2.5.1.2 "><p id="kms_02_0031__en-us_topic_0112992310_p61999538154440">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.3 "><p id="kms_02_0031__en-us_topic_0112992310_p39705137154440">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.5.1.4 "><p id="kms_02_0031__en-us_topic_0112992310_p55906683154440">Permissions that can be granted. Values: <span class="parmname" id="kms_02_0031__en-us_topic_0112992310_parmname3365890071844"><b>create-datakey</b></span>, <span class="parmname" id="kms_02_0031__en-us_topic_0112992310_parmname11797450841844"><b>create-datakey-without-plaintext</b></span>, <span class="parmname" id="kms_02_0031__en-us_topic_0112992310_parmname3378262721844"><b>encrypt-datakey</b></span>, <span class="parmname" id="kms_02_0031__en-us_topic_0112992310_parmname2516172031844"><b>decrypt-datakey</b></span>, <span class="parmname" id="kms_02_0031__en-us_topic_0112992310_parmname18730752881844"><b>describe-key</b></span>, <span class="parmname" id="kms_02_0031__en-us_topic_0112992310_parmname13794118891844"><b>create-grant</b></span>, <span class="parmname" id="kms_02_0031__en-us_topic_0112992310_parmname14425042041844"><b>retire-grant</b></span></p>
|
|
<p id="kms_02_0031__en-us_topic_0112992310_p64392214154440"><span class="parmname" id="kms_02_0031__en-us_topic_0112992310_parmname42659018154440"><b>create-grant</b></span> cannot be the only value.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0031__en-us_topic_0112992310_row48386850154440"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.1 "><p id="kms_02_0031__en-us_topic_0112992310_p27020774154440">issuing_principal</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.3.2.5.1.2 "><p id="kms_02_0031__en-us_topic_0112992310_p48794041154440">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.3 "><p id="kms_02_0031__en-us_topic_0112992310_p1540402714518">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.5.1.4 "><p id="kms_02_0031__en-us_topic_0112992310_p60003223154440">Indicates the ID of the user who created the grant. The value is between 1 to 64 bytes and meets the regular expression <strong id="kms_02_0031__en-us_topic_0112992310_b14326165710">"^[a-zA-Z0-9]{1,64}$"</strong>.</p>
|
|
<p id="kms_02_0031__en-us_topic_0112992310_p54479161154440">Example: 0d0466b00d0466b00d0466b00d0466b0</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0031__en-us_topic_0112992310_row20550404154440"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.1 "><p id="kms_02_0031__en-us_topic_0112992310_p53970019154440">creation_date</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.3.2.5.1.2 "><p id="kms_02_0031__en-us_topic_0112992310_p30933436154440">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.3 "><p id="kms_02_0031__en-us_topic_0112992310_p1871912812515">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.5.1.4 "><p id="kms_02_0031__en-us_topic_0112992310_p22580357154440">Creation time. The value is a timestamp expressed in the number of seconds since 00:00:00 UTC on January 1, 1970.</p>
|
|
<p id="kms_02_0031__en-us_topic_0112992310_p17069590154440">Example: 1497341531000</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0031__en-us_topic_0112992310_row19408585154440"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.1 "><p id="kms_02_0031__en-us_topic_0112992310_p28591578154440">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.3.2.5.1.2 "><p id="kms_02_0031__en-us_topic_0112992310_p20074746154440">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.3 "><p id="kms_02_0031__en-us_topic_0112992310_p14336173019518">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.5.1.4 "><p id="kms_02_0031__en-us_topic_0112992310_p15441753154440">Name of a grant which can be 1 to 255 characters in length and matches the regular expression <strong id="kms_02_0031__en-us_topic_0112992310_b842352706104539">^[a-zA-Z0-9:/_-]{1,255}$</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0031__en-us_topic_0112992310_row4758052154440"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.1 "><p id="kms_02_0031__en-us_topic_0112992310_p49857969154440">retiring_principal</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.3.2.5.1.2 "><p id="kms_02_0031__en-us_topic_0112992310_p29533843154440">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.3 "><p id="kms_02_0031__en-us_topic_0112992310_p1140143218518">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.5.1.4 "><p id="kms_02_0031__en-us_topic_0112992310_p43431097154440">Indicates the ID of the retiring user. The value is between 1 to 64 bytes and meets the regular expression <strong id="kms_02_0031__en-us_topic_0112992310_b19526162355818">"^[a-zA-Z0-9]{1,64}$"</strong>.</p>
|
|
<p id="kms_02_0031__en-us_topic_0112992310_p52995191154440">Example: 0d0466b00d0466b00d0466b00d0466b0</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="kms_02_0031__en-us_topic_0112992310_section853474470"><h4 class="sectiontitle">Examples</h4><p id="kms_02_0031__en-us_topic_0112992310_p158837561876">The following example describes how to query the grant list of a CMK whose ID is <span class="parmvalue" id="kms_02_0031__en-us_topic_0112992310_parmvalue19739413241729"><b>0d0466b0-e727-4d9c-b35d-f84bb474a37f</b></span>.</p>
|
|
<ul id="kms_02_0031__en-us_topic_0112992310_ul111351515578"><li id="kms_02_0031__en-us_topic_0112992310_li156069411713">Example request<pre class="screen" id="kms_02_0031__en-us_topic_0112992310_screen1960644473">{
|
|
"key_id": "0d0466b0-e727-4d9c-b35d-f84bb474a37f",
|
|
"limit": "",
|
|
"marker": ""
|
|
}</pre>
|
|
</li><li id="kms_02_0031__en-us_topic_0112992310_li66071842720">Example response<pre class="screen" id="kms_02_0031__en-us_topic_0112992310_screen260714378">{
|
|
"grants": [
|
|
{"key_id": "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e",
|
|
"grant_id": "7c9a3286af4fcca5f0a385ad13e1d21a50e27b6dbcab50f37f30f93b8939827d",
|
|
"operations":
|
|
["describe-key","create-datakey", "encrypt-datakey"],
|
|
"grantee_principal":"13gg44z4g2sglzk0egw0u726zoyzvrs8",
|
|
"retiring_principal":"13gg44z4g2sglzk0egw0u726zoyzvrs8",
|
|
"issuing_principal":"e4hkeeea506ex3wgnzyhi656n8hx8xa3",
|
|
"name":"my_grant",
|
|
"creation_date":"1497341531000",
|
|
}],
|
|
"next_marker": "",
|
|
"truncated": "false",
|
|
"total":1
|
|
}</pre>
|
|
<p id="kms_02_0031__en-us_topic_0112992310_p12607645710">or</p>
|
|
<pre class="screen" id="kms_02_0031__en-us_topic_0112992310_screen12607241076">{
|
|
"error": {
|
|
"error_code": "KMS.XXXX",
|
|
"error_msg": "XXX"
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="kms_02_0031__en-us_topic_0112992310_section3454223421"><h4 class="sectiontitle">Status Codes</h4><div class="p" id="kms_02_0031__en-us_topic_0112992310_en-us_topic_0112992294_en-us_topic_0079615001_p17772351"><a href="#kms_02_0031__en-us_topic_0112992310_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_0031__en-us_topic_0112992310_en-us_topic_0112992294_en-us_topic_0079615001_table20596071"></a><a name="en-us_topic_0112992310_en-us_topic_0112992294_en-us_topic_0079615001_table20596071"></a><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0031__en-us_topic_0112992310_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_0031__en-us_topic_0112992310_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_0031__en-us_topic_0112992310_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_0031__en-us_topic_0112992310_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_0031__en-us_topic_0112992310_en-us_topic_0112992294_p30689603203043">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="kms_02_0031__en-us_topic_0112992310_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_0031__en-us_topic_0112992310_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_0031__en-us_topic_0112992310_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_0031__en-us_topic_0112992310_en-us_topic_0112992294_p1885682315512">Request processed successfully.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<p id="kms_02_0031__en-us_topic_0112992310_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>
|
|
|