yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
719d8b18deddea0cfce1cc197a49d2a2b6db8c71
doc-exports/docs/dms_rocketmq/api-ref/ShowOneTopic.html
chenjunjie 719d8b18de RocketMQ API 20250723 version 
Reviewed-by: Ziuzko, Stanislav <stanislav.ziuzko@t-systems.com>
Co-authored-by: chenjunjie <chenjunjie@huawei.com>
Co-committed-by: chenjunjie <chenjunjie@huawei.com>
2026-03-18 20:25:09 +00:00

267 lines
11 KiB
HTML
Raw Blame History

<a name="ShowOneTopic"></a><a name="ShowOneTopic"></a>
<h1 class="topictitle1">Querying a Topic</h1>
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query a topic.</p>
</div>
<div class="section" id="ShowOneTopic__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/instances/{instance_id}/topics/{topic}</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>topic</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>Topic name.</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="ShowOneTopic__response_Topic" 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>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>Topic 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>total_read_queue_num</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>Number</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
<p>Total number of read queues.</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>total_write_queue_num</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>Number</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
<p>Total number of write queues.</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>permission</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>Permission.</p>
<p><strong>Constraints</strong></p>
<p>N/A</p>
<p><strong>Range</strong></p>
<ul><li><p><strong>sub</strong>: subscribe permissions.</p>
</li><li><p><strong>pub</strong>: publish permissions.</p>
</li><li><p><strong>all</strong>: subscribe and publish permissions.</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>brokers</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>Array of <a href="#ShowOneTopic__response_brokers">brokers</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
<p>Associated broker.</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>message_type</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>Message type (available only for RocketMQ 5.x instances).</p>
<p><strong>Constraints</strong></p>
<p>N/A</p>
<p><strong>Range</strong></p>
<ul><li><p><strong>NORMAL</strong>: normal messages.</p>
</li><li><p><strong>FIFO</strong>: ordered messages.</p>
</li><li><p><strong>DELAY</strong>: scheduled messages.</p>
</li><li><p><strong>TRANSACTION</strong>: transactional messages.</p>
</li></ul>
<p><strong>Default Value</strong></p>
<p>N/A</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ShowOneTopic__response_brokers"></a><a name="response_brokers"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowOneTopic__response_brokers" frame="border" border="1" rules="all"><caption><b>Table 3 </b>brokers</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>broker_name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p><strong>Definition</strong></p>
<p>Broker 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.4.2.4.1.1 "><p>read_queue_num</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p>Number</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p><strong>Definition</strong></p>
<p>Number of read queues.</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.4.2.4.1.1 "><p>write_queue_num</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p>Number</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p><strong>Definition</strong></p>
<p>Number of write queues.</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><p>Querying details about a specified topic</p>
<pre class="screen">GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/topics/{topic}</pre>
</div>
<div class="section"><h4 class="sectiontitle">Example Responses</h4><p><strong>Status code: 200</strong></p>
<p>Topic queried successfully.</p>
<pre class="screen">{
"name" : "topic",
"total_read_queue_num" : 3,
"total_write_queue_num" : 3,
"permission" : "all",
"brokers" : [ {
"broker_name" : "broker-0",
"read_queue_num" : 3,
"write_queue_num" : 3
} ],
"message_type" : "NORMAL"
}</pre>
</div>
<div class="section"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowOneTopic__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>Topic 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_300000002.html">Topic Management</a></div>
</div>
</div>
View Git Blame Copy Permalink