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>
261 lines
10 KiB
HTML
261 lines
10 KiB
HTML
<a name="ShowGroup"></a><a name="ShowGroup"></a>
|
|
|
|
<h1 class="topictitle1">Querying a Consumer Group</h1>
|
|
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query details about a specified consumer group.</p>
|
|
</div>
|
|
<div class="section" id="ShowGroup__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/instances/{instance_id}/groups/{group}</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>
|
|
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p>instance_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>Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.</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="20%" headers="mcps1.3.2.3.2.5.1.1 "><p>group</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>Consumer group name.</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">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="ShowGroup__response_showConsumerGroup" frame="border" border="1" rules="all"><caption><b>Table 2 </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>enabled</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
|
<p>Whether consumption is allowed.</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>N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>broadcast</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
|
<p>Whether to enable broadcast.</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>N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
|
<p>Consumer group name.</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.3.2.4.1.1 "><p>group_desc</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
|
<p>Consumer group description.</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.3.2.4.1.1 "><p>created_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
|
<p>Creation time.</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.3.2.4.1.1 "><p>retry_max_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
|
<p>Maximum number of retries.</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.3.2.4.1.1 "><p>permissions</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
|
<p>Permission.</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.3.2.4.1.1 "><p>consume_orderly</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
|
<p>Whether to enable orderly consumption.</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>N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>group_online</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
|
<p>Whether a consumer group is online.</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>N/A</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Example Requests</h4><p>Querying details about a specified consumer group</p>
|
|
<pre class="screen">GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/groups/{group}</pre>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Example Responses</h4><p><strong>Status code: 200</strong></p>
|
|
<p>Consumer group queried successfully.</p>
|
|
<pre class="screen">{
|
|
"name" : "test",
|
|
"group_desc" : "group_description",
|
|
"enabled" : true,
|
|
"broadcast" : true,
|
|
"permissions" : [ ],
|
|
"retry_max_time" : 10,
|
|
"consume_orderly" : false,
|
|
"created_at" : 1768549443385
|
|
}</pre>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowGroup__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>Consumer group queried successfully.</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_300000001.html">Consumer Group Management</a></div>
|
|
</div>
|
|
</div>
|
|
|