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>
102 lines
9.0 KiB
HTML
102 lines
9.0 KiB
HTML
<a name="kms_02_0024"></a><a name="kms_02_0024"></a>
|
|
|
|
<h1 class="topictitle1">Querying the Number of Instances</h1>
|
|
<div id="body1486350531509"><div class="section" id="kms_02_0024__en-us_topic_0112992320_section27849192112353"><h4 class="sectiontitle">Function</h4><p id="kms_02_0024__en-us_topic_0112992320_p45386342112449">This API is used to query the number of instances, that is, the number of CMKs created.</p>
|
|
<div class="note" id="kms_02_0024__en-us_topic_0112992320_note5633572415214"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="kms_02_0024__en-us_topic_0112992320_p3725947115214">Default Master Keys are automatically created by services and are not included in this query.</p>
|
|
</div></div>
|
|
</div>
|
|
<div class="section" id="kms_02_0024__en-us_topic_0112992320_section35184599112353"><h4 class="sectiontitle">URI</h4><ul id="kms_02_0024__en-us_topic_0112992320_ul31380276112353"><li id="kms_02_0024__en-us_topic_0112992320_li13987034112353">URI format<p id="kms_02_0024__en-us_topic_0112992320_p58774446112353"><a name="kms_02_0024__en-us_topic_0112992320_li13987034112353"></a><a name="en-us_topic_0112992320_li13987034112353"></a>GET /v1.0/{project_id}/kms/user-instances</p>
|
|
</li><li id="kms_02_0024__en-us_topic_0112992320_li59207969112353">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0024__en-us_topic_0112992320_table63109676112353" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="kms_02_0024__en-us_topic_0112992320_row49827042112353"><th align="left" class="cellrowborder" valign="top" width="22.74%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="kms_02_0024__en-us_topic_0112992320_p9458563112353"><strong id="kms_02_0024__en-us_topic_0112992320_b842352706185937">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.919999999999998%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="kms_02_0024__en-us_topic_0112992320_p27946133112353"><strong id="kms_02_0024__en-us_topic_0112992320_b842352706185940">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.55%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="kms_02_0024__en-us_topic_0112992320_p49044287112353">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40.79%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="kms_02_0024__en-us_topic_0112992320_p13164330112353">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="kms_02_0024__en-us_topic_0112992320_row59677822112353"><td class="cellrowborder" valign="top" width="22.74%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="kms_02_0024__en-us_topic_0112992320_p2065377112353">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.919999999999998%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="kms_02_0024__en-us_topic_0112992320_p33077886112353">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.55%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="kms_02_0024__en-us_topic_0112992320_p62063099112353">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.79%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="kms_02_0024__en-us_topic_0112992320_p61055104112353">Project ID</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="kms_02_0024__en-us_topic_0112992320_section12625030112353"><h4 class="sectiontitle">Requests</h4><p id="kms_02_0024__en-us_topic_0112992320_p2857052711259">None</p>
|
|
</div>
|
|
<div class="section" id="kms_02_0024__en-us_topic_0112992320_section15686020"><h4 class="sectiontitle">Responses</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0024__en-us_topic_0112992320_table5856932152840" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="kms_02_0024__en-us_topic_0112992320_row5206426152840"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.4.2.2.5.1.1"><p id="kms_02_0024__en-us_topic_0112992320_p19067323152840"><strong id="kms_02_0024__en-us_topic_0112992320_b8423527061909">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_0024__en-us_topic_0112992320_p9786487152840"><strong id="kms_02_0024__en-us_topic_0112992320_b84235270619014">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_0024__en-us_topic_0112992320_p949325152840"><strong id="kms_02_0024__en-us_topic_0112992320_b84235270619012">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.2.2.5.1.4"><p id="kms_02_0024__en-us_topic_0112992320_p54508002152840">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="kms_02_0024__en-us_topic_0112992320_row25652894105355"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.2.5.1.1 "><p id="kms_02_0024__en-us_topic_0112992320_p9370319112738">instance_num</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.2.2.5.1.2 "><p id="kms_02_0024__en-us_topic_0112992320_p6949493112738">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.2.5.1.3 "><p id="kms_02_0024__en-us_topic_0112992320_p20798408112738">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.5.1.4 "><p id="kms_02_0024__en-us_topic_0112992320_p26038079112738">Number of non-default CMKs</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="kms_02_0024__en-us_topic_0112992320_section12491816289"><h4 class="sectiontitle">Examples</h4><ul id="kms_02_0024__en-us_topic_0112992320_ul934072823912"><li id="kms_02_0024__en-us_topic_0112992320_li17340112843916">Example request<p id="kms_02_0024__en-us_topic_0112992320_p264143023912"><a name="kms_02_0024__en-us_topic_0112992320_li17340112843916"></a><a name="en-us_topic_0112992320_li17340112843916"></a>None</p>
|
|
</li><li id="kms_02_0024__en-us_topic_0112992320_li173401128173918">Example response<pre class="screen" id="kms_02_0024__en-us_topic_0112992320_screen62600162818">{
|
|
"instance_num": 15
|
|
}</pre>
|
|
<p id="kms_02_0024__en-us_topic_0112992320_p132609182811">or</p>
|
|
<pre class="screen" id="kms_02_0024__en-us_topic_0112992320_screen22601115284">{
|
|
"error": {
|
|
"error_code": "KMS.XXXX",
|
|
"error_msg": "XXX"
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="kms_02_0024__en-us_topic_0112992320_section3454223421"><h4 class="sectiontitle">Status Codes</h4><div class="p" id="kms_02_0024__en-us_topic_0112992320_en-us_topic_0112992294_en-us_topic_0079615001_p17772351"><a href="#kms_02_0024__en-us_topic_0112992320_en-us_topic_0112992294_en-us_topic_0079615001_table20596071">Table 3</a> lists the normal status code returned by the response.
|
|
<div class="tablenoborder"><a name="kms_02_0024__en-us_topic_0112992320_en-us_topic_0112992294_en-us_topic_0079615001_table20596071"></a><a name="en-us_topic_0112992320_en-us_topic_0112992294_en-us_topic_0079615001_table20596071"></a><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0024__en-us_topic_0112992320_en-us_topic_0112992294_en-us_topic_0079615001_table20596071" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Status codes</caption><thead align="left"><tr id="kms_02_0024__en-us_topic_0112992320_en-us_topic_0112992294_en-us_topic_0079615001_row9746163"><th align="left" class="cellrowborder" valign="top" width="16.16%" id="mcps1.3.6.2.2.2.4.1.1"><p id="kms_02_0024__en-us_topic_0112992320_en-us_topic_0112992294_p57545694203043">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="28.28%" id="mcps1.3.6.2.2.2.4.1.2"><p id="kms_02_0024__en-us_topic_0112992320_en-us_topic_0112992294_p4531342288">Status</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="55.559999999999995%" id="mcps1.3.6.2.2.2.4.1.3"><p id="kms_02_0024__en-us_topic_0112992320_en-us_topic_0112992294_p30689603203043">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="kms_02_0024__en-us_topic_0112992320_en-us_topic_0112992294_en-us_topic_0079615001_row48621261"><td class="cellrowborder" valign="top" width="16.16%" headers="mcps1.3.6.2.2.2.4.1.1 "><p id="kms_02_0024__en-us_topic_0112992320_en-us_topic_0112992294_en-us_topic_0079615001_p46008046">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.28%" headers="mcps1.3.6.2.2.2.4.1.2 "><p id="kms_02_0024__en-us_topic_0112992320_en-us_topic_0112992294_p7538425819">OK</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.6.2.2.2.4.1.3 "><p id="kms_02_0024__en-us_topic_0112992320_en-us_topic_0112992294_p1885682315512">Request processed successfully.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<p id="kms_02_0024__en-us_topic_0112992320_en-us_topic_0112992294_p5626181018551">Exception status code. For details, see <a href="kms_02_0301.html#kms_02_0301">Status Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0011.html">CMK Management</a></div>
|
|
</div>
|
|
</div>
|
|
|