forked from docs/doc-exports
chenjunjie
719d8b18de
Reviewed-by: Ziuzko, Stanislav <stanislav.ziuzko@t-systems.com> Co-authored-by: chenjunjie <chenjunjie@huawei.com> Co-committed-by: chenjunjie <chenjunjie@huawei.com>
242 lines
11 KiB
HTML
242 lines
11 KiB
HTML
<a name="ShowQuotas"></a><a name="ShowQuotas"></a>
|
|
|
|
<h1 class="topictitle1">Querying Tenant Quotas</h1>
|
|
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query the maximum number of instances that a tenant can create, the number of created instances, and the maximum number of tags that can be created for each instance.</p>
|
|
</div>
|
|
<div class="section" id="ShowQuotas__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/quotas</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p>Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p>Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p>Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p>Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p>project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p>Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p><strong>Definition</strong></p>
|
|
<p>Project ID. For details about how to obtain it, see <a href="hrm-api-0011.html">Obtaining a Project ID</a>.</p>
|
|
<p><strong>Constraints</strong></p>
|
|
<p>N/A</p>
|
|
<p><strong>Range</strong></p>
|
|
<p>N/A</p>
|
|
<p><strong>Default Value</strong></p>
|
|
<p>N/A</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p>Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p>Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p>Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p>Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p>includeTagsQuota</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p>No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p><strong>Definition</strong></p>
|
|
<p>Whether a tag quota flag is included.</p>
|
|
<p><strong>Constraints</strong></p>
|
|
<p>N/A</p>
|
|
<p><strong>Range</strong></p>
|
|
<ul><li><p><strong>true</strong>: Yes</p>
|
|
</li><li><p><strong>false</strong>: No</p>
|
|
</li></ul>
|
|
<p><strong>Default Value</strong></p>
|
|
<p>true</p>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p>onlyQuota</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p>No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p><strong>Definition</strong></p>
|
|
<p>Queries a specified quota engine.</p>
|
|
<p><strong>Constraints</strong></p>
|
|
<p>N/A</p>
|
|
<p><strong>Range</strong></p>
|
|
<ul><li><p><strong>reliability</strong>: RocketMQ message engine alias.</p>
|
|
</li><li><p><strong>kafka</strong>: Kafka message engine alias.</p>
|
|
</li></ul>
|
|
<p><strong>Default Value</strong></p>
|
|
<p>N/A</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Request Parameters</h4><p>None</p>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Response Parameters</h4><p><strong>Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowQuotas__response_QuotasResp" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.1"><p>Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.2"><p>Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.4.1.3"><p>Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>quotas</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p><a href="#ShowQuotas__response_quotas">quotas</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
|
<p>Quota information.</p>
|
|
<p><strong>Constraints</strong></p>
|
|
<p>N/A</p>
|
|
<p><strong>Range</strong></p>
|
|
<p>N/A</p>
|
|
<p><strong>Default Value</strong></p>
|
|
<p>N/A</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="ShowQuotas__response_quotas"></a><a name="response_quotas"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowQuotas__response_quotas" frame="border" border="1" rules="all"><caption><b>Table 4 </b>quotas</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.1"><p>Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.2"><p>Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.4.2.4.1.3"><p>Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p>resources</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p>Array of <a href="#ShowQuotas__response_QuotaResourceEntity">QuotaResourceEntity</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p><strong>Definition</strong></p>
|
|
<p>Quota list.</p>
|
|
<p><strong>Constraints</strong></p>
|
|
<p>N/A</p>
|
|
<p><strong>Range</strong></p>
|
|
<p>N/A</p>
|
|
<p><strong>Default Value</strong></p>
|
|
<p>N/A</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="ShowQuotas__response_QuotaResourceEntity"></a><a name="response_QuotaResourceEntity"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowQuotas__response_QuotaResourceEntity" frame="border" border="1" rules="all"><caption><b>Table 5 </b>QuotaResourceEntity</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.1"><p>Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.2"><p>Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.5.2.4.1.3"><p>Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p>type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p><strong>Definition</strong></p>
|
|
<p>Supports kafkaInstance, rocketmqInstance, and tags.</p>
|
|
<ul><li><p><strong>kafkaInstance</strong>: Kafka instance quotas</p>
|
|
</li><li><p><strong>rocketmqInstance</strong>: RocketMQ instance quotas</p>
|
|
</li><li><p><strong>tags</strong>: Tag quotas</p>
|
|
</li><li><p><strong>kafkaInstancePublic</strong>: Kafka public network quotas (deprecated).</p>
|
|
</li></ul>
|
|
<p><strong>Constraints</strong></p>
|
|
<p>N/A</p>
|
|
<p><strong>Range</strong></p>
|
|
<p>N/A</p>
|
|
<p><strong>Default Value</strong></p>
|
|
<p>N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p>quota</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p>Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p><strong>Definition</strong></p>
|
|
<p>The maximum number of instances that a tenant can create, or the maximum number of tags that can be created for each instance.</p>
|
|
<p><strong>Constraints</strong></p>
|
|
<p>N/A</p>
|
|
<p><strong>Range</strong></p>
|
|
<p>N/A</p>
|
|
<p><strong>Default Value</strong></p>
|
|
<p>N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p>used</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p>Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p><strong>Definition</strong></p>
|
|
<p>Number of created instances.</p>
|
|
<p><strong>Constraints</strong></p>
|
|
<p>N/A</p>
|
|
<p><strong>Range</strong></p>
|
|
<p>N/A</p>
|
|
<p><strong>Default Value</strong></p>
|
|
<p>N/A</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Example Requests</h4><pre class="screen">GET https://{endpoint}/v2/{project_id}/quotas?includeTagsQuota=false&onlyQuota=reliability</pre>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Example Responses</h4><p><strong>Status code: 200</strong></p>
|
|
<p>Successful</p>
|
|
<pre class="screen">{
|
|
"quotas" : {
|
|
"resources" : [ {
|
|
"type" : "rocketmqInstance",
|
|
"quota" : 100,
|
|
"used" : 17
|
|
} ]
|
|
}
|
|
}</pre>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowQuotas__status_code" frame="border" border="1" rules="all"><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p>Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p>Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p>200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p>Successful</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Error Codes</h4><p>See <a href="ErrorCode.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000007.html">Other APIs</a></div>
|
|
</div>
|
|
</div>
|
|
|