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>
182 lines
15 KiB
HTML
182 lines
15 KiB
HTML
<a name="kms_02_0025"></a><a name="kms_02_0025"></a>
|
|
|
|
<h1 class="topictitle1">Querying the Quota of a User</h1>
|
|
<div id="body1486351357038"><div class="section" id="kms_02_0025__en-us_topic_0112992292_section27849192112353"><h4 class="sectiontitle">Function</h4><p id="kms_02_0025__en-us_topic_0112992292_p45386342112449">This API is used to query the quota of a user, that is, the allocated total number of CMKs that can be created by a user and the number of CMKs that has been created by the user.</p>
|
|
<div class="note" id="kms_02_0025__en-us_topic_0112992292_note5633572415214"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="kms_02_0025__en-us_topic_0112992292_p3725947115214">The quota does not include Default Master Keys.</p>
|
|
</div></div>
|
|
</div>
|
|
<div class="section" id="kms_02_0025__en-us_topic_0112992292_section35184599112353"><h4 class="sectiontitle">URI</h4><ul id="kms_02_0025__en-us_topic_0112992292_ul31380276112353"><li id="kms_02_0025__en-us_topic_0112992292_li13987034112353">URI format<p id="kms_02_0025__en-us_topic_0112992292_p58774446112353"><a name="kms_02_0025__en-us_topic_0112992292_li13987034112353"></a><a name="en-us_topic_0112992292_li13987034112353"></a>GET /v1.0/{project_id}/kms/user-quotas</p>
|
|
</li><li id="kms_02_0025__en-us_topic_0112992292_li59207969112353">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0025__en-us_topic_0112992292_table63109676112353" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="kms_02_0025__en-us_topic_0112992292_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_0025__en-us_topic_0112992292_p9458563112353"><strong id="kms_02_0025__en-us_topic_0112992292_b8423527061924">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_0025__en-us_topic_0112992292_p27946133112353"><strong id="kms_02_0025__en-us_topic_0112992292_b84235270619210">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_0025__en-us_topic_0112992292_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_0025__en-us_topic_0112992292_p13164330112353">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="kms_02_0025__en-us_topic_0112992292_row59677822112353"><td class="cellrowborder" valign="top" width="22.74%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="kms_02_0025__en-us_topic_0112992292_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_0025__en-us_topic_0112992292_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_0025__en-us_topic_0112992292_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_0025__en-us_topic_0112992292_p61055104112353">Project ID</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="kms_02_0025__en-us_topic_0112992292_section12625030112353"><h4 class="sectiontitle">Requests</h4><p id="kms_02_0025__en-us_topic_0112992292_p2857052711259">None</p>
|
|
</div>
|
|
<div class="section" id="kms_02_0025__en-us_topic_0112992292_section15686020"><h4 class="sectiontitle">Responses</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0025__en-us_topic_0112992292_table57089888113143" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="kms_02_0025__en-us_topic_0112992292_row44406426113143"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.4.2.2.5.1.1"><p id="kms_02_0025__en-us_topic_0112992292_p40150733113143"><strong id="kms_02_0025__en-us_topic_0112992292_b84235270619232">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_0025__en-us_topic_0112992292_p26668948113143"><strong id="kms_02_0025__en-us_topic_0112992292_b84235270619240">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_0025__en-us_topic_0112992292_p30983912113143"><strong id="kms_02_0025__en-us_topic_0112992292_b84235270619236">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_0025__en-us_topic_0112992292_p12701176113143">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="kms_02_0025__en-us_topic_0112992292_row22162365113143"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.2.5.1.1 "><p id="kms_02_0025__en-us_topic_0112992292_p50321163113143">quotas</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.2.2.5.1.2 "><p id="kms_02_0025__en-us_topic_0112992292_p48649567113143">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.2.5.1.3 "><p id="kms_02_0025__en-us_topic_0112992292_p49482377113143">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.5.1.4 "><p id="kms_02_0025__en-us_topic_0112992292_p48300854113143">Quota list. For details, see <a href="#kms_02_0025__en-us_topic_0112992292_table91213810301">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="kms_02_0025__en-us_topic_0112992292_table91213810301"></a><a name="en-us_topic_0112992292_table91213810301"></a><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0025__en-us_topic_0112992292_table91213810301" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong>quotas</strong> field description</caption><thead align="left"><tr id="kms_02_0025__en-us_topic_0112992292_row1812219893014"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.4.3.2.5.1.1"><p id="kms_02_0025__en-us_topic_0112992292_p270818432314"><strong id="kms_02_0025__en-us_topic_0112992292_b281886544">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.4.3.2.5.1.2"><p id="kms_02_0025__en-us_topic_0112992292_p0708144373116"><strong id="kms_02_0025__en-us_topic_0112992292_b346734555">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.4.3.2.5.1.3"><p id="kms_02_0025__en-us_topic_0112992292_p37081843133115">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.5.1.4"><p id="kms_02_0025__en-us_topic_0112992292_p10708204343110">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="kms_02_0025__en-us_topic_0112992292_row1212288203011"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.1 "><p id="kms_02_0025__en-us_topic_0112992292_p158526571311">resources</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.3.2.5.1.2 "><p id="kms_02_0025__en-us_topic_0112992292_p385275711314">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.3 "><p id="kms_02_0025__en-us_topic_0112992292_p1852105712316">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.5.1.4 "><p id="kms_02_0025__en-us_topic_0112992292_p188521457103115">Resource quota list. For details, see <a href="#kms_02_0025__en-us_topic_0112992292_table167809412315">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="kms_02_0025__en-us_topic_0112992292_table167809412315"></a><a name="en-us_topic_0112992292_table167809412315"></a><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0025__en-us_topic_0112992292_table167809412315" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong>resources</strong> field description</caption><thead align="left"><tr id="kms_02_0025__en-us_topic_0112992292_row1278094143119"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.4.4.2.5.1.1"><p id="kms_02_0025__en-us_topic_0112992292_p9231545143120"><strong id="kms_02_0025__en-us_topic_0112992292_b2139338772">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.4.4.2.5.1.2"><p id="kms_02_0025__en-us_topic_0112992292_p1523245183111"><strong id="kms_02_0025__en-us_topic_0112992292_b1554045716">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.4.4.2.5.1.3"><p id="kms_02_0025__en-us_topic_0112992292_p1823545193118">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.4.2.5.1.4"><p id="kms_02_0025__en-us_topic_0112992292_p19231145193119">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="kms_02_0025__en-us_topic_0112992292_row10780154133117"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.4.2.5.1.1 "><p id="kms_02_0025__en-us_topic_0112992292_p04621010163215">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.4.2.5.1.2 "><p id="kms_02_0025__en-us_topic_0112992292_p1462181053214">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.4.2.5.1.3 "><p id="kms_02_0025__en-us_topic_0112992292_p746261063219">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.5.1.4 "><p id="kms_02_0025__en-us_topic_0112992292_p16462210163219">Quota type.</p>
|
|
<p id="kms_02_0025__en-us_topic_0112992292_p1246201014323">Enumerated values:</p>
|
|
<ul id="kms_02_0025__en-us_topic_0112992292_ul446210103324"><li id="kms_02_0025__en-us_topic_0112992292_li16463121018328"><strong id="kms_02_0025__en-us_topic_0112992292_b775316212144618">CMK</strong> indicates a Customer Master Key.</li><li id="kms_02_0025__en-us_topic_0112992292_li8463810183216"><strong id="kms_02_0025__en-us_topic_0112992292_b84235270614475">grant_per_CMK</strong> indicates the number of grants that can be created on a CMK.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0025__en-us_topic_0112992292_row1978119418318"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.4.2.5.1.1 "><p id="kms_02_0025__en-us_topic_0112992292_p2463201083213">used</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.4.2.5.1.2 "><p id="kms_02_0025__en-us_topic_0112992292_p1446331012321">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.4.2.5.1.3 "><p id="kms_02_0025__en-us_topic_0112992292_p11463181019323">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.5.1.4 "><p id="kms_02_0025__en-us_topic_0112992292_p1046331043211">Used quota</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0025__en-us_topic_0112992292_row978111473112"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.4.2.5.1.1 "><p id="kms_02_0025__en-us_topic_0112992292_p15463210143211">quota</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.4.2.5.1.2 "><p id="kms_02_0025__en-us_topic_0112992292_p114631210113216">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.4.2.5.1.3 "><p id="kms_02_0025__en-us_topic_0112992292_p10463131063212">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.5.1.4 "><p id="kms_02_0025__en-us_topic_0112992292_p1146351023210">Total quota</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="kms_02_0025__en-us_topic_0112992292_section169469372415"><h4 class="sectiontitle">Examples</h4><ul id="kms_02_0025__en-us_topic_0112992292_ul39781737114117"><li id="kms_02_0025__en-us_topic_0112992292_li8401433164210">Example request<p id="kms_02_0025__en-us_topic_0112992292_p154759388424"><a name="kms_02_0025__en-us_topic_0112992292_li8401433164210"></a><a name="en-us_topic_0112992292_li8401433164210"></a>None</p>
|
|
</li><li id="kms_02_0025__en-us_topic_0112992292_li797863794118">Example response<pre class="screen" id="kms_02_0025__en-us_topic_0112992292_screen10978837114110">{
|
|
"quotas": {
|
|
"resources": [
|
|
{
|
|
"type": "CMK",
|
|
"used": 15,
|
|
"quota": 20
|
|
},
|
|
{
|
|
"type": "grant_per_CMK",
|
|
"used": 15,
|
|
"quota": 100
|
|
}
|
|
|
|
]
|
|
}
|
|
}</pre>
|
|
<p id="kms_02_0025__en-us_topic_0112992292_p19781437124110">or</p>
|
|
<pre class="screen" id="kms_02_0025__en-us_topic_0112992292_screen149781637124111">{
|
|
"error": {
|
|
"error_code": "KMS.XXXX",
|
|
"error_msg": "XXX"
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="kms_02_0025__en-us_topic_0112992292_section3454223421"><h4 class="sectiontitle">Status Codes</h4><div class="p" id="kms_02_0025__en-us_topic_0112992292_en-us_topic_0112992294_en-us_topic_0079615001_p17772351"><a href="#kms_02_0025__en-us_topic_0112992292_en-us_topic_0112992294_en-us_topic_0079615001_table20596071">Table 5</a> lists the normal status code returned by the response.
|
|
<div class="tablenoborder"><a name="kms_02_0025__en-us_topic_0112992292_en-us_topic_0112992294_en-us_topic_0079615001_table20596071"></a><a name="en-us_topic_0112992292_en-us_topic_0112992294_en-us_topic_0079615001_table20596071"></a><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0025__en-us_topic_0112992292_en-us_topic_0112992294_en-us_topic_0079615001_table20596071" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Status codes</caption><thead align="left"><tr id="kms_02_0025__en-us_topic_0112992292_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_0025__en-us_topic_0112992292_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_0025__en-us_topic_0112992292_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_0025__en-us_topic_0112992292_en-us_topic_0112992294_p30689603203043">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="kms_02_0025__en-us_topic_0112992292_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_0025__en-us_topic_0112992292_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_0025__en-us_topic_0112992292_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_0025__en-us_topic_0112992292_en-us_topic_0112992294_p1885682315512">Request processed successfully.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<p id="kms_02_0025__en-us_topic_0112992292_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>
|
|
|