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>
178 lines
17 KiB
HTML
178 lines
17 KiB
HTML
<a name="kms_02_0057"></a><a name="kms_02_0057"></a>
|
|
|
|
<h1 class="topictitle1">API Overview</h1>
|
|
<div id="body32001227"><p id="kms_02_0057__en-us_topic_0170884210_p5690131415493">You can use all functions of by calling its APIs.</p>
|
|
<div class="section" id="kms_02_0057__en-us_topic_0170884210_section13159414572"><h4 class="sectiontitle">Key Management APIs</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0057__en-us_topic_0170884210_table177341359552" frame="border" border="1" rules="all"><thead align="left"><tr id="kms_02_0057__en-us_topic_0170884210_row973425919514"><th align="left" class="cellrowborder" valign="top" width="29.630000000000003%" id="mcps1.3.2.2.1.3.1.1"><p id="kms_02_0057__en-us_topic_0170884210_p87342591555">API</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="70.37%" id="mcps1.3.2.2.1.3.1.2"><p id="kms_02_0057__en-us_topic_0170884210_p157341859858">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="kms_02_0057__en-us_topic_0170884210_row16734959259"><td class="cellrowborder" valign="top" width="29.630000000000003%" headers="mcps1.3.2.2.1.3.1.1 "><p id="kms_02_0057__en-us_topic_0170884210_p1373445920518"><a href="kms_02_0012.html#kms_02_0012">Creating a CMK</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70.37%" headers="mcps1.3.2.2.1.3.1.2 "><p id="kms_02_0057__en-us_topic_0170884210_p79581042143011">Creates a CMK.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0057__en-us_topic_0170884210_row3149115214253"><td class="cellrowborder" valign="top" width="29.630000000000003%" headers="mcps1.3.2.2.1.3.1.1 "><p id="kms_02_0057__en-us_topic_0170884210_p1214945282512"><a href="kms_02_0013.html#kms_02_0013">Enabling a CMK</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70.37%" headers="mcps1.3.2.2.1.3.1.2 "><p id="kms_02_0057__en-us_topic_0170884210_p12149205272519">Enables a CMK. Only an enabled CMK can be used.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0057__en-us_topic_0170884210_row155214557258"><td class="cellrowborder" valign="top" width="29.630000000000003%" headers="mcps1.3.2.2.1.3.1.1 "><p id="kms_02_0057__en-us_topic_0170884210_p1255210550255"><a href="kms_02_0014.html#kms_02_0014">Disabling a CMK</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70.37%" headers="mcps1.3.2.2.1.3.1.2 "><p id="kms_02_0057__en-us_topic_0170884210_p20552115502517">Disables a CMK. A disabled CMK cannot be used.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0057__en-us_topic_0170884210_row11602458112515"><td class="cellrowborder" valign="top" width="29.630000000000003%" headers="mcps1.3.2.2.1.3.1.1 "><p id="kms_02_0057__en-us_topic_0170884210_p0602558142513"><a href="kms_02_0015.html#kms_02_0015">Scheduling the Deletion of a CMK</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70.37%" headers="mcps1.3.2.2.1.3.1.2 "><p id="kms_02_0057__en-us_topic_0170884210_p96023581259">Schedules the deletion of a specific key. The deletion can be scheduled 7 to 1096 days in advance. After a key is deleted, the data encrypted using the key cannot be decrypted.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0057__en-us_topic_0170884210_row218953112619"><td class="cellrowborder" valign="top" width="29.630000000000003%" headers="mcps1.3.2.2.1.3.1.1 "><p id="kms_02_0057__en-us_topic_0170884210_p518933172613"><a href="kms_02_0016.html#kms_02_0016">Canceling the Scheduled Deletion of a CMK</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70.37%" headers="mcps1.3.2.2.1.3.1.2 "><p id="kms_02_0057__en-us_topic_0170884210_p1318911372613">Cancels a scheduled deletion of a key. Once the deletion is cancelled, the key can be used.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0057__en-us_topic_0170884210_row3404189192616"><td class="cellrowborder" valign="top" width="29.630000000000003%" headers="mcps1.3.2.2.1.3.1.1 "><p id="kms_02_0057__en-us_topic_0170884210_p14059915267"><a href="kms_02_0017.html#kms_02_0017">Querying the List of CMKs</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70.37%" headers="mcps1.3.2.2.1.3.1.2 "><p id="kms_02_0057__en-us_topic_0170884210_p1740529172617">Queries the list of all CMKs.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0057__en-us_topic_0170884210_row12054715262"><td class="cellrowborder" valign="top" width="29.630000000000003%" headers="mcps1.3.2.2.1.3.1.1 "><p id="kms_02_0057__en-us_topic_0170884210_p32051173263"><a href="kms_02_0018.html#kms_02_0018">Querying the Information About a CMK</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70.37%" headers="mcps1.3.2.2.1.3.1.2 "><p id="kms_02_0057__en-us_topic_0170884210_p102052715263">Queries details of a specified key.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0057__en-us_topic_0170884210_row9823134982516"><td class="cellrowborder" valign="top" width="29.630000000000003%" headers="mcps1.3.2.2.1.3.1.1 "><p id="kms_02_0057__en-us_topic_0170884210_p536471910307"><a href="kms_02_0019.html#kms_02_0019">Creating a Random Number</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70.37%" headers="mcps1.3.2.2.1.3.1.2 "><p id="kms_02_0057__en-us_topic_0170884210_p1682374992518">Generates a 512-bit random number.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0057__en-us_topic_0170884210_row119151718237"><td class="cellrowborder" valign="top" width="29.630000000000003%" headers="mcps1.3.2.2.1.3.1.1 "><p id="kms_02_0057__en-us_topic_0170884210_p49167710234"><a href="kms_02_0020.html#kms_02_0020">Creating a DEK</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70.37%" headers="mcps1.3.2.2.1.3.1.2 "><p id="kms_02_0057__en-us_topic_0170884210_p129161675236">Creates a DEK. A returned result includes the plaintext and the ciphertext of a DEK.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0057__en-us_topic_0170884210_row2485721289"><td class="cellrowborder" valign="top" width="29.630000000000003%" headers="mcps1.3.2.2.1.3.1.1 "><p id="kms_02_0057__en-us_topic_0170884210_p14851827285"><a href="kms_02_0021.html#kms_02_0021">Creating a Plaintext-Free DEK</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70.37%" headers="mcps1.3.2.2.1.3.1.2 "><p id="kms_02_0057__en-us_topic_0170884210_p1948517216285">Creates a plaintext-free DEK, that is, the returned result of this API includes only the ciphertext of the DEK.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0057__en-us_topic_0170884210_row1451317082810"><td class="cellrowborder" valign="top" width="29.630000000000003%" headers="mcps1.3.2.2.1.3.1.1 "><p id="kms_02_0057__en-us_topic_0170884210_p7513140152814"><a href="kms_02_0022.html#kms_02_0022">Encrypting a DEK</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70.37%" headers="mcps1.3.2.2.1.3.1.2 "><p id="kms_02_0057__en-us_topic_0170884210_p3513140142812">Uses a specified CMK to encrypt a DEK.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0057__en-us_topic_0170884210_row197618589273"><td class="cellrowborder" valign="top" width="29.630000000000003%" headers="mcps1.3.2.2.1.3.1.1 "><p id="kms_02_0057__en-us_topic_0170884210_p4761258202713"><a href="kms_02_0023.html#kms_02_0023">Decrypting a DEK</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70.37%" headers="mcps1.3.2.2.1.3.1.2 "><p id="kms_02_0057__en-us_topic_0170884210_p2761205810273">Uses a specified CMK to decrypt a DEK.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0057__en-us_topic_0170884210_row95309213296"><td class="cellrowborder" valign="top" width="29.630000000000003%" headers="mcps1.3.2.2.1.3.1.1 "><p id="kms_02_0057__en-us_topic_0170884210_p73628193302"><a href="kms_02_0024.html#kms_02_0024">Querying the Number of Instances</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70.37%" headers="mcps1.3.2.2.1.3.1.2 "><p id="kms_02_0057__en-us_topic_0170884210_p141321122298">Obtains the number of created CMKs, excluding the default master keys.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0057__en-us_topic_0170884210_row13528160192911"><td class="cellrowborder" valign="top" width="29.630000000000003%" headers="mcps1.3.2.2.1.3.1.1 "><p id="kms_02_0057__en-us_topic_0170884210_p17889915112911"><a href="kms_02_0025.html#kms_02_0025">Querying the Quota of a User</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70.37%" headers="mcps1.3.2.2.1.3.1.2 "><p id="kms_02_0057__en-us_topic_0170884210_p588951510294">Queries the total quota of CMKs available and the usage information, excluding the default master keys.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0057__en-us_topic_0170884210_row9402105820289"><td class="cellrowborder" valign="top" width="29.630000000000003%" headers="mcps1.3.2.2.1.3.1.1 "><p id="kms_02_0057__en-us_topic_0170884210_p1896422714296"><a href="kms_02_0026.html#kms_02_0026">Changing the Alias of a CMK</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70.37%" headers="mcps1.3.2.2.1.3.1.2 "><p id="kms_02_0057__en-us_topic_0170884210_p1892914188298">Changes the alias of a CMK.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0057__en-us_topic_0170884210_row18681566281"><td class="cellrowborder" valign="top" width="29.630000000000003%" headers="mcps1.3.2.2.1.3.1.1 "><p id="kms_02_0057__en-us_topic_0170884210_p16132812192910"><a href="kms_02_0027.html#kms_02_0027">Changing the Description of a CMK</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70.37%" headers="mcps1.3.2.2.1.3.1.2 "><p id="kms_02_0057__en-us_topic_0170884210_p161289916297">Changes the description of a CMK.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0057__en-us_topic_0170884210_row8235125692712"><td class="cellrowborder" valign="top" width="29.630000000000003%" headers="mcps1.3.2.2.1.3.1.1 "><p id="kms_02_0057__en-us_topic_0170884210_p5269195653111"><a href="kms_02_0028.html#kms_02_0028">Creating a Grant</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70.37%" headers="mcps1.3.2.2.1.3.1.2 "><p id="kms_02_0057__en-us_topic_0170884210_p19959150193219">Grants a user the permissions required for operating a specific key.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0057__en-us_topic_0170884210_row7445154215311"><td class="cellrowborder" valign="top" width="29.630000000000003%" headers="mcps1.3.2.2.1.3.1.1 "><p id="kms_02_0057__en-us_topic_0170884210_p164451242143120"><a href="kms_02_0029.html#kms_02_0029">Revoking a Grant</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70.37%" headers="mcps1.3.2.2.1.3.1.2 "><p id="kms_02_0057__en-us_topic_0170884210_p11958180113211">Revokes the key operation permissions granted to a user.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0057__en-us_topic_0170884210_row20793124814319"><td class="cellrowborder" valign="top" width="29.630000000000003%" headers="mcps1.3.2.2.1.3.1.1 "><p id="kms_02_0057__en-us_topic_0170884210_p2793548103115"><a href="kms_02_0030.html#kms_02_0030">Retiring a Grant</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70.37%" headers="mcps1.3.2.2.1.3.1.2 "><p id="kms_02_0057__en-us_topic_0170884210_p895611063215">Retires the granted key operation permissions.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0057__en-us_topic_0170884210_row1737134643117"><td class="cellrowborder" valign="top" width="29.630000000000003%" headers="mcps1.3.2.2.1.3.1.1 "><p id="kms_02_0057__en-us_topic_0170884210_p1273717469314"><a href="kms_02_0031.html#kms_02_0031">Querying Grants on a CMK</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70.37%" headers="mcps1.3.2.2.1.3.1.2 "><p id="kms_02_0057__en-us_topic_0170884210_p10955190153218">Queries grants of a CMK.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0057__en-us_topic_0170884210_row37536407310"><td class="cellrowborder" valign="top" width="29.630000000000003%" headers="mcps1.3.2.2.1.3.1.1 "><p id="kms_02_0057__en-us_topic_0170884210_p13754114043116"><a href="kms_02_0032.html#kms_02_0032">Querying Grants That Can Be Retired</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70.37%" headers="mcps1.3.2.2.1.3.1.2 "><p id="kms_02_0057__en-us_topic_0170884210_p1995460183215">Queries grants that can be retired.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0057__en-us_topic_0170884210_row273411591512"><td class="cellrowborder" valign="top" width="29.630000000000003%" headers="mcps1.3.2.2.1.3.1.1 "><p id="kms_02_0057__en-us_topic_0170884210_p87341059754"><a href="kms_02_0035.html#kms_02_0035">Obtaining CMK Import Parameters</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70.37%" headers="mcps1.3.2.2.1.3.1.2 "><p id="kms_02_0057__en-us_topic_0170884210_p29531010324">Obtains necessary parameters to import a key, including an import token and an encryption public key.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0057__en-us_topic_0170884210_row610942717348"><td class="cellrowborder" valign="top" width="29.630000000000003%" headers="mcps1.3.2.2.1.3.1.1 "><p id="kms_02_0057__en-us_topic_0170884210_p5109112763410"><a href="kms_02_0036.html#kms_02_0036">Importing CMK Material</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70.37%" headers="mcps1.3.2.2.1.3.1.2 "><p id="kms_02_0057__en-us_topic_0170884210_p210982773418">Imports the key material of a specified key.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0057__en-us_topic_0170884210_row0193112563117"><td class="cellrowborder" valign="top" width="29.630000000000003%" headers="mcps1.3.2.2.1.3.1.1 "><p id="kms_02_0057__en-us_topic_0170884210_p181931325123110"><a href="kms_02_0037.html#kms_02_0037">Deleting CMK Material</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70.37%" headers="mcps1.3.2.2.1.3.1.2 "><p id="kms_02_0057__en-us_topic_0170884210_p17951900321">Deletes the key material of a specified key.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0057__en-us_topic_0170884210_row9447165213327"><td class="cellrowborder" valign="top" width="29.630000000000003%" headers="mcps1.3.2.2.1.3.1.1 "><p id="kms_02_0057__en-us_topic_0170884210_p23312166366"><a href="kms_02_0042.html#kms_02_0042">Querying CMK Instances</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70.37%" headers="mcps1.3.2.2.1.3.1.2 "><p id="kms_02_0057__en-us_topic_0170884210_p1334160363">Uses the tag filtering function to query the detailed information of a CMK.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0057__en-us_topic_0170884210_row1473418590511"><td class="cellrowborder" valign="top" width="29.630000000000003%" headers="mcps1.3.2.2.1.3.1.1 "><p id="kms_02_0057__en-us_topic_0170884210_p1873418594515"><a href="kms_02_0043.html#kms_02_0043">Querying CMK Tags</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70.37%" headers="mcps1.3.2.2.1.3.1.2 "><p id="kms_02_0057__en-us_topic_0170884210_p16948701328">Queries tags of a CMK.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0057__en-us_topic_0170884210_row651175619363"><td class="cellrowborder" valign="top" width="29.630000000000003%" headers="mcps1.3.2.2.1.3.1.1 "><p id="kms_02_0057__en-us_topic_0170884210_p6511185623618"><a href="kms_02_0044.html#kms_02_0044">Querying Project Tags</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70.37%" headers="mcps1.3.2.2.1.3.1.2 "><p id="kms_02_0057__en-us_topic_0170884210_p1051155611364">Queries all tag sets of a project.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0057__en-us_topic_0170884210_row1759018541361"><td class="cellrowborder" valign="top" width="29.630000000000003%" headers="mcps1.3.2.2.1.3.1.1 "><p id="kms_02_0057__en-us_topic_0170884210_p1759015419365"><a href="kms_02_0045.html#kms_02_0045">Adding or Deleting CMK Tags in Batches</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70.37%" headers="mcps1.3.2.2.1.3.1.2 "><p id="kms_02_0057__en-us_topic_0170884210_p8590175423610">Adds or deletes CMK tags in a batch.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0057__en-us_topic_0170884210_row1866395833611"><td class="cellrowborder" valign="top" width="29.630000000000003%" headers="mcps1.3.2.2.1.3.1.1 "><p id="kms_02_0057__en-us_topic_0170884210_p126631558143614"><a href="kms_02_0046.html#kms_02_0046">Adding a CMK Tag</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70.37%" headers="mcps1.3.2.2.1.3.1.2 "><p id="kms_02_0057__en-us_topic_0170884210_p3663258153617">Adds a tag to a CMK.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0057__en-us_topic_0170884210_row103767529364"><td class="cellrowborder" valign="top" width="29.630000000000003%" headers="mcps1.3.2.2.1.3.1.1 "><p id="kms_02_0057__en-us_topic_0170884210_p43761452193616"><a href="kms_02_0047.html#kms_02_0047">Deleting a CMK Tag</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70.37%" headers="mcps1.3.2.2.1.3.1.2 "><p id="kms_02_0057__en-us_topic_0170884210_p1637613523368">Deletes a tag from a CMK.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0057__en-us_topic_0170884210_row1873495910510"><td class="cellrowborder" valign="top" width="29.630000000000003%" headers="mcps1.3.2.2.1.3.1.1 "><p id="kms_02_0057__en-us_topic_0170884210_p373419591456"><a href="kms_02_0048.html#kms_02_0048">Querying All API Versions</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70.37%" headers="mcps1.3.2.2.1.3.1.2 "><p id="kms_02_0057__en-us_topic_0170884210_p69474015328">-</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0057__en-us_topic_0170884210_row197051116378"><td class="cellrowborder" valign="top" width="29.630000000000003%" headers="mcps1.3.2.2.1.3.1.1 "><p id="kms_02_0057__en-us_topic_0170884210_p970518116375"><a href="kms_02_0049.html#kms_02_0049">Querying a Specified API Version</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70.37%" headers="mcps1.3.2.2.1.3.1.2 "><p id="kms_02_0057__en-us_topic_0170884210_p870531123720">-</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|