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>
178 lines
16 KiB
HTML
178 lines
16 KiB
HTML
<a name="kafka-api-180614001"></a><a name="kafka-api-180614001"></a>
|
||
|
||
<h1 class="topictitle1">Creating a Topic in a Kafka Instance</h1>
|
||
<div id="body1526386013696"><div class="note" id="kafka-api-180614001__note159644115208"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="kafka-api-180614001__p0964111132019">This API is out-of-date and may not be maintained in the future. Please use the API described in <a href="CreateInstanceTopic.html">Creating a Topic for a Kafka Instance</a>.</p>
|
||
</div></div>
|
||
<div class="section" id="kafka-api-180614001__en-us_topic_0128036928_section281017251256"><h4 class="sectiontitle">Function</h4><p id="kafka-api-180614001__en-us_topic_0128036928_p810517262255">This API is used to create a topic in a Kafka instance.</p>
|
||
</div>
|
||
<div class="section" id="kafka-api-180614001__en-us_topic_0128036928_section133368463119"><h4 class="sectiontitle">URI</h4><p id="kafka-api-180614001__en-us_topic_0128036928_p194901246121116">POST /v1.0/{project_id}/instances/{instance_id}/topics</p>
|
||
<p id="kafka-api-180614001__en-us_topic_0128036928_p749034610119"><a href="#kafka-api-180614001__en-us_topic_0128036928_table5338194611119">Table 1</a> describes the parameters.</p>
|
||
|
||
<div class="tablenoborder"><a name="kafka-api-180614001__en-us_topic_0128036928_table5338194611119"></a><a name="en-us_topic_0128036928_table5338194611119"></a><table cellpadding="4" cellspacing="0" summary="" id="kafka-api-180614001__en-us_topic_0128036928_table5338194611119" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters</caption><thead align="left"><tr id="kafka-api-180614001__en-us_topic_0128036928_row84911646141118"><th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.3.4.2.5.1.1"><p id="kafka-api-180614001__en-us_topic_0128036928_p1449164691113">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-180614001__en-us_topic_0128036928_p2491164601115">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-180614001__en-us_topic_0128036928_p144911646191112">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-180614001__en-us_topic_0128036928_p74911246171112">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="kafka-api-180614001__en-us_topic_0128036928_row144911946201115"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.4.2.5.1.1 "><p id="kafka-api-180614001__en-us_topic_0128036928_p349174618112">project_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.4.2.5.1.2 "><p id="kafka-api-180614001__en-us_topic_0128036928_p949114651114">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.3.4.2.5.1.3 "><p id="kafka-api-180614001__en-us_topic_0128036928_p1949117464112">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.3.4.2.5.1.4 "><p id="kafka-api-180614001__en-us_topic_0128036928_p849114621111">Indicates the ID of a project.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="kafka-api-180614001__en-us_topic_0128036928_row54910467110"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.4.2.5.1.1 "><p id="kafka-api-180614001__en-us_topic_0128036928_p6491174620116">instance_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.4.2.5.1.2 "><p id="kafka-api-180614001__en-us_topic_0128036928_p2491184671114">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.3.4.2.5.1.3 "><p id="kafka-api-180614001__en-us_topic_0128036928_p1549164610114">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.3.4.2.5.1.4 "><p id="kafka-api-180614001__en-us_topic_0128036928_p3491144613110">Indicates the instance ID.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="kafka-api-180614001__en-us_topic_0128036928_section8345124651115"><h4 class="sectiontitle">Request</h4><p id="kafka-api-180614001__en-us_topic_0128036928_p1049114611110"><strong id="kafka-api-180614001__en-us_topic_0128036928_b174453432226">Request parameters</strong></p>
|
||
<p id="kafka-api-180614001__en-us_topic_0128036928_p164913466118"><a href="#kafka-api-180614001__en-us_topic_0128036928_table14347154691119">Table 2</a> describes the parameter.</p>
|
||
|
||
<div class="tablenoborder"><a name="kafka-api-180614001__en-us_topic_0128036928_table14347154691119"></a><a name="en-us_topic_0128036928_table14347154691119"></a><table cellpadding="4" cellspacing="0" summary="" id="kafka-api-180614001__en-us_topic_0128036928_table14347154691119" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="kafka-api-180614001__en-us_topic_0128036928_row154923465114"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.4.4.2.5.1.1"><p id="kafka-api-180614001__en-us_topic_0128036928_p204921146111112">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.4.4.2.5.1.2"><p id="kafka-api-180614001__en-us_topic_0128036928_p13492104681119">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="12%" id="mcps1.3.4.4.2.5.1.3"><p id="kafka-api-180614001__en-us_topic_0128036928_p13492124651111">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="53%" id="mcps1.3.4.4.2.5.1.4"><p id="kafka-api-180614001__en-us_topic_0128036928_p9492154601120">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="kafka-api-180614001__en-us_topic_0128036928_row18492646191114"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.4.2.5.1.1 "><p id="kafka-api-180614001__en-us_topic_0128036928_p749214615115">id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.4.2.5.1.2 "><p id="kafka-api-180614001__en-us_topic_0128036928_p449294631114">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.4.4.2.5.1.3 "><p id="kafka-api-180614001__en-us_topic_0128036928_p16492846161110">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.4.4.2.5.1.4 "><p id="kafka-api-180614001__en-us_topic_0128036928_p12492124681111">Indicates the name of a topic. A topic name consists of 4 to 64 characters, starts with a letter, and contains only letters, hyphens (-), underscores (_), and digits.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="kafka-api-180614001__en-us_topic_0128036928_row1749224618119"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.4.2.5.1.1 "><p id="kafka-api-180614001__en-us_topic_0128036928_p449224615114">partition</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.4.2.5.1.2 "><p id="kafka-api-180614001__en-us_topic_0128036928_p164921446121117">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.4.4.2.5.1.3 "><p id="kafka-api-180614001__en-us_topic_0128036928_p12492204613114">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.4.4.2.5.1.4 "><p id="kafka-api-180614001__en-us_topic_0128036928_p9494846151117">Indicates the number of topic partitions, which is used to set the number of concurrently consumed messages.</p>
|
||
<p id="kafka-api-180614001__en-us_topic_0128036928_p74941746121117">Value range: 1–100. Default value: <strong id="kafka-api-180614001__b1175214476291">3</strong>.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="kafka-api-180614001__en-us_topic_0128036928_row3494346171114"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.4.2.5.1.1 "><p id="kafka-api-180614001__en-us_topic_0128036928_p04947464119">replication</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.4.2.5.1.2 "><p id="kafka-api-180614001__en-us_topic_0128036928_p154941346121115">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.4.4.2.5.1.3 "><p id="kafka-api-180614001__en-us_topic_0128036928_p1449420463110">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.4.4.2.5.1.4 "><p id="kafka-api-180614001__en-us_topic_0128036928_p1149414601112">Indicates the number of replicas, which is configured to ensure data reliability.</p>
|
||
<p id="kafka-api-180614001__en-us_topic_0128036928_p16494646181112">Value range: 1–3. Default value: <strong id="kafka-api-180614001__en-us_topic_0128036928_b8302226162311">3</strong>.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="kafka-api-180614001__en-us_topic_0128036928_row5439123414418"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.4.2.5.1.1 "><p id="kafka-api-180614001__en-us_topic_0128036928_p126894217446">sync_replication</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.4.2.5.1.2 "><p id="kafka-api-180614001__en-us_topic_0128036928_p12681342184417">Boolean</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.4.4.2.5.1.3 "><p id="kafka-api-180614001__en-us_topic_0128036928_p102687426440">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.4.4.2.5.1.4 "><p id="kafka-api-180614001__en-us_topic_0128036928_p62689423441">Indicates whether to enable synchronous replication. After this function is enabled, the <strong id="kafka-api-180614001__en-us_topic_0128036928_b612714530233">acks</strong> parameter on the producer client must be set to <strong id="kafka-api-180614001__en-us_topic_0128036928_b163774562239">–1</strong>. Otherwise, this parameter does not take effect.</p>
|
||
<p id="kafka-api-180614001__en-us_topic_0128036928_p192687429448">By default, synchronous replication is disabled.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="kafka-api-180614001__en-us_topic_0128036928_row4494846201111"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.4.2.5.1.1 "><p id="kafka-api-180614001__en-us_topic_0128036928_p6494134661119">retention_time</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.4.2.5.1.2 "><p id="kafka-api-180614001__en-us_topic_0128036928_p194941446151118">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.4.4.2.5.1.3 "><p id="kafka-api-180614001__en-us_topic_0128036928_p549413462117">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.4.4.2.5.1.4 "><p id="kafka-api-180614001__en-us_topic_0128036928_p8494184661118">Indicates the retention period of a message. Its default value is <strong id="kafka-api-180614001__en-us_topic_0128036928_b1195453154817">72</strong>.</p>
|
||
<p id="kafka-api-180614001__en-us_topic_0128036928_p12494546161116">Value range: 1–720. Unit: hour.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="kafka-api-180614001__en-us_topic_0128036928_row1049444651117"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.4.2.5.1.1 "><p id="kafka-api-180614001__en-us_topic_0128036928_p114941646151117">sync_message_flush</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.4.2.5.1.2 "><p id="kafka-api-180614001__en-us_topic_0128036928_p2049413469114">Boolean</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.4.4.2.5.1.3 "><p id="kafka-api-180614001__en-us_topic_0128036928_p049494615110">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.4.4.2.5.1.4 "><p id="kafka-api-180614001__en-us_topic_0128036928_p19494144617119">Indicates whether to enable synchronous flushing. Default value: <strong id="kafka-api-180614001__en-us_topic_0128036928_b151438394241">false</strong>. Synchronous flushing compromises performance.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<p id="kafka-api-180614001__en-us_topic_0128036928_p0494446191112"><strong id="kafka-api-180614001__en-us_topic_0128036928_b9938536248">Example request</strong></p>
|
||
<pre class="screen" id="kafka-api-180614001__en-us_topic_0128036928_screen14568155374615">POST https://{dms_endpoint}/v1.0/{project_id}/instances/{instance_id}/topics
|
||
{
|
||
"id" : "haha",
|
||
"partition" : 3,
|
||
"replication" : 3,
|
||
"sync_replication " : true,
|
||
"retention_time" : 10,
|
||
"sync_message_flush" : true
|
||
}</pre>
|
||
</div>
|
||
<div class="section" id="kafka-api-180614001__en-us_topic_0128036928_section837314461114"><h4 class="sectiontitle">Response</h4><p id="kafka-api-180614001__en-us_topic_0128036928_p11495104611114"><strong id="kafka-api-180614001__en-us_topic_0128036928_b3718165772411">Response parameters</strong></p>
|
||
<p id="kafka-api-180614001__en-us_topic_0128036928_p04952469119"><a href="#kafka-api-180614001__en-us_topic_0128036928_table113758463117">Table 3</a> describes the parameter.</p>
|
||
|
||
<div class="tablenoborder"><a name="kafka-api-180614001__en-us_topic_0128036928_table113758463117"></a><a name="en-us_topic_0128036928_table113758463117"></a><table cellpadding="4" cellspacing="0" summary="" id="kafka-api-180614001__en-us_topic_0128036928_table113758463117" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameters</caption><thead align="left"><tr id="kafka-api-180614001__en-us_topic_0128036928_row049524619114"><th align="left" class="cellrowborder" valign="top" width="23.23%" id="mcps1.3.5.4.2.4.1.1"><p id="kafka-api-180614001__en-us_topic_0128036928_p154951446141113">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="21.21%" id="mcps1.3.5.4.2.4.1.2"><p id="kafka-api-180614001__en-us_topic_0128036928_p9495174614117">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="55.559999999999995%" id="mcps1.3.5.4.2.4.1.3"><p id="kafka-api-180614001__en-us_topic_0128036928_p949515469114">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="kafka-api-180614001__en-us_topic_0128036928_row16495194631111"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180614001__en-us_topic_0128036928_p649554610116">id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180614001__en-us_topic_0128036928_p19495184671120">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180614001__en-us_topic_0128036928_p44956464114">Indicates the name of a topic.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<p id="kafka-api-180614001__en-us_topic_0128036928_p124959462117"><strong id="kafka-api-180614001__en-us_topic_0128036928_b339013782511">Example response</strong></p>
|
||
<pre class="screen" id="kafka-api-180614001__en-us_topic_0128036928_screen17495134621116">{
|
||
"id": "haha"
|
||
}</pre>
|
||
</div>
|
||
<div class="section" id="kafka-api-180614001__en-us_topic_0128036928_section5381204691118"><h4 class="sectiontitle">Status Code</h4><p id="kafka-api-180614001__en-us_topic_0128036928_p174955463112"><a href="#kafka-api-180614001__en-us_topic_0128036928_table4381154610118">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-180614001__en-us_topic_0128036928_table4381154610118"></a><a name="en-us_topic_0128036928_table4381154610118"></a><table cellpadding="4" cellspacing="0" summary="" id="kafka-api-180614001__en-us_topic_0128036928_table4381154610118" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Status code</caption><thead align="left"><tr id="kafka-api-180614001__en-us_topic_0128036928_row549534661115"><th align="left" class="cellrowborder" valign="top" width="15.15%" id="mcps1.3.6.3.2.3.1.1"><p id="kafka-api-180614001__en-us_topic_0128036928_p13495134691117">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-180614001__en-us_topic_0128036928_p11496174618117">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="kafka-api-180614001__en-us_topic_0128036928_row14965461118"><td class="cellrowborder" valign="top" width="15.15%" headers="mcps1.3.6.3.2.3.1.1 "><p id="kafka-api-180614001__en-us_topic_0128036928_p1449610463118">200</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="84.85000000000001%" headers="mcps1.3.6.3.2.3.1.2 "><p id="kafka-api-180614001__en-us_topic_0128036928_p14496204612119">The topic is created 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>
|
||
|