forked from docs/doc-exports
KMS API 20230817 version.
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>
This commit is contained in:
parent
c9ede6a90e
commit
dfe65b9551
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
554
docs/kms/api-ref/Sign.html
Normal file
554
docs/kms/api-ref/Sign.html
Normal file
File diff suppressed because it is too large
Load Diff
548
docs/kms/api-ref/ValidateSignature.html
Normal file
548
docs/kms/api-ref/ValidateSignature.html
Normal file
File diff suppressed because it is too large
Load Diff
BIN
docs/kms/api-ref/en-us_image_0218769431.png
Normal file
BIN
docs/kms/api-ref/en-us_image_0218769431.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 50 KiB |
BIN
docs/kms/api-ref/en-us_image_0264400728.png
Normal file
BIN
docs/kms/api-ref/en-us_image_0264400728.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 48 KiB |
@ -1,8 +0,0 @@
|
||||
<a name="en-us_topic_00384375969"></a><a name="en-us_topic_00384375969"></a>
|
||||
|
||||
<h1 class="topictitle1">API Usage Guidelines</h1>
|
||||
<div id="body1530174454877"><p id="en-us_topic_00384375969__en-us_topic_0119070335_p1645204610259">Public cloud APIs comply with the RESTful API design principles. REST-based Web services are organized into resources. Each resource is identified by one or more Uniform Resource Identifiers (URIs). An application accesses a resource based on the resource's Unified Resource Locator (URL). A URL is usually in the following format: <em id="en-us_topic_00384375969__en-us_topic_0119070335_i1385069210259">https://Endpoint/uri</em>. In the URL, <strong id="en-us_topic_00384375969__en-us_topic_0119070335_b5754736910259">uri</strong> indicates the resource path, that is, the API access path.</p>
|
||||
<p id="en-us_topic_00384375969__en-us_topic_0119070335_p4816427810259">Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted by using JSON messages, with media type represented by <strong id="en-us_topic_00384375969__en-us_topic_0119070335_b3082532510259">Application/json</strong>.</p>
|
||||
<p id="en-us_topic_00384375969__en-us_topic_0119070335_p188289482118">For details about how to use APIs, see <a href="https://docs.otc.t-systems.com/en-us/api/apiug/apig-en-api-180328001.html?tag=API Documents" target="_blank" rel="noopener noreferrer">API Usage Guidelines</a>.</p>
|
||||
</div>
|
||||
|
||||
70
docs/kms/api-ref/kms_02_0001.html
Normal file
70
docs/kms/api-ref/kms_02_0001.html
Normal file
@ -0,0 +1,70 @@
|
||||
<a name="kms_02_0001"></a><a name="kms_02_0001"></a>
|
||||
|
||||
<h1 class="topictitle1">Making an API Request</h1>
|
||||
<div id="body32001227"><p id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_p8141141101615">This section describes the structure of a REST API request, and uses the IAM API for <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">obtaining a user token</a> as an example to demonstrate how to call an API. The obtained token can then be used to authenticate the calling of other APIs.</p>
|
||||
<div class="section" id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_section1849899574"><h4 class="sectiontitle">Request URI</h4><p id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_p729531715312">A request URI is in the following format:</p>
|
||||
<p id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_p11610193811547"><strong id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_b3129104565416">{URI-scheme} :// {<strong id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_b10231116812">Endpoint</strong>} / {resource-path} ? {query-string}</strong></p>
|
||||
<p id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_p19153141415558">Although a request URI is included in the request header, most programming languages or frameworks require the request URI to be transmitted separately.</p>
|
||||
<ul id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_ul1252522141910"><li id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_li189491651174717"><strong id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_b13950251174714">URI-scheme</strong>:<p id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_p1697825294716">Protocol used to transmit requests. All APIs use HTTPS.</p>
|
||||
</li><li id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_li9112205519475"><strong id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_b71122558472">Endpoint</strong>:<p id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_p102531159154713">Domain name or IP address of the server bearing the REST service. The endpoint varies between services in different regions. It can be obtained from the administrator.</p>
|
||||
</li><li id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_li370732114810"><strong id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_b146431581502">resource-path</strong>:<p id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_p8506183194819">Access path of an API for performing a specified operation. Obtain the path from the URI of an API. For example, the <strong id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_b41031934110">resource-path</strong> of the API used to obtain a user token is <span class="parmvalue" id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_parmvalue10149384167"><b>/v3/auth/tokens</b></span>.</p>
|
||||
</li><li id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_li773319494816"><strong id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_b1366984011119">query-string</strong>:<p id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_p1727319564810">Query parameter, which is optional. Ensure that a question mark (?) is included before each query parameter that is in the format of "Parameter name=Parameter value". For example, <span class="parmname" id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_parmname10639423639"><b>?limit=10</b></span> indicates that a maximum of 10 data records will be displayed.</p>
|
||||
</li></ul>
|
||||
<div class="note" id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_note16311253154112"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_p163316534416">To simplify the URI display in this document, each API is provided only with a <span class="parmname" id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_parmname2744446171220"><b>resource-path</b></span> and a request method. The <span class="parmname" id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_parmname1930591721317"><b>URI-scheme</b></span> of all APIs is <span class="parmname" id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_parmname8102195251313"><b>HTTPS</b></span>, and the endpoints of all APIs in the same region are identical.</p>
|
||||
</div></div>
|
||||
</div>
|
||||
<div class="section" id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_section580035055419"><h4 class="sectiontitle">Request Methods</h4><p id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_p65661618145510">The HTTP protocol defines the following request methods that can be used to send a request to the server:</p>
|
||||
<ul id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_ul11356238151312"><li id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_li1835819385137"><strong id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_b134821659191217">GET</strong>: requests the server to return specified resources.</li><li id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_li95631239131310"><strong id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_b13110121521312">PUT</strong>: requests the server to update specified resources.</li><li id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_li1554910413138"><strong id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_b10756134061312">POST</strong>: requests the server to add resources or perform special operations.</li><li id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_li8237114421314"><strong id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_b94535841311">DELETE</strong>: requests the server to delete specified resources, for example, an object.</li><li id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_li165331349151317"><strong id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_b139911817149">HEAD</strong>: same as GET except that the server must return only the response header.</li><li id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_li4440175411313"><strong id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_b2820378146">PATCH</strong>: requests the server to update partial content of a specified resource. If the resource does not exist, a new resource will be created.</li></ul>
|
||||
<p id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_p3759142614815">For example, in the case of the API used to <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">obtain a user token</a>, the request method is POST. The request is as follows:</p>
|
||||
<pre class="screen" id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_screen7888377244">POST https://{{endpoint}}/v3/auth/tokens</pre>
|
||||
</div>
|
||||
<div class="section" id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_section1454211155819"><h4 class="sectiontitle">Request Header</h4><p id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_p11811752397">You can also add additional header fields to a request, such as the fields required by a specified URI or HTTP method. For example, to request for the authentication information, add <span class="parmname" id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_parmname17561356151920"><b>Content-Type</b></span>, which specifies the request body type.</p>
|
||||
<p id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_p1467193205816">Common request header fields are as follows:</p>
|
||||
<ul id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_ul157293410593"><li id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_li972916419595"><strong id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_b193861616191917">Content-Type</strong>: specifies the request body type or format. This field is mandatory and its default value is <span class="parmvalue" id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_parmvalue87331219202115"><b>application/json</b></span>. Other values of this field will be provided for specific APIs if any.</li><li id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_li1642421012595"><strong id="kms_02_0001__en-us_topic_0171850909_b106124363150">X-Auth-Token</strong>: specifies a user token only for token-based API authentication. The user token is a response to the API used to <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">obtain a user token</a>. This API is the only one that does not require authentication.<div class="note" id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_note13771123325011"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_p1513412221808">In addition to supporting token-based authentication, APIs also support authentication using access key ID/secret access key (AK/SK). During AK/SK-based authentication, an SDK is used to sign the request, and the <span class="parmname" id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_parmname20203125615277"><b>Authorization</b></span> (signature information) and <span class="parmname" id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_parmname14331262816"><b>X-Sdk-Date</b></span> (time when the request is sent) header fields are automatically added to the request.</p>
|
||||
<p id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_p1577123365010">For more information, see .</p>
|
||||
</div></div>
|
||||
</li></ul>
|
||||
<p id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_p42118461957">The API used to <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">obtain a user token</a> does not require authentication. Therefore, only the <strong id="kms_02_0001__en-us_topic_0171850909_b0253634097">Content-Type</strong> field needs to be added to requests for calling the API. An example of such requests is as follows:</p>
|
||||
<pre class="screen" id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_screen73731462616">POST https://{{endpoint}}/v3/auth/tokens
|
||||
Content-Type: application/json</pre>
|
||||
</div>
|
||||
<div class="section" id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_section14612192315587"><h4 class="sectiontitle">Request Body</h4><p id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_p23132011213">The body of a request is often sent in a structured format as specified in the <span class="parmname" id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_parmname8729201013377"><b>Content-Type</b></span> header field. The request body transfers content except the request header.</p>
|
||||
<p id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_p1847214711331">The request body varies between APIs. Some APIs do not require the request body, such as the APIs requested using the GET and DELETE methods.</p>
|
||||
<p id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_p105261225101112">In the case of the API used to <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">obtain a user token</a>, the request parameters and parameter description can be obtained from the API request. The following provides an example request with a body included. Set <em id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_i174716971020"><strong id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_b44710910106">username</strong></em> to the name of a user, <em id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_i0988195621119"><strong id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_b1598875611111">domainname</strong></em> to the name of the account that the user belongs to, <strong id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_b181511322135"><em id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_i1615102161312">********</em></strong> to the user's login password, and <strong id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_b628610137174"><em id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_i14286151318172">xxxxxxxxxxxxxxxxxx</em></strong> to the project name. You can learn more information about projects from .</p>
|
||||
<div class="note" id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_note15403511418"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_p199011223194814">The <span class="parmname" id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_parmname940418238457"><b>scope</b></span> parameter specifies where a token takes effect. You can set <span class="parmname" id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_parmname145641316252"><b>scope</b></span> to an account or a project under an account. In the following example, the token takes effect only for the resources in a specified project. For more information about this API, see <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">Obtaining a User Token</a>.</p>
|
||||
</div></div>
|
||||
<pre class="screen" id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_screen6140617194816">
|
||||
POST https://{{endpoint}}/v3/auth/tokens
|
||||
Content-Type: application/json
|
||||
{
|
||||
"auth": {
|
||||
"identity": {
|
||||
"methods": [
|
||||
"password"
|
||||
],
|
||||
"password": {
|
||||
"user": {
|
||||
"name": "<em id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_i315217719194"><strong id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_b14500116161919">username</strong></em>",
|
||||
"password": "<strong id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_b2559181251918"><em id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_i12803128192">********</em></strong>",
|
||||
"domain": {
|
||||
"name": "<em id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_i1560271681911"><strong id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_b17173191614194">domainname</strong></em>"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"scope": {
|
||||
"project": {
|
||||
"name": "<strong id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_b1261200101711"><em id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_i186128061711">xxxxxxxxxxxxxxxxxx</em></strong>"
|
||||
}
|
||||
}
|
||||
}
|
||||
}</pre>
|
||||
<p id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_p1859663401915">If all data required for the API request is available, you can send the request to call the API through <a href="https://curl.haxx.se/" target="_blank" rel="noopener noreferrer">curl</a>, <a href="https://www.getpostman.com/" target="_blank" rel="noopener noreferrer">Postman</a>, or coding. In the response to the API used to obtain a user token, <span class="parmname" id="kms_02_0001__en-us_topic_0171850909_en-us_topic_0091607286_parmname1744412247513"><b>x-subject-token</b></span> is the desired user token. This token can then be used to authenticate the calling of other APIs.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0002.html">Calling APIs</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
15
docs/kms/api-ref/kms_02_0002.html
Normal file
15
docs/kms/api-ref/kms_02_0002.html
Normal file
@ -0,0 +1,15 @@
|
||||
<a name="kms_02_0002"></a><a name="kms_02_0002"></a>
|
||||
|
||||
<h1 class="topictitle1">Calling APIs</h1>
|
||||
<div id="body32001227"></div>
|
||||
<div>
|
||||
<ul class="ullinks">
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0001.html">Making an API Request</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0003.html">Authentication</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0056.html">Returned Values</a></strong><br>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
12
docs/kms/api-ref/kms_02_0003.html
Normal file
12
docs/kms/api-ref/kms_02_0003.html
Normal file
@ -0,0 +1,12 @@
|
||||
<a name="kms_02_0003"></a><a name="kms_02_0003"></a>
|
||||
|
||||
<h1 class="topictitle1">Authentication</h1>
|
||||
<div id="body8662426"><div class="p" id="kms_02_0003__en-us_topic_0207581476_en-us_topic_0091607401_p26613555143846">Requests for calling an API can be authenticated using either of the following methods:<ul id="kms_02_0003__en-us_topic_0207581476_en-us_topic_0091607401_ul38195410143846"><li id="kms_02_0003__en-us_topic_0207581476_en-us_topic_0091607401_li8214375143846">Token-based authentication: Requests are authenticated using a token.</li><li id="kms_02_0003__en-us_topic_0207581476_en-us_topic_0091607401_li61384639143846">AK/SK-based authentication: Requests are authenticated by encrypting the request body using an AK/SK pair. This method is recommended because it provides higher security than token-based authentication.</li></ul>
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0002.html">Calling APIs</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@ -4,77 +4,7 @@
|
||||
<div id="body1516240388172"></div>
|
||||
<div>
|
||||
<ul class="ullinks">
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0012.html">Creating a CMK</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0013.html">Enabling a CMK</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0014.html">Disabling a CMK</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0015.html">Scheduling the Deletion of a CMK</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0016.html">Canceling the Scheduled Deletion of a CMK</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0017.html">Querying the List of CMKs</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0018.html">Querying the Information About a CMK</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0019.html">Creating a Random Number</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0020.html">Creating a DEK</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0021.html">Creating a Plaintext-Free DEK</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0022.html">Encrypting a DEK</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0023.html">Decrypting a DEK</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0024.html">Querying the Number of Instances</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0025.html">Querying the Quota of a User</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0026.html">Changing the Alias of a CMK</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0027.html">Changing the Description of a CMK</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0028.html">Creating a Grant</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0029.html">Revoking a Grant</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0030.html">Retiring a Grant</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0031.html">Querying Grants on a CMK</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0032.html">Querying Grants That Can Be Retired</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0035.html">Obtaining CMK Import Parameters</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0036.html">Importing CMK Material</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0037.html">Deleting CMK Material</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0038.html">Enabling Rotation for a CMK</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0039.html">Changing the Rotation Interval for a CMK</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0040.html">Disabling Rotation for a CMK</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0041.html">Querying the Rotation Status of a CMK</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0042.html">Querying CMK Instances</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0043.html">Querying CMK Tags</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0044.html">Querying Project Tags</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0045.html">Adding or Deleting CMK Tags in Batches</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0046.html">Adding a CMK Tag</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0047.html">Deleting a CMK Tag</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0048.html">Querying All API Versions</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0049.html">Querying a Specified API Version</a></strong><br>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0011.html">CMK Management</a></strong><br>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
97
docs/kms/api-ref/kms_02_0011.html
Normal file
97
docs/kms/api-ref/kms_02_0011.html
Normal file
@ -0,0 +1,97 @@
|
||||
<a name="kms_02_0011"></a><a name="kms_02_0011"></a>
|
||||
|
||||
|
||||
<h1 class="topictitle1">CMK Management</h1>
|
||||
|
||||
<div id="body0000001338137528"><p id="kms_02_0011__p8060118"></p>
|
||||
</div>
|
||||
|
||||
<div>
|
||||
<ul class="ullinks">
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0012.html">Creating a CMK</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0013.html">Enabling a CMK</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0014.html">Disabling a CMK</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0015.html">Scheduling the Deletion of a CMK</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0016.html">Canceling the Scheduled Deletion of a CMK</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0017.html">Querying the List of CMKs</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0018.html">Querying the Information About a CMK</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0019.html">Creating a Random Number</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0020.html">Creating a DEK</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0021.html">Creating a Plaintext-Free DEK</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0022.html">Encrypting a DEK</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0023.html">Decrypting a DEK</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0024.html">Querying the Number of Instances</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0025.html">Querying the Quota of a User</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0026.html">Changing the Alias of a CMK</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0027.html">Changing the Description of a CMK</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0028.html">Creating a Grant</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0029.html">Revoking a Grant</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0030.html">Retiring a Grant</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0031.html">Querying Grants on a CMK</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0032.html">Querying Grants That Can Be Retired</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0033.html">Encrypting Data</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0034.html">Decrypting Data</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="Sign.html">Signing Data</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="ValidateSignature.html">Authenticating a Signature</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0035.html">Obtaining CMK Import Parameters</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0036.html">Importing CMK Material</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0037.html">Deleting CMK Material</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0038.html">Enabling Rotation for a CMK</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0039.html">Changing the Rotation Interval for a CMK</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0040.html">Disabling Rotation for a CMK</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0041.html">Querying the Rotation Status of a CMK</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0042.html">Querying CMK Instances</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0043.html">Querying CMK Tags</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0044.html">Querying Project Tags</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0045.html">Adding or Deleting CMK Tags in Batches</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0046.html">Adding a CMK Tag</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0047.html">Deleting a CMK Tag</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0048.html">Querying All API Versions</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="kms_02_0049.html">Querying a Specified API Version</a></strong><br>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0010.html">APIs</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@ -51,6 +51,26 @@
|
||||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.2.5.1.4 "><p id="kms_02_0012__en-us_topic_0112992294_p3802087110164">Alias of a non-default master key (The alias's length ranges from 1 to 255 characters and matches the regular expression <span class="parmvalue" id="kms_02_0012__en-us_topic_0112992294_parmvalue698033652174049"><b>^[a-zA-Z0-9:/_-]{1,255}$</b></span>. In addition, it must be different from the alias of a Default Master Key created by the system.)</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="kms_02_0012__en-us_topic_0112992294_row1554519356110"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.2.5.1.1 "><p id="kms_02_0012__en-us_topic_0112992294_p184297402018">key_spec</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.5.1.2 "><p id="kms_02_0012__en-us_topic_0112992294_p1543084018011">No</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.2.5.1.3 "><p id="kms_02_0012__en-us_topic_0112992294_p5430840100">String</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.2.5.1.4 "><p id="kms_02_0012__en-us_topic_0112992294_p343112401005">Key generation algorithm. The default value is <strong id="kms_02_0012__en-us_topic_0112992294_b11404181617431">AES_256</strong>. Its value can be:</p>
|
||||
<ul id="kms_02_0012__en-us_topic_0112992294_ul1443134012019"><li id="kms_02_0012__en-us_topic_0112992294_li174311540607">AES_256</li><li id="kms_02_0012__en-us_topic_0112992294_li184326401605">RSA_2048</li><li id="kms_02_0012__en-us_topic_0112992294_li1643394012011">RSA_3072</li><li id="kms_02_0012__en-us_topic_0112992294_li164332040108">RSA_4096</li><li id="kms_02_0012__en-us_topic_0112992294_li134348401700">EC_P256</li><li id="kms_02_0012__en-us_topic_0112992294_li184342040306">EC_P384</li></ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="kms_02_0012__en-us_topic_0112992294_row691845715118"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.2.5.1.1 "><p id="kms_02_0012__en-us_topic_0112992294_p74362401302">key_usage</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.5.1.2 "><p id="kms_02_0012__en-us_topic_0112992294_p1143719401108">No</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.2.5.1.3 "><p id="kms_02_0012__en-us_topic_0112992294_p043710408015">String</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.2.5.1.4 "><p id="kms_02_0012__en-us_topic_0112992294_p144371140108">Key usage. The default value is <strong id="kms_02_0012__en-us_topic_0112992294_b1250211236434">ENCRYPT_DECRYPT</strong> for a symmetric key and <strong id="kms_02_0012__en-us_topic_0112992294_b33329124314">SIGN_VERIFY</strong> for an asymmetric key. Its value can be:</p>
|
||||
<ul id="kms_02_0012__en-us_topic_0112992294_ul208912424407"><li id="kms_02_0012__en-us_topic_0112992294_li18891942194019">For AES_256 symmetric keys, the default value is <strong id="kms_02_0012__en-us_topic_0112992294_b160742516224">ENCRYPT_DECRYPT</strong>.</li><li id="kms_02_0012__en-us_topic_0112992294_li18423104617406">For RSA asymmetric keys, select <strong id="kms_02_0012__en-us_topic_0112992294_b107235189236">ENCRYPT_DECRYPT</strong> or <strong id="kms_02_0012__en-us_topic_0112992294_b19723518172317">SIGN_VERIFY</strong>. The default value is <strong id="kms_02_0012__en-us_topic_0112992294_b1272410188234">SIGN_VERIFY</strong>.</li><li id="kms_02_0012__en-us_topic_0112992294_li1811912111419">For ECC asymmetric keys, the default value is <strong id="kms_02_0012__en-us_topic_0112992294_b16404174312318">SIGN_VERIFY</strong>.</li></ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="kms_02_0012__en-us_topic_0112992294_row2245699720624"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.2.5.1.1 "><p id="kms_02_0012__en-us_topic_0112992294_p707743220624">key_description</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.5.1.2 "><p id="kms_02_0012__en-us_topic_0112992294_p6281259420624">No</p>
|
||||
@ -184,7 +204,7 @@
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0010.html">APIs</a></div>
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0011.html">CMK Management</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
@ -168,7 +168,7 @@
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0010.html">APIs</a></div>
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0011.html">CMK Management</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
@ -167,7 +167,7 @@
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0010.html">APIs</a></div>
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0011.html">CMK Management</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
@ -150,7 +150,7 @@
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0010.html">APIs</a></div>
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0011.html">CMK Management</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
@ -143,7 +143,7 @@
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0010.html">APIs</a></div>
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0011.html">CMK Management</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
@ -221,7 +221,7 @@
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0010.html">APIs</a></div>
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0011.html">CMK Management</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
@ -269,7 +269,7 @@
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0010.html">APIs</a></div>
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0011.html">CMK Management</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
<a name="kms_02_0019"></a><a name="kms_02_0019"></a>
|
||||
|
||||
<h1 class="topictitle1">Creating a Random Number</h1>
|
||||
<div id="body1474684560498"><div class="section" id="kms_02_0019__en-us_topic_0112992308_s1731a14fb0144c79bf0fa90c694f34f7"><h4 class="sectiontitle">Function</h4><p id="kms_02_0019__en-us_topic_0112992308_p63253173613">This API generates a 512-bit random number.</p>
|
||||
<div id="body1474684560498"><div class="section" id="kms_02_0019__en-us_topic_0112992308_s1731a14fb0144c79bf0fa90c694f34f7"><h4 class="sectiontitle">Function</h4><p id="kms_02_0019__en-us_topic_0112992308_p19841010114614">This API generates a 512-bit random number.</p>
|
||||
</div>
|
||||
<div class="section" id="kms_02_0019__en-us_topic_0112992308_se70c3e5518a04f60b06032524dddfef4"><h4 class="sectiontitle">URI</h4><ul id="kms_02_0019__en-us_topic_0112992308_en-us_topic_0020091565_ul60390938"><li id="kms_02_0019__en-us_topic_0112992308_en-us_topic_0020091565_li6647531">URI format<p id="kms_02_0019__en-us_topic_0112992308_p138073181080"><a name="kms_02_0019__en-us_topic_0112992308_en-us_topic_0020091565_li6647531"></a><a name="en-us_topic_0112992308_en-us_topic_0020091565_li6647531"></a>POST /v1.0/{project_id}/kms/gen-random</p>
|
||||
</li><li id="kms_02_0019__en-us_topic_0112992308_en-us_topic_0020091565_li14211994">Parameter description
|
||||
@ -128,7 +128,7 @@
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0010.html">APIs</a></div>
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0011.html">CMK Management</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
@ -59,7 +59,7 @@
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.2.5.1.4 "><p id="kms_02_0020__en-us_topic_0112992330_p1658175312419">Key-value pairs with a maximum length of 8192 characters. This parameter is used to record resource context information, excluding sensitive information, to ensure data integrity.</p>
|
||||
<p id="kms_02_0020__en-us_topic_0112992330_p10713871141">If this parameter is specified during encryption, it is also required for decryption.</p>
|
||||
<p id="kms_02_0020__en-us_topic_0112992330_p416438915328">Example: {"Key1":"Value1","Key2":"Value2"}</p>
|
||||
<p id="kms_02_0020__en-us_topic_0112992330_p416438915328">Example: {"<strong id="kms_02_0020__en-us_topic_0112992330_b12744192710130">Key1</strong>":"<strong id="kms_02_0020__en-us_topic_0112992330_b77441427181310">Value1</strong>","<strong id="kms_02_0020__en-us_topic_0112992330_b674416275134">Key2</strong>":"<strong id="kms_02_0020__en-us_topic_0112992330_b207441927121311">Value2</strong>"}</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="kms_02_0020__en-us_topic_0112992330_row2638193101722"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.2.5.1.1 "><p id="kms_02_0020__en-us_topic_0112992330_p32137860112326">datakey_length</p>
|
||||
@ -171,7 +171,7 @@
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0010.html">APIs</a></div>
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0011.html">CMK Management</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
@ -32,7 +32,7 @@
|
||||
</li></ul>
|
||||
</div>
|
||||
<div class="section" id="kms_02_0021__en-us_topic_0112992350_seb7b7901701247fab30a59b76f1c7f93"><h4 class="sectiontitle">Requests</h4>
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0021__en-us_topic_0112992350_table46221022101230" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="kms_02_0021__en-us_topic_0112992350_row9315574101230"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.3.2.2.5.1.1"><p id="kms_02_0021__en-us_topic_0112992350_p16364058101230"><strong id="kms_02_0021__en-us_topic_0112992350_b1171423869">Parameter</strong></p>
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0021__en-us_topic_0112992350_table46221022101230" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="kms_02_0021__en-us_topic_0112992350_row9315574101230"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.3.2.2.5.1.1"><p id="kms_02_0021__en-us_topic_0112992350_p16364058101230"><strong id="kms_02_0021__en-us_topic_0112992350_b704323491">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_0021__en-us_topic_0112992350_p57514295101230"><strong id="kms_02_0021__en-us_topic_0112992350_b842352706184358">Mandatory</strong></p>
|
||||
</th>
|
||||
@ -60,7 +60,7 @@
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.2.5.1.4 "><p id="kms_02_0021__en-us_topic_0112992350_p299262517255">Key-value pairs with a maximum length of 8192 characters. This parameter is used to record resource context information, excluding sensitive information, to ensure data integrity.</p>
|
||||
<p id="kms_02_0021__en-us_topic_0112992350_p87033116108">If this parameter is specified during encryption, it is also required for decryption.</p>
|
||||
<p id="kms_02_0021__en-us_topic_0112992350_p10246613153136">Example: {"Key1":"Value1","Key2":"Value2"}</p>
|
||||
<p id="kms_02_0021__en-us_topic_0112992350_p10246613153136">Example: {"<strong id="kms_02_0021__en-us_topic_0112992350_b8936184531217">Key1</strong>":"<strong id="kms_02_0021__en-us_topic_0112992350_b15936845191217">Value1</strong>","<strong id="kms_02_0021__en-us_topic_0112992350_b1593624510129">Key2</strong>":"<strong id="kms_02_0021__en-us_topic_0112992350_b159369454123">Value2</strong>"}</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="kms_02_0021__en-us_topic_0112992350_row2638193101722"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.2.5.1.1 "><p id="kms_02_0021__en-us_topic_0112992350_p42501708113254">datakey_length</p>
|
||||
@ -87,7 +87,7 @@
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="kms_02_0021__en-us_topic_0112992350_sfadd53a5f4714e8f87811818d62d0296"><h4 class="sectiontitle">Responses</h4>
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0021__en-us_topic_0112992350_t98d238e10953421e84a073707024c329" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameters</caption><thead align="left"><tr id="kms_02_0021__en-us_topic_0112992350_r144a2c52c5054c6d9243eb2ef3875a21"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.4.2.2.5.1.1"><p id="kms_02_0021__en-us_topic_0112992350_a9156e0b03f054d4e8547e0787f88a51b"><strong id="kms_02_0021__en-us_topic_0112992350_b1704456831">Parameter</strong></p>
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0021__en-us_topic_0112992350_t98d238e10953421e84a073707024c329" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameters</caption><thead align="left"><tr id="kms_02_0021__en-us_topic_0112992350_r144a2c52c5054c6d9243eb2ef3875a21"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.4.2.2.5.1.1"><p id="kms_02_0021__en-us_topic_0112992350_a9156e0b03f054d4e8547e0787f88a51b"><strong id="kms_02_0021__en-us_topic_0112992350_b716496660">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_0021__en-us_topic_0112992350_a1851157c81e14d7f82db752a5737195a"><strong id="kms_02_0021__en-us_topic_0112992350_b842352706184445">Mandatory</strong></p>
|
||||
</th>
|
||||
@ -162,7 +162,7 @@
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0010.html">APIs</a></div>
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0011.html">CMK Management</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
@ -32,7 +32,7 @@
|
||||
</li></ul>
|
||||
</div>
|
||||
<div class="section" id="kms_02_0022__en-us_topic_0112992344_seb7b7901701247fab30a59b76f1c7f93"><h4 class="sectiontitle">Requests</h4>
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0022__en-us_topic_0112992344_table46221022101230" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="kms_02_0022__en-us_topic_0112992344_row9315574101230"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.3.2.2.5.1.1"><p id="kms_02_0022__en-us_topic_0112992344_p16364058101230"><strong id="kms_02_0022__en-us_topic_0112992344_b1139399128">Parameter</strong></p>
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0022__en-us_topic_0112992344_table46221022101230" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="kms_02_0022__en-us_topic_0112992344_row9315574101230"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.3.2.2.5.1.1"><p id="kms_02_0022__en-us_topic_0112992344_p16364058101230"><strong id="kms_02_0022__en-us_topic_0112992344_b312971662">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_0022__en-us_topic_0112992344_p57514295101230"><strong id="kms_02_0022__en-us_topic_0112992344_b842352706184654">Mandatory</strong></p>
|
||||
</th>
|
||||
@ -60,7 +60,7 @@
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.2.5.1.4 "><p id="kms_02_0022__en-us_topic_0112992344_p299262517255">Key-value pairs with a maximum length of 8192 characters. This parameter is used to record resource context information, excluding sensitive information, to ensure data integrity.</p>
|
||||
<p id="kms_02_0022__en-us_topic_0112992344_p87033116108">If this parameter is specified during encryption, it is also required for decryption.</p>
|
||||
<p id="kms_02_0022__en-us_topic_0112992344_p1998675413547">Example: {"Key1":"Value1","Key2":"Value2"}</p>
|
||||
<p id="kms_02_0022__en-us_topic_0112992344_p1998675413547">Example: {"<strong id="kms_02_0022__en-us_topic_0112992344_b07991322181213">Key1</strong>":"<strong id="kms_02_0022__en-us_topic_0112992344_b499914231121">Value1</strong>","<strong id="kms_02_0022__en-us_topic_0112992344_b82181925151219">Key2</strong>":"<strong id="kms_02_0022__en-us_topic_0112992344_b12582162615120">Value2</strong>"}</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="kms_02_0022__en-us_topic_0112992344_row57603225101653"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.2.5.1.1 "><p id="kms_02_0022__en-us_topic_0112992344_p40816810113819">plain_text</p>
|
||||
@ -97,7 +97,7 @@
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="kms_02_0022__en-us_topic_0112992344_sfadd53a5f4714e8f87811818d62d0296"><h4 class="sectiontitle">Responses</h4>
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0022__en-us_topic_0112992344_t98d238e10953421e84a073707024c329" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameters</caption><thead align="left"><tr id="kms_02_0022__en-us_topic_0112992344_r144a2c52c5054c6d9243eb2ef3875a21"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.4.2.2.5.1.1"><p id="kms_02_0022__en-us_topic_0112992344_a9156e0b03f054d4e8547e0787f88a51b"><strong id="kms_02_0022__en-us_topic_0112992344_b1442745791">Parameter</strong></p>
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0022__en-us_topic_0112992344_t98d238e10953421e84a073707024c329" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameters</caption><thead align="left"><tr id="kms_02_0022__en-us_topic_0112992344_r144a2c52c5054c6d9243eb2ef3875a21"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.4.2.2.5.1.1"><p id="kms_02_0022__en-us_topic_0112992344_a9156e0b03f054d4e8547e0787f88a51b"><strong id="kms_02_0022__en-us_topic_0112992344_b182602349">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_0022__en-us_topic_0112992344_a1851157c81e14d7f82db752a5737195a"><strong id="kms_02_0022__en-us_topic_0112992344_b842352706184736">Mandatory</strong></p>
|
||||
</th>
|
||||
@ -201,7 +201,7 @@ public static String bytesToHexString(byte[] digest) {
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0010.html">APIs</a></div>
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0011.html">CMK Management</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
@ -33,7 +33,7 @@
|
||||
</li></ul>
|
||||
</div>
|
||||
<div class="section" id="kms_02_0023__en-us_topic_0112992306_seb7b7901701247fab30a59b76f1c7f93"><h4 class="sectiontitle">Requests</h4>
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0023__en-us_topic_0112992306_table46221022101230" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="kms_02_0023__en-us_topic_0112992306_row9315574101230"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.3.2.2.5.1.1"><p id="kms_02_0023__en-us_topic_0112992306_p16364058101230"><strong id="kms_02_0023__en-us_topic_0112992306_b635817557">Parameter</strong></p>
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0023__en-us_topic_0112992306_table46221022101230" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="kms_02_0023__en-us_topic_0112992306_row9315574101230"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.3.2.2.5.1.1"><p id="kms_02_0023__en-us_topic_0112992306_p16364058101230"><strong id="kms_02_0023__en-us_topic_0112992306_b197624206">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_0023__en-us_topic_0112992306_p57514295101230"><strong id="kms_02_0023__en-us_topic_0112992306_b842352706185139">Mandatory</strong></p>
|
||||
</th>
|
||||
@ -61,7 +61,7 @@
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.2.5.1.4 "><p id="kms_02_0023__en-us_topic_0112992306_p299262517255">Key-value pairs with a maximum length of 8192 characters. This parameter is used to record resource context information, excluding sensitive information, to ensure data integrity.</p>
|
||||
<p id="kms_02_0023__en-us_topic_0112992306_p87033116108">If this parameter is specified during encryption, it is also required for decryption.</p>
|
||||
<p id="kms_02_0023__en-us_topic_0112992306_p23626609135526">Example: {"Key1":"Value1","Key2":"Value2"}</p>
|
||||
<p id="kms_02_0023__en-us_topic_0112992306_p23626609135526">Example: {"<strong id="kms_02_0023__en-us_topic_0112992306_b624033981212">Key1</strong>":"<strong id="kms_02_0023__en-us_topic_0112992306_b724017394124">Value1</strong>","<strong id="kms_02_0023__en-us_topic_0112992306_b3240123971212">Key2</strong>":"<strong id="kms_02_0023__en-us_topic_0112992306_b724013398124">Value2</strong>"}</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="kms_02_0023__en-us_topic_0112992306_row57603225101653"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.2.5.1.1 "><p id="kms_02_0023__en-us_topic_0112992306_p33956697114642">cipher_text</p>
|
||||
@ -97,7 +97,7 @@
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="kms_02_0023__en-us_topic_0112992306_sfadd53a5f4714e8f87811818d62d0296"><h4 class="sectiontitle">Responses</h4>
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0023__en-us_topic_0112992306_t98d238e10953421e84a073707024c329" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameters</caption><thead align="left"><tr id="kms_02_0023__en-us_topic_0112992306_r144a2c52c5054c6d9243eb2ef3875a21"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.4.2.2.5.1.1"><p id="kms_02_0023__en-us_topic_0112992306_a9156e0b03f054d4e8547e0787f88a51b"><strong id="kms_02_0023__en-us_topic_0112992306_b562682420">Parameter</strong></p>
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0023__en-us_topic_0112992306_t98d238e10953421e84a073707024c329" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameters</caption><thead align="left"><tr id="kms_02_0023__en-us_topic_0112992306_r144a2c52c5054c6d9243eb2ef3875a21"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.4.2.2.5.1.1"><p id="kms_02_0023__en-us_topic_0112992306_a9156e0b03f054d4e8547e0787f88a51b"><strong id="kms_02_0023__en-us_topic_0112992306_b595956375">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_0023__en-us_topic_0112992306_a1851157c81e14d7f82db752a5737195a"><strong id="kms_02_0023__en-us_topic_0112992306_b842352706185231">Mandatory</strong></p>
|
||||
</th>
|
||||
@ -184,7 +184,7 @@
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0010.html">APIs</a></div>
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0011.html">CMK Management</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
@ -95,7 +95,7 @@
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0010.html">APIs</a></div>
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0011.html">CMK Management</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
@ -175,7 +175,7 @@
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0010.html">APIs</a></div>
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0011.html">CMK Management</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
@ -176,7 +176,7 @@
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0010.html">APIs</a></div>
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0011.html">CMK Management</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
@ -176,7 +176,7 @@
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0010.html">APIs</a></div>
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0011.html">CMK Management</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
@ -32,9 +32,9 @@
|
||||
</li></ul>
|
||||
</div>
|
||||
<div class="section" id="kms_02_0028__en-us_topic_0112992333_section49179167154934"><h4 class="sectiontitle">Requests</h4>
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0028__en-us_topic_0112992333_table5096792154934" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="kms_02_0028__en-us_topic_0112992333_row37570371154934"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.3.2.2.5.1.1"><p id="kms_02_0028__en-us_topic_0112992333_p114081546134418"><strong id="kms_02_0028__en-us_topic_0112992333_b1793051207">Parameter</strong></p>
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0028__en-us_topic_0112992333_table5096792154934" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="kms_02_0028__en-us_topic_0112992333_row37570371154934"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.3.2.2.5.1.1"><p id="kms_02_0028__en-us_topic_0112992333_p114081546134418"><strong id="kms_02_0028__en-us_topic_0112992333_b252108086">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_0028__en-us_topic_0112992333_p9408546124415"><strong id="kms_02_0028__en-us_topic_0112992333_b1577368569">Mandatory</strong></p>
|
||||
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.3.2.2.5.1.2"><p id="kms_02_0028__en-us_topic_0112992333_p9408546124415"><strong id="kms_02_0028__en-us_topic_0112992333_b664774389">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_0028__en-us_topic_0112992333_p164081146134413">Type</p>
|
||||
</th>
|
||||
@ -92,6 +92,16 @@
|
||||
<p id="kms_02_0028__en-us_topic_0112992333_p342916081631">Example: 0d0466b00d0466b00d0466b00d0466b0</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="kms_02_0028__en-us_topic_0112992333_row143985550598"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.2.5.1.1 "><p id="kms_02_0028__en-us_topic_0112992333_p83991455105914">grantee_principal_type</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.5.1.2 "><p id="kms_02_0028__en-us_topic_0112992333_p039985520593">No</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.2.5.1.3 "><p id="kms_02_0028__en-us_topic_0112992333_p139905525911">String</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.2.5.1.4 "><p id="kms_02_0028__en-us_topic_0112992333_p83991055195915">Authorization type</p>
|
||||
<p id="kms_02_0028__en-us_topic_0112992333_p5157725907">Values: <span class="parmvalue" id="kms_02_0028__en-us_topic_0112992333_parmvalue106019481808"><b>user</b></span>, <span class="parmvalue" id="kms_02_0028__en-us_topic_0112992333_parmvalue152665511503"><b>domain</b></span>. The default value is <strong id="kms_02_0028__en-us_topic_0112992333_b749044561411">user</strong>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="kms_02_0028__en-us_topic_0112992333_row4011877155238"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.2.5.1.1 "><p id="kms_02_0028__en-us_topic_0112992333_p906222915530">sequence</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.5.1.2 "><p id="kms_02_0028__en-us_topic_0112992333_p6594517215530">No</p>
|
||||
@ -107,9 +117,9 @@
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="kms_02_0028__en-us_topic_0112992333_section35819930154934"><h4 class="sectiontitle">Responses</h4>
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0028__en-us_topic_0112992333_table66429519154934" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameters</caption><thead align="left"><tr id="kms_02_0028__en-us_topic_0112992333_row58318988154934"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.4.2.2.5.1.1"><p id="kms_02_0028__en-us_topic_0112992333_p1832914587446"><strong id="kms_02_0028__en-us_topic_0112992333_b2038708189">Parameter</strong></p>
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0028__en-us_topic_0112992333_table66429519154934" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameters</caption><thead align="left"><tr id="kms_02_0028__en-us_topic_0112992333_row58318988154934"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.4.2.2.5.1.1"><p id="kms_02_0028__en-us_topic_0112992333_p1832914587446"><strong id="kms_02_0028__en-us_topic_0112992333_b225175057">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_0028__en-us_topic_0112992333_p932911586447"><strong id="kms_02_0028__en-us_topic_0112992333_b429671217">Mandatory</strong></p>
|
||||
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.4.2.2.5.1.2"><p id="kms_02_0028__en-us_topic_0112992333_p932911586447"><strong id="kms_02_0028__en-us_topic_0112992333_b1830984169">Mandatory</strong></p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.4.2.2.5.1.3"><p id="kms_02_0028__en-us_topic_0112992333_p9329155814416">Type</p>
|
||||
</th>
|
||||
@ -179,7 +189,7 @@
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0010.html">APIs</a></div>
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0011.html">CMK Management</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
@ -119,7 +119,7 @@
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0010.html">APIs</a></div>
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0011.html">CMK Management</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
@ -121,7 +121,7 @@
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0010.html">APIs</a></div>
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0011.html">CMK Management</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
@ -286,7 +286,7 @@
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0010.html">APIs</a></div>
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0011.html">CMK Management</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
@ -182,7 +182,7 @@
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0010.html">APIs</a></div>
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0011.html">CMK Management</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
169
docs/kms/api-ref/kms_02_0033.html
Normal file
169
docs/kms/api-ref/kms_02_0033.html
Normal file
File diff suppressed because it is too large
Load Diff
157
docs/kms/api-ref/kms_02_0034.html
Normal file
157
docs/kms/api-ref/kms_02_0034.html
Normal file
File diff suppressed because it is too large
Load Diff
@ -32,7 +32,7 @@
|
||||
</li></ul>
|
||||
</div>
|
||||
<div class="section" id="kms_02_0035__en-us_topic_0112992295_section4812685216511"><h4 class="sectiontitle">Requests</h4>
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0035__en-us_topic_0112992295_table1307199216511" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="kms_02_0035__en-us_topic_0112992295_row2216064416511"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.3.2.2.5.1.1"><p id="kms_02_0035__en-us_topic_0112992295_p14691165413488"><strong id="kms_02_0035__en-us_topic_0112992295_b731092329">Parameter</strong></p>
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0035__en-us_topic_0112992295_table1307199216511" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="kms_02_0035__en-us_topic_0112992295_row2216064416511"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.3.2.2.5.1.1"><p id="kms_02_0035__en-us_topic_0112992295_p14691165413488"><strong id="kms_02_0035__en-us_topic_0112992295_b211511491">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_0035__en-us_topic_0112992295_p969155484813">Mandatory</p>
|
||||
</th>
|
||||
@ -58,7 +58,7 @@
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.2.5.1.3 "><p id="kms_02_0035__en-us_topic_0112992295_p48301302716">String</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.2.5.1.4 "><div class="p" id="kms_02_0035__en-us_topic_0112992295_p5501165794712">Encryption algorithm for CMK material. The following values are enumerated:<ul id="kms_02_0035__en-us_topic_0112992295_ul2802984616441"><li id="kms_02_0035__en-us_topic_0112992295_li17794932202025">RSAES_PKCS1_V1_5</li><li id="kms_02_0035__en-us_topic_0112992295_li249656894719">RSAES_OAEP_SHA_1</li><li id="kms_02_0035__en-us_topic_0112992295_li1096334994738">RSAES_OAEP_SHA_256</li></ul>
|
||||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.2.5.1.4 "><div class="p" id="kms_02_0035__en-us_topic_0112992295_p5501165794712">Cryptographic algorithm for CMK material. The following values are enumerated:<ul id="kms_02_0035__en-us_topic_0112992295_ul2802984616441"><li id="kms_02_0035__en-us_topic_0112992295_li17794932202025">RSAES_PKCS1_V1_5</li><li id="kms_02_0035__en-us_topic_0112992295_li249656894719">RSAES_OAEP_SHA_1</li><li id="kms_02_0035__en-us_topic_0112992295_li1096334994738">RSAES_OAEP_SHA_256</li></ul>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
@ -77,7 +77,7 @@
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="kms_02_0035__en-us_topic_0112992295_section5661868116511"><h4 class="sectiontitle">Responses</h4>
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0035__en-us_topic_0112992295_table2760760616511" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameters</caption><thead align="left"><tr id="kms_02_0035__en-us_topic_0112992295_row4144383516511"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.4.2.2.5.1.1"><p id="kms_02_0035__en-us_topic_0112992295_p654882104911"><strong id="kms_02_0035__en-us_topic_0112992295_b2018050679">Parameter</strong></p>
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0035__en-us_topic_0112992295_table2760760616511" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameters</caption><thead align="left"><tr id="kms_02_0035__en-us_topic_0112992295_row4144383516511"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.4.2.2.5.1.1"><p id="kms_02_0035__en-us_topic_0112992295_p654882104911"><strong id="kms_02_0035__en-us_topic_0112992295_b1425832639">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_0035__en-us_topic_0112992295_p185481428495">Mandatory</p>
|
||||
</th>
|
||||
@ -127,7 +127,7 @@
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="kms_02_0035__en-us_topic_0112992295_section11823115617213"><h4 class="sectiontitle">Examples</h4><p id="kms_02_0035__en-us_topic_0112992295_p422561613226">The following example describes how to obtain the imported parameter of a CMK (ID: <span class="parmvalue" id="kms_02_0035__en-us_topic_0112992295_parmvalue725239968195423"><b>bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e</b></span>; encryption algorithm: <span class="parmvalue" id="kms_02_0035__en-us_topic_0112992295_parmvalue495161817195455"><b>RSAES_OAEP_SHA_1</b></span>).</p>
|
||||
<div class="section" id="kms_02_0035__en-us_topic_0112992295_section11823115617213"><h4 class="sectiontitle">Examples</h4><p id="kms_02_0035__en-us_topic_0112992295_p422561613226">The following example describes how to obtain the imported parameter of a CMK (ID: <span class="parmvalue" id="kms_02_0035__en-us_topic_0112992295_parmvalue725239968195423"><b>bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e</b></span>; algorithm: <span class="parmvalue" id="kms_02_0035__en-us_topic_0112992295_parmvalue495161817195455"><b>RSAES_OAEP_SHA_1</b></span>).</p>
|
||||
<ul id="kms_02_0035__en-us_topic_0112992295_ul685317563210"><li id="kms_02_0035__en-us_topic_0112992295_li0853135652112">Example request<pre class="screen" id="kms_02_0035__en-us_topic_0112992295_screen13853195642115">{
|
||||
"key_id": "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e",
|
||||
"wrapping_algorithm":"RSAES_OAEP_SHA_1"
|
||||
@ -172,7 +172,7 @@
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0010.html">APIs</a></div>
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0011.html">CMK Management</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
@ -137,7 +137,7 @@
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0010.html">APIs</a></div>
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0011.html">CMK Management</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
@ -103,7 +103,7 @@
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0010.html">APIs</a></div>
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0011.html">CMK Management</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
@ -108,7 +108,7 @@
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0010.html">APIs</a></div>
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0011.html">CMK Management</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
@ -117,7 +117,7 @@
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0010.html">APIs</a></div>
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0011.html">CMK Management</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
@ -106,7 +106,7 @@
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0010.html">APIs</a></div>
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0011.html">CMK Management</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
@ -159,7 +159,7 @@
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0010.html">APIs</a></div>
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0011.html">CMK Management</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
@ -291,7 +291,7 @@
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0010.html">APIs</a></div>
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0011.html">CMK Management</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
@ -124,7 +124,7 @@
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0010.html">APIs</a></div>
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0011.html">CMK Management</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
@ -109,7 +109,7 @@
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0010.html">APIs</a></div>
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0011.html">CMK Management</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
@ -151,7 +151,7 @@
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0010.html">APIs</a></div>
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0011.html">CMK Management</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
@ -153,7 +153,7 @@
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0010.html">APIs</a></div>
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0011.html">CMK Management</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
@ -111,7 +111,7 @@
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0010.html">APIs</a></div>
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0011.html">CMK Management</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
@ -190,7 +190,7 @@
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0010.html">APIs</a></div>
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0011.html">CMK Management</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
@ -210,7 +210,7 @@
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0010.html">APIs</a></div>
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0011.html">CMK Management</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user