forked from docs/doc-exports
Chen, Junjie
7f68b84da4
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: Chen, Junjie <chenjunjie@huawei.com> Co-committed-by: Chen, Junjie <chenjunjie@huawei.com>
213 lines
18 KiB
HTML
213 lines
18 KiB
HTML
<a name="kafka-api-180614002"></a><a name="kafka-api-180614002"></a>
|
||
|
||
<h1 class="topictitle1">Querying a Topic in a Kafka Instance</h1>
|
||
<div id="body1526386013696"><div class="note" id="kafka-api-180614002__note159644115208"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="kafka-api-180614002__p0964111132019">This API is out-of-date and may not be maintained in the future. Please use the API described in <a href="ListInstanceTopics.html">Listing Topics of a Kafka Instance</a>.</p>
|
||
</div></div>
|
||
<div class="section" id="kafka-api-180614002__en-us_topic_0128036881_section281017251256"><h4 class="sectiontitle">Function</h4><p id="kafka-api-180614002__en-us_topic_0128036881_p810517262255">This API is used to query details about a topic in a Kafka instance.</p>
|
||
</div>
|
||
<div class="section" id="kafka-api-180614002__en-us_topic_0128036881_section153934371214"><h4 class="sectiontitle">URI</h4><p id="kafka-api-180614002__en-us_topic_0128036881_p1849316317128">GET /v1.0/{project_id}/instances/{instance_id}/topics</p>
|
||
<p id="kafka-api-180614002__en-us_topic_0128036881_p17493173161218"><a href="#kafka-api-180614002__en-us_topic_0128036881_table163952313129">Table 1</a> describes the parameter.</p>
|
||
|
||
<div class="tablenoborder"><a name="kafka-api-180614002__en-us_topic_0128036881_table163952313129"></a><a name="en-us_topic_0128036881_table163952313129"></a><table cellpadding="4" cellspacing="0" summary="" id="kafka-api-180614002__en-us_topic_0128036881_table163952313129" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters</caption><thead align="left"><tr id="kafka-api-180614002__en-us_topic_0128036881_row2493193181217"><th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.3.4.2.5.1.1"><p id="kafka-api-180614002__en-us_topic_0128036881_p249343171215">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="13%" id="mcps1.3.3.4.2.5.1.2"><p id="kafka-api-180614002__en-us_topic_0128036881_p1549383101214">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="12%" id="mcps1.3.3.4.2.5.1.3"><p id="kafka-api-180614002__en-us_topic_0128036881_p1249323141214">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="59%" id="mcps1.3.3.4.2.5.1.4"><p id="kafka-api-180614002__en-us_topic_0128036881_p44932341212">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="kafka-api-180614002__en-us_topic_0128036881_row2493031124"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.4.2.5.1.1 "><p id="kafka-api-180614002__en-us_topic_0128036881_p8493153191215">project_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.4.2.5.1.2 "><p id="kafka-api-180614002__en-us_topic_0128036881_p18493103191215">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.3.4.2.5.1.3 "><p id="kafka-api-180614002__en-us_topic_0128036881_p11493634127">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.3.4.2.5.1.4 "><p id="kafka-api-180614002__en-us_topic_0128036881_p114938311210">Indicates the ID of a project.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="kafka-api-180614002__en-us_topic_0128036881_row74931936127"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.4.2.5.1.1 "><p id="kafka-api-180614002__en-us_topic_0128036881_p049393171212">instance_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.4.2.5.1.2 "><p id="kafka-api-180614002__en-us_topic_0128036881_p1849319381212">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.3.4.2.5.1.3 "><p id="kafka-api-180614002__en-us_topic_0128036881_p94938319125">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.3.4.2.5.1.4 "><p id="kafka-api-180614002__en-us_topic_0128036881_p1949316301217">Indicates the instance ID.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="kafka-api-180614002__en-us_topic_0128036881_section540483191220"><h4 class="sectiontitle">Request</h4><p id="kafka-api-180614002__en-us_topic_0128036881_p3493163191217"><strong id="kafka-api-180614002__en-us_topic_0128036881_b8317147262">Request parameters</strong></p>
|
||
<p id="kafka-api-180614002__en-us_topic_0128036881_p12493193201216">None.</p>
|
||
<p id="kafka-api-180614002__en-us_topic_0128036881_p1449393201213"><strong id="kafka-api-180614002__b1772713782219">Example request</strong></p>
|
||
<pre class="screen" id="kafka-api-180614002__screen958510343106">GET https://{dms_endpoint}/v1.0/{project_id}/instances/{instance_id}/topics</pre>
|
||
</div>
|
||
<div class="section" id="kafka-api-180614002__en-us_topic_0128036881_section1740614351212"><h4 class="sectiontitle">Response</h4><p id="kafka-api-180614002__en-us_topic_0128036881_p16493143121210"><strong id="kafka-api-180614002__en-us_topic_0128036881_b683241020261">Response parameters</strong></p>
|
||
<p id="kafka-api-180614002__en-us_topic_0128036881_p19493183151211"><a href="#kafka-api-180614002__en-us_topic_0128036881_table2407333125">Table 2</a> describes the response parameter.</p>
|
||
|
||
<div class="tablenoborder"><a name="kafka-api-180614002__en-us_topic_0128036881_table2407333125"></a><a name="en-us_topic_0128036881_table2407333125"></a><table cellpadding="4" cellspacing="0" summary="" id="kafka-api-180614002__en-us_topic_0128036881_table2407333125" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameter</caption><thead align="left"><tr id="kafka-api-180614002__en-us_topic_0128036881_row20493934122"><th align="left" class="cellrowborder" valign="top" width="23.23%" id="mcps1.3.5.4.2.4.1.1"><p id="kafka-api-180614002__en-us_topic_0128036881_p16493437123">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="22.220000000000002%" id="mcps1.3.5.4.2.4.1.2"><p id="kafka-api-180614002__en-us_topic_0128036881_p1849315317125">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="54.55%" id="mcps1.3.5.4.2.4.1.3"><p id="kafka-api-180614002__en-us_topic_0128036881_p114931631122">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="kafka-api-180614002__row228343844"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180614002__p1119016260425">total</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180614002__p121919269427">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="54.55%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180614002__p91911026124217">Indicates the total number of topics.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="kafka-api-180614002__row1603517475"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180614002__p3192102610426">size</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180614002__p16192142684219">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="54.55%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180614002__p919332614217">Indicates the maximum number of records to be displayed on a page.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="kafka-api-180614002__row17199198124716"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180614002__p13194172624219">remain_partitions</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180614002__p319522611423">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="54.55%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180614002__p21963261422">Indicates the number of remaining partitions.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="kafka-api-180614002__row48551820478"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180614002__p181985264421">max_partitions</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180614002__p419832613421">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="54.55%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180614002__p1219918269421">Indicates the total number of partitions.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="kafka-api-180614002__en-us_topic_0128036881_row349318361214"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180614002__en-us_topic_0128036881_p149316320122">topics</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180614002__en-us_topic_0128036881_p1949514321211">Array</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="54.55%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180614002__en-us_topic_0128036881_p144951938128">Indicates the list of topics.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="kafka-api-180614002__en-us_topic_0128036881_table721516381617" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameter description</caption><thead align="left"><tr id="kafka-api-180614002__en-us_topic_0128036881_row521819351615"><th align="left" class="cellrowborder" valign="top" width="23.23%" id="mcps1.3.5.5.2.4.1.1"><p id="kafka-api-180614002__en-us_topic_0128036881_p1421916319160">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="22.220000000000002%" id="mcps1.3.5.5.2.4.1.2"><p id="kafka-api-180614002__en-us_topic_0128036881_p19220193181611">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="54.55%" id="mcps1.3.5.5.2.4.1.3"><p id="kafka-api-180614002__en-us_topic_0128036881_p42211734161">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="kafka-api-180614002__row177251838135014"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180614002__p2205152611429">policiesOnly</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180614002__p11206182610429">Boolean</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="54.55%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180614002__p10206142616425">Whether this policy is the default policy.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="kafka-api-180614002__en-us_topic_0128036881_row182259318164"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180614002__en-us_topic_0128036881_p82278351616">id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180614002__en-us_topic_0128036881_p7227153111619">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="54.55%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180614002__en-us_topic_0128036881_p52277361617">Indicates the topic name.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="kafka-api-180614002__row17458933085"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180614002__en-us_topic_0128036881_p723243121615">replication</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180614002__en-us_topic_0128036881_p52321939169">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="54.55%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180614002__en-us_topic_0128036881_p52349310161">Indicates the number of replicas, which is configured to ensure data reliability.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="kafka-api-180614002__en-us_topic_0128036881_row622718313161"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180614002__en-us_topic_0128036881_p132281318163">partition</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180614002__en-us_topic_0128036881_p92304331618">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="54.55%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180614002__en-us_topic_0128036881_p1023023101615">Indicates the number of topic partitions, which is used to set the number of concurrently consumed messages.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="kafka-api-180614002__en-us_topic_0128036881_row102302321617"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180614002__en-us_topic_0128036881_p1423419319167">retention_time</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180614002__en-us_topic_0128036881_p1023616315167">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="54.55%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180614002__en-us_topic_0128036881_p1923619351613">Indicates the retention period of a message.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="kafka-api-180614002__en-us_topic_0128036881_row1994501616482"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180614002__en-us_topic_0128036881_p126894217446">sync_replication</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180614002__en-us_topic_0128036881_p12681342184417">Boolean</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="54.55%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180614002__en-us_topic_0128036881_p62689423441">Indicates whether to enable synchronous replication. After this function is enabled, the <strong id="kafka-api-180614002__en-us_topic_0128036881_b67657501264">acks</strong> parameter on the producer client must be set to <strong id="kafka-api-180614002__en-us_topic_0128036881_b5765155092617">–1</strong>. Otherwise, this parameter does not take effect.</p>
|
||
<p id="kafka-api-180614002__en-us_topic_0128036881_p192687429448">By default, synchronous replication is disabled.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="kafka-api-180614002__en-us_topic_0128036881_row62340310167"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180614002__en-us_topic_0128036881_p1123719314161">sync_message_flush</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180614002__en-us_topic_0128036881_p3237235167">Boolean</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="54.55%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180614002__en-us_topic_0128036881_p1923911315167">Indicates whether to enable synchronous flushing. Synchronous flushing compromises performance.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="kafka-api-180614002__row177601528105014"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180614002__p1216426184219">external_configs</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180614002__p10217526154219">Object</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="54.55%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180614002__p18217526114211">Indicates the extended configuration.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="kafka-api-180614002__row1252633216502"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180614002__p19218112674216">topic_type</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180614002__p921882654212">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="54.55%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180614002__p192181926104210">Indicates the topic type.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<p id="kafka-api-180614002__en-us_topic_0128036881_p3495163151218"><strong id="kafka-api-180614002__en-us_topic_0128036881_b2064012312270">Example response</strong></p>
|
||
<pre class="screen" id="kafka-api-180614002__screen16839113011318">{
|
||
"count": 1,
|
||
"topics": [
|
||
{
|
||
"id": "topic-test",
|
||
"replication": 3,
|
||
"partition": 4,
|
||
"retention_time": 72,
|
||
"sync_replication": "false",
|
||
"sync_message_flush": "false"
|
||
}
|
||
]
|
||
}</pre>
|
||
<p id="kafka-api-180614002__p1576662612316"></p>
|
||
</div>
|
||
<div class="section" id="kafka-api-180614002__en-us_topic_0128036881_section17430153151212"><h4 class="sectiontitle">Status Code</h4><p id="kafka-api-180614002__en-us_topic_0128036881_p12496143201219"><a href="#kafka-api-180614002__en-us_topic_0128036881_table64308351212">Table 4</a> describes the status code of successful operations. For details about other status codes, see <a href="kafka-api-0034672261.html">Status Code</a>.</p>
|
||
|
||
<div class="tablenoborder"><a name="kafka-api-180614002__en-us_topic_0128036881_table64308351212"></a><a name="en-us_topic_0128036881_table64308351212"></a><table cellpadding="4" cellspacing="0" summary="" id="kafka-api-180614002__en-us_topic_0128036881_table64308351212" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Status code</caption><thead align="left"><tr id="kafka-api-180614002__en-us_topic_0128036881_row204961735122"><th align="left" class="cellrowborder" valign="top" width="15.15%" id="mcps1.3.6.3.2.3.1.1"><p id="kafka-api-180614002__en-us_topic_0128036881_p3496133121">Status Code</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="84.85000000000001%" id="mcps1.3.6.3.2.3.1.2"><p id="kafka-api-180614002__en-us_topic_0128036881_p0496103161220">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="kafka-api-180614002__en-us_topic_0128036881_row949618381217"><td class="cellrowborder" valign="top" width="15.15%" headers="mcps1.3.6.3.2.3.1.1 "><p id="kafka-api-180614002__en-us_topic_0128036881_p849618371213">200</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="84.85000000000001%" headers="mcps1.3.6.3.2.3.1.2 "><p id="kafka-api-180614002__en-us_topic_0128036881_p24961391213">The information is queried successfully.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div>
|
||
<div class="familylinks">
|
||
<div class="parentlink"><strong>Parent topic:</strong> <a href="kafka-api-180514001.html">APIs for Managing Instances</a></div>
|
||
</div>
|
||
</div>
|
||
|