vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/dms/api-ref/kafka-api-180514002.html
Chen, Junjie ef239b7410 DMS API-REF 20230201 Version 
Reviewed-by: Ziuzko, Stanislav <stanislav.ziuzko@t-systems.com>
Co-authored-by: Chen, Junjie <chenjunjie@huawei.com>
Co-committed-by: Chen, Junjie <chenjunjie@huawei.com>
2024-07-03 17:41:26 +00:00

445 lines
51 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<a name="kafka-api-180514002"></a><a name="kafka-api-180514002"></a>
<h1 class="topictitle1">Creating an Instance</h1>
<div id="body1524661275118"><div class="note" id="kafka-api-180514002__note159644115208"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="kafka-api-180514002__p0964111132019">This API is out-of-date and may not be maintained in the future. Please use the API described in <a href="CreateInstanceByEngine.html">Creating an Instance</a>.</p>
</div></div>
<div class="section" id="kafka-api-180514002__en-us_topic_0128036927_section19327142112288"><h4 class="sectiontitle">Function</h4><p id="kafka-api-180514002__p261826103320">This API is used to create a Kafka instance.</p>
</div>
<div class="section" id="kafka-api-180514002__en-us_topic_0128036927_section01615217250"><h4 class="sectiontitle">URI</h4><p id="kafka-api-180514002__en-us_topic_0128036927_p13313428251">POST /v1.0/<em id="kafka-api-180514002__i3967145115166">{project_id}</em>/instances</p>
<p id="kafka-api-180514002__en-us_topic_0128036927_p1531372112519"><a href="#kafka-api-180514002__en-us_topic_0128036927_table0211262515">Table 1</a> describes the parameter.</p>
<div class="tablenoborder"><a name="kafka-api-180514002__en-us_topic_0128036927_table0211262515"></a><a name="en-us_topic_0128036927_table0211262515"></a><table cellpadding="4" cellspacing="0" summary="" id="kafka-api-180514002__en-us_topic_0128036927_table0211262515" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters</caption><thead align="left"><tr id="kafka-api-180514002__en-us_topic_0128036927_row2031516262518"><th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.3.4.2.5.1.1"><p id="kafka-api-180514002__en-us_topic_0128036927_p631522182516">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-180514002__en-us_topic_0128036927_p731516272513">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-180514002__en-us_topic_0128036927_p15315124252">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-180514002__en-us_topic_0128036927_p183155252514">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="kafka-api-180514002__en-us_topic_0128036927_row183151820257"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.4.2.5.1.1 "><p id="kafka-api-180514002__en-us_topic_0128036927_p731542202515">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.4.2.5.1.2 "><p id="kafka-api-180514002__en-us_topic_0128036927_p14315028257">String</p>
</td>
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.3.4.2.5.1.3 "><p id="kafka-api-180514002__en-us_topic_0128036927_p43151224252">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.3.4.2.5.1.4 "><p id="kafka-api-180514002__en-us_topic_0128036927_p10316627259">Indicates the ID of a project.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="kafka-api-180514002__en-us_topic_0128036927_section19344222516"><h4 class="sectiontitle">Request</h4><p id="kafka-api-180514002__en-us_topic_0128036927_p183165282512"><strong id="kafka-api-180514002__en-us_topic_0128036927_b961151118491">Request parameters</strong></p>
<p id="kafka-api-180514002__en-us_topic_0128036927_p13163217252"><a href="#kafka-api-180514002__en-us_topic_0128036927_table63510212250">Table 2</a> describes the parameters.</p>
<div class="tablenoborder"><a name="kafka-api-180514002__en-us_topic_0128036927_table63510212250"></a><a name="en-us_topic_0128036927_table63510212250"></a><table cellpadding="4" cellspacing="0" summary="" id="kafka-api-180514002__en-us_topic_0128036927_table63510212250" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="kafka-api-180514002__en-us_topic_0128036927_row173161423257"><th align="left" class="cellrowborder" valign="top" width="17.646464646464647%" id="mcps1.3.4.4.2.5.1.1"><p id="kafka-api-180514002__en-us_topic_0128036927_p183163211252">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.727272727272728%" id="mcps1.3.4.4.2.5.1.2"><p id="kafka-api-180514002__en-us_topic_0128036927_p193161422257">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.04040404040404%" id="mcps1.3.4.4.2.5.1.3"><p id="kafka-api-180514002__en-us_topic_0128036927_p831610215252">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="58.58585858585859%" id="mcps1.3.4.4.2.5.1.4"><p id="kafka-api-180514002__en-us_topic_0128036927_p10316142162517">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="kafka-api-180514002__en-us_topic_0128036927_row18316132152511"><td class="cellrowborder" valign="top" width="17.646464646464647%" headers="mcps1.3.4.4.2.5.1.1 "><p id="kafka-api-180514002__en-us_topic_0128036927_p1731618219251">name</p>
</td>
<td class="cellrowborder" valign="top" width="12.727272727272728%" headers="mcps1.3.4.4.2.5.1.2 "><p id="kafka-api-180514002__en-us_topic_0128036927_p1431612210251">String</p>
</td>
<td class="cellrowborder" valign="top" width="11.04040404040404%" headers="mcps1.3.4.4.2.5.1.3 "><p id="kafka-api-180514002__en-us_topic_0128036927_p183161727253">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="58.58585858585859%" headers="mcps1.3.4.4.2.5.1.4 "><p id="kafka-api-180514002__en-us_topic_0128036927_p14316162182511">Indicates the instance name.</p>
<p id="kafka-api-180514002__en-us_topic_0128036927_p53166212252">An instance name starts with a letter, consists of 4 to 64 characters, and can contain only letters, digits, underscores (_), and hyphens (-).</p>
</td>
</tr>
<tr id="kafka-api-180514002__en-us_topic_0128036927_row831615212510"><td class="cellrowborder" valign="top" width="17.646464646464647%" headers="mcps1.3.4.4.2.5.1.1 "><p id="kafka-api-180514002__en-us_topic_0128036927_p1031652112514">description</p>
</td>
<td class="cellrowborder" valign="top" width="12.727272727272728%" headers="mcps1.3.4.4.2.5.1.2 "><p id="kafka-api-180514002__en-us_topic_0128036927_p931622192514">String</p>
</td>
<td class="cellrowborder" valign="top" width="11.04040404040404%" headers="mcps1.3.4.4.2.5.1.3 "><p id="kafka-api-180514002__en-us_topic_0128036927_p163164282520">No</p>
</td>
<td class="cellrowborder" valign="top" width="58.58585858585859%" headers="mcps1.3.4.4.2.5.1.4 "><p id="kafka-api-180514002__en-us_topic_0128036927_p63161242514">Indicates the description of an instance.</p>
<p id="kafka-api-180514002__en-us_topic_0128036927_p5316142122513">It is a character string containing not more than 1024 characters.</p>
<div class="note" id="kafka-api-180514002__en-us_topic_0128036927_note4439215254"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="kafka-api-180514002__en-us_topic_0128036927_p931610214253">The backslash (\) and quotation mark (") are special characters for JSON packets. When using these characters in a parameter value, add the escape character (\) before these characters, for example, <strong id="kafka-api-180514002__en-us_topic_0128036927_b566202855818">\\</strong> and <strong id="kafka-api-180514002__en-us_topic_0128036927_b1427134685817">\"</strong>.</p>
</div></div>
</td>
</tr>
<tr id="kafka-api-180514002__en-us_topic_0128036927_row731618292515"><td class="cellrowborder" valign="top" width="17.646464646464647%" headers="mcps1.3.4.4.2.5.1.1 "><p id="kafka-api-180514002__en-us_topic_0128036927_p931813219255">engine</p>
</td>
<td class="cellrowborder" valign="top" width="12.727272727272728%" headers="mcps1.3.4.4.2.5.1.2 "><p id="kafka-api-180514002__en-us_topic_0128036927_p231862182512">String</p>
</td>
<td class="cellrowborder" valign="top" width="11.04040404040404%" headers="mcps1.3.4.4.2.5.1.3 "><p id="kafka-api-180514002__en-us_topic_0128036927_p113188214252">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="58.58585858585859%" headers="mcps1.3.4.4.2.5.1.4 "><p id="kafka-api-180514002__en-us_topic_0128036927_p113181222515">Indicates the message engine. Set the value to <strong id="kafka-api-180514002__b151971756123416">kafka</strong>.</p>
</td>
</tr>
<tr id="kafka-api-180514002__en-us_topic_0128036927_row173189212518"><td class="cellrowborder" valign="top" width="17.646464646464647%" headers="mcps1.3.4.4.2.5.1.1 "><p id="kafka-api-180514002__en-us_topic_0128036927_p17318152162516">engine_version</p>
</td>
<td class="cellrowborder" valign="top" width="12.727272727272728%" headers="mcps1.3.4.4.2.5.1.2 "><p id="kafka-api-180514002__en-us_topic_0128036927_p53181326257">String</p>
</td>
<td class="cellrowborder" valign="top" width="11.04040404040404%" headers="mcps1.3.4.4.2.5.1.3 "><p id="kafka-api-180514002__en-us_topic_0128036927_p631815214256">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="58.58585858585859%" headers="mcps1.3.4.4.2.5.1.4 "><p id="kafka-api-180514002__en-us_topic_0128036927_p1531819212254">Indicates the version of the message engine. Value: <strong id="kafka-api-180514002__b72891633134217">1.1.0</strong>, <strong id="kafka-api-180514002__b62891833164214">2.3.0</strong>, or <strong id="kafka-api-180514002__b1692713548424">2.7</strong>.</p>
</td>
</tr>
<tr id="kafka-api-180514002__en-us_topic_0128036927_row031813220253"><td class="cellrowborder" valign="top" width="17.646464646464647%" headers="mcps1.3.4.4.2.5.1.1 "><p id="kafka-api-180514002__en-us_topic_0128036927_p1831842142511">specification</p>
</td>
<td class="cellrowborder" valign="top" width="12.727272727272728%" headers="mcps1.3.4.4.2.5.1.2 "><p id="kafka-api-180514002__en-us_topic_0128036927_p7318182132516">String</p>
</td>
<td class="cellrowborder" valign="top" width="11.04040404040404%" headers="mcps1.3.4.4.2.5.1.3 "><p id="kafka-api-180514002__en-us_topic_0128036927_p113181523253">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="58.58585858585859%" headers="mcps1.3.4.4.2.5.1.4 "><p id="kafka-api-180514002__en-us_topic_0128036927_p17110843103910">Indicates the baseline bandwidth of a Kafka instance, that is, the maximum amount of data transferred per unit time. Unit: MB</p>
<p id="kafka-api-180514002__en-us_topic_0128036927_p8167464394">Options:</p>
<ul id="kafka-api-180514002__en-us_topic_0128036927_ul28938014017"><li id="kafka-api-180514002__en-us_topic_0128036927_li128576436514">100 MB</li><li id="kafka-api-180514002__en-us_topic_0128036927_li587820074016">300 MB</li><li id="kafka-api-180514002__en-us_topic_0128036927_li187815074019">600 MB</li><li id="kafka-api-180514002__en-us_topic_0128036927_li148781403406">1200 MB</li></ul>
</td>
</tr>
<tr id="kafka-api-180514002__en-us_topic_0128036927_row10318125250"><td class="cellrowborder" valign="top" width="17.646464646464647%" headers="mcps1.3.4.4.2.5.1.1 "><p id="kafka-api-180514002__en-us_topic_0128036927_p10318825257">storage_space</p>
</td>
<td class="cellrowborder" valign="top" width="12.727272727272728%" headers="mcps1.3.4.4.2.5.1.2 "><p id="kafka-api-180514002__en-us_topic_0128036927_p831818217255">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="11.04040404040404%" headers="mcps1.3.4.4.2.5.1.3 "><p id="kafka-api-180514002__en-us_topic_0128036927_p2031814215259">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="58.58585858585859%" headers="mcps1.3.4.4.2.5.1.4 "><p id="kafka-api-180514002__en-us_topic_0128036927_p204134364548">Indicates the message storage space.</p>
<p id="kafka-api-180514002__en-us_topic_0128036927_p1781611169593">Unit: GB. Value range:</p>
<ul id="kafka-api-180514002__en-us_topic_0128036927_ul821611342209"><li id="kafka-api-180514002__en-us_topic_0128036927_li18189144045017">Kafka instance with <strong id="kafka-api-180514002__b1660311035414">specification</strong> being <strong id="kafka-api-180514002__b160519017548">100MB</strong>: 600–90,000 GB</li><li id="kafka-api-180514002__en-us_topic_0128036927_li6451145015208">Kafka instance with <strong id="kafka-api-180514002__b164460935415">specification</strong> being <strong id="kafka-api-180514002__b54481595549">300MB</strong>: 1200–90,000 GB</li><li id="kafka-api-180514002__en-us_topic_0128036927_li299973722216">Kafka instance with <strong id="kafka-api-180514002__b64901811155416">specification</strong> being <strong id="kafka-api-180514002__b349251117543">600MB</strong>: 2400–90,000 GB</li><li id="kafka-api-180514002__en-us_topic_0128036927_li217318367235">Kafka instance with <strong id="kafka-api-180514002__b1324164015313">specification</strong> being <strong id="kafka-api-180514002__b6261040165314">1200MB</strong>: 4800–90,000 GB</li></ul>
</td>
</tr>
<tr id="kafka-api-180514002__en-us_topic_0128036927_row113199232515"><td class="cellrowborder" valign="top" width="17.646464646464647%" headers="mcps1.3.4.4.2.5.1.1 "><p id="kafka-api-180514002__en-us_topic_0128036927_p19527195671416">partition_num</p>
</td>
<td class="cellrowborder" valign="top" width="12.727272727272728%" headers="mcps1.3.4.4.2.5.1.2 "><p id="kafka-api-180514002__en-us_topic_0128036927_p17530105611149">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="11.04040404040404%" headers="mcps1.3.4.4.2.5.1.3 "><p id="kafka-api-180514002__en-us_topic_0128036927_p17532556191412">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="58.58585858585859%" headers="mcps1.3.4.4.2.5.1.4 "><p id="kafka-api-180514002__en-us_topic_0128036927_p161049416113">Indicates the maximum number of partitions in a Kafka instance.</p>
<p id="kafka-api-180514002__en-us_topic_0128036927_p580710361212">Options:</p>
<ul id="kafka-api-180514002__en-us_topic_0128036927_ul5322161012014"><li id="kafka-api-180514002__en-us_topic_0128036927_li112051751184916">When <strong id="kafka-api-180514002__b1922916264321">specification</strong> is <strong id="kafka-api-180514002__b10230172633218">100MB</strong>: <strong id="kafka-api-180514002__b14231526133215">300</strong></li><li id="kafka-api-180514002__en-us_topic_0128036927_li593141916201">When <strong id="kafka-api-180514002__b9283112783215">specification</strong> is <strong id="kafka-api-180514002__b1828372753217">300MB</strong>: <strong id="kafka-api-180514002__b4284172713212">900</strong></li><li id="kafka-api-180514002__en-us_topic_0128036927_li832251022019">When <strong id="kafka-api-180514002__b24951928173215">specification</strong> is <strong id="kafka-api-180514002__b1649652812323">600MB</strong>: <strong id="kafka-api-180514002__b1049792813325">1800</strong></li><li id="kafka-api-180514002__en-us_topic_0128036927_li1833881072012">When <strong id="kafka-api-180514002__en-us_topic_0128036927_b956904919019">specification</strong> is <strong id="kafka-api-180514002__en-us_topic_0128036927_b756917491300">1200 MB</strong>: <strong id="kafka-api-180514002__en-us_topic_0128036927_b1256910491006">1800</strong></li></ul>
</td>
</tr>
<tr id="kafka-api-180514002__en-us_topic_0128036927_row162885518507"><td class="cellrowborder" valign="top" width="17.646464646464647%" headers="mcps1.3.4.4.2.5.1.1 "><p id="kafka-api-180514002__en-us_topic_0128036927_p017271119505">access_user</p>
</td>
<td class="cellrowborder" valign="top" width="12.727272727272728%" headers="mcps1.3.4.4.2.5.1.2 "><p id="kafka-api-180514002__en-us_topic_0128036927_p317720111505">String</p>
</td>
<td class="cellrowborder" valign="top" width="11.04040404040404%" headers="mcps1.3.4.4.2.5.1.3 "><p id="kafka-api-180514002__en-us_topic_0128036927_p17180111185015">No</p>
</td>
<td class="cellrowborder" valign="top" width="58.58585858585859%" headers="mcps1.3.4.4.2.5.1.4 "><p id="kafka-api-180514002__en-us_topic_0128036927_p350512371501">This parameter is mandatory when <strong id="kafka-api-180514002__en-us_topic_0128036927_b126211125310">ssl_enable</strong> is set to <strong id="kafka-api-180514002__en-us_topic_0128036927_b13496111315313">true</strong>. This parameter is invalid when <strong id="kafka-api-180514002__en-us_topic_0128036927_b6293185117531">ssl_enable</strong> is set to <strong id="kafka-api-180514002__en-us_topic_0128036927_b132621659105317">false</strong>.</p>
<p id="kafka-api-180514002__en-us_topic_0128036927_p9187911185010">Indicates a username. A username consists of 4 to 64 characters and can contain letters, digits, and hyphens (-).</p>
</td>
</tr>
<tr id="kafka-api-180514002__en-us_topic_0128036927_row1331918232516"><td class="cellrowborder" valign="top" width="17.646464646464647%" headers="mcps1.3.4.4.2.5.1.1 "><p id="kafka-api-180514002__en-us_topic_0128036927_p1531913213255">password</p>
</td>
<td class="cellrowborder" valign="top" width="12.727272727272728%" headers="mcps1.3.4.4.2.5.1.2 "><p id="kafka-api-180514002__en-us_topic_0128036927_p193199252510">String</p>
</td>
<td class="cellrowborder" valign="top" width="11.04040404040404%" headers="mcps1.3.4.4.2.5.1.3 "><p id="kafka-api-180514002__en-us_topic_0128036927_p6319102122516">No</p>
</td>
<td class="cellrowborder" valign="top" width="58.58585858585859%" headers="mcps1.3.4.4.2.5.1.4 "><p id="kafka-api-180514002__en-us_topic_0128036927_p92285164212">This parameter is mandatory when <strong id="kafka-api-180514002__en-us_topic_0128036927_b16529184554816">ssl_enable</strong> is set to <strong id="kafka-api-180514002__en-us_topic_0128036927_b152974510489">true</strong>. This parameter is invalid when <strong id="kafka-api-180514002__en-us_topic_0128036927_b25298452484">ssl_enable</strong> is set to <strong id="kafka-api-180514002__en-us_topic_0128036927_b205291545154814">false</strong>.</p>
<p id="kafka-api-180514002__en-us_topic_0128036927_p18319423255">Indicates an instance password.</p>
<p id="kafka-api-180514002__en-us_topic_0128036927_p1431914282516">The password must meet the following complexity requirements:</p>
<ul id="kafka-api-180514002__en-us_topic_0128036927_ul19319821253"><li id="kafka-api-180514002__en-us_topic_0128036927_li331952112518">Must be a string consisting of 8 to 32 characters.</li><li id="kafka-api-180514002__en-us_topic_0128036927_li23191228258">Must contain at least three of the following character types:<ul id="kafka-api-180514002__en-us_topic_0128036927_ul1645101813412"><li id="kafka-api-180514002__en-us_topic_0128036927_li73196218250">Lowercase letters</li><li id="kafka-api-180514002__en-us_topic_0128036927_li73197217251">Uppercase letters</li><li id="kafka-api-180514002__en-us_topic_0128036927_li143191323258">Digits</li><li id="kafka-api-180514002__en-us_topic_0128036927_li631972102519">Special characters `~!@#$%^&amp;*()-_=+\|[{}];:',&lt;.&gt;/?</li></ul>
</li></ul>
</td>
</tr>
<tr id="kafka-api-180514002__en-us_topic_0128036927_row731910214255"><td class="cellrowborder" valign="top" width="17.646464646464647%" headers="mcps1.3.4.4.2.5.1.1 "><p id="kafka-api-180514002__en-us_topic_0128036927_p831916242511">vpc_id</p>
</td>
<td class="cellrowborder" valign="top" width="12.727272727272728%" headers="mcps1.3.4.4.2.5.1.2 "><p id="kafka-api-180514002__en-us_topic_0128036927_p3319622255">String</p>
</td>
<td class="cellrowborder" valign="top" width="11.04040404040404%" headers="mcps1.3.4.4.2.5.1.3 "><p id="kafka-api-180514002__en-us_topic_0128036927_p1231912132515">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="58.58585858585859%" headers="mcps1.3.4.4.2.5.1.4 "><p id="kafka-api-180514002__p1714261924017">Indicates the VPC ID.</p>
<p id="kafka-api-180514002__p16517143816118">Obtain the value by using either of the following methods:</p>
<ul id="kafka-api-180514002__ul887913435377"><li id="kafka-api-180514002__li1288004343711">Method 1: Log in to VPC console and view the VPC ID in the VPC details.</li><li id="kafka-api-180514002__li1632175415209">Method 2: Call the API for querying VPCs. For details, see the "Querying VPCs" section in the <em id="kafka-api-180514002__i9973174242116">Virtual Private Cloud API Reference</em>.</li></ul>
</td>
</tr>
<tr id="kafka-api-180514002__en-us_topic_0128036927_row031922182516"><td class="cellrowborder" valign="top" width="17.646464646464647%" headers="mcps1.3.4.4.2.5.1.1 "><p id="kafka-api-180514002__en-us_topic_0128036927_p431917292516">security_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="12.727272727272728%" headers="mcps1.3.4.4.2.5.1.2 "><p id="kafka-api-180514002__en-us_topic_0128036927_p83199202517">String</p>
</td>
<td class="cellrowborder" valign="top" width="11.04040404040404%" headers="mcps1.3.4.4.2.5.1.3 "><p id="kafka-api-180514002__en-us_topic_0128036927_p183197222511">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="58.58585858585859%" headers="mcps1.3.4.4.2.5.1.4 "><p id="kafka-api-180514002__p8364103564013">Indicates the security group which the instance belongs to.</p>
<p id="kafka-api-180514002__p1012535151112">Obtain the value by using either of the following methods:</p>
<ul id="kafka-api-180514002__ul1822354122210"><li id="kafka-api-180514002__li11469181022217">Method 1: Log in to VPC console. Choose <strong id="kafka-api-180514002__b15871172224">Access Control</strong> &gt; <strong id="kafka-api-180514002__b1988717182213">Security Groups</strong> in the navigation pane on the left. On the displayed page, click the target security group. You can view the security group ID on the displayed page.</li><li id="kafka-api-180514002__li1044377172219">Method 2: Call the API for querying security groups. For details, see the "Querying Security Groups" section in the <em id="kafka-api-180514002__i6643533192216">Virtual Private Cloud API Reference</em>.</li></ul>
</td>
</tr>
<tr id="kafka-api-180514002__en-us_topic_0128036927_row1931982172516"><td class="cellrowborder" valign="top" width="17.646464646464647%" headers="mcps1.3.4.4.2.5.1.1 "><p id="kafka-api-180514002__en-us_topic_0128036927_p1231917222510">subnet_id</p>
</td>
<td class="cellrowborder" valign="top" width="12.727272727272728%" headers="mcps1.3.4.4.2.5.1.2 "><p id="kafka-api-180514002__en-us_topic_0128036927_p1831915262513">String</p>
</td>
<td class="cellrowborder" valign="top" width="11.04040404040404%" headers="mcps1.3.4.4.2.5.1.3 "><p id="kafka-api-180514002__en-us_topic_0128036927_p1631919282520">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="58.58585858585859%" headers="mcps1.3.4.4.2.5.1.4 "><p id="kafka-api-180514002__p6957182201210">Indicates the subnet ID.</p>
<p id="kafka-api-180514002__p394819577568">Obtain the value by using either of the following methods:</p>
<ul id="kafka-api-180514002__ul54643814416"><li id="kafka-api-180514002__li104641887440">Method 1: Log in to VPC console and click the target subnet on the <strong id="kafka-api-180514002__b8357154710228">Subnets</strong> tab page. You can view the network ID on the displayed page.</li><li id="kafka-api-180514002__li769655192312">Method 2: Call the API for querying subnets. For details, see the "Querying Subnets" section in the <em id="kafka-api-180514002__i19588195118221">Virtual Private Cloud API Reference</em>.</li></ul>
</td>
</tr>
<tr id="kafka-api-180514002__en-us_topic_0128036927_row1431910222512"><td class="cellrowborder" valign="top" width="17.646464646464647%" headers="mcps1.3.4.4.2.5.1.1 "><p id="kafka-api-180514002__en-us_topic_0128036927_p1231982132511">available_zones</p>
</td>
<td class="cellrowborder" valign="top" width="12.727272727272728%" headers="mcps1.3.4.4.2.5.1.2 "><p id="kafka-api-180514002__en-us_topic_0128036927_p03199262517">Array</p>
</td>
<td class="cellrowborder" valign="top" width="11.04040404040404%" headers="mcps1.3.4.4.2.5.1.3 "><p id="kafka-api-180514002__en-us_topic_0128036927_p183191216254">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="58.58585858585859%" headers="mcps1.3.4.4.2.5.1.4 "><p id="kafka-api-180514002__en-us_topic_0128036927_p631942102511">Indicates the ID of the AZ where brokers reside and which has available resources. The parameter value cannot be an empty array or an empty array. For details on how to obtain the value, see <a href="kafka-api-180514008.html">Querying AZ Information</a>. Check whether the AZ has available resources.</p>
<p id="kafka-api-180514002__p112500322177">When creating a Kafka instance, you can select either 1 AZ or at least 3 AZ. When specifying AZs for brokers, use commas (,) to separate multiple AZs. Example parameter settings:</p>
<ul id="kafka-api-180514002__ul156363195227"><li id="kafka-api-180514002__li16636201912218">One AZ: "available_zones": [ "a0865121f83b41cbafce65930a22a6e8" ]</li><li id="kafka-api-180514002__li915414817236">Three or more AZs: "available_zones": ["a0865121f83b41cbafce65930a22a6e8","a0865121f83b41cbafce65930a22a6e7","a0865121f83b41cbafce65930a22a6e6"]</li></ul>
</td>
</tr>
<tr id="kafka-api-180514002__en-us_topic_0128036927_row63199272514"><td class="cellrowborder" valign="top" width="17.646464646464647%" headers="mcps1.3.4.4.2.5.1.1 "><p id="kafka-api-180514002__en-us_topic_0128036927_p11320172102520">product_id</p>
</td>
<td class="cellrowborder" valign="top" width="12.727272727272728%" headers="mcps1.3.4.4.2.5.1.2 "><p id="kafka-api-180514002__en-us_topic_0128036927_p332010252511">String</p>
</td>
<td class="cellrowborder" valign="top" width="11.04040404040404%" headers="mcps1.3.4.4.2.5.1.3 "><p id="kafka-api-180514002__en-us_topic_0128036927_p15320524252">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="58.58585858585859%" headers="mcps1.3.4.4.2.5.1.4 "><p id="kafka-api-180514002__en-us_topic_0128036927_p3320112182519">Indicates the product ID.</p>
<p id="kafka-api-180514002__en-us_topic_0128036927_p1212317503242">For details on how to obtain the ID, see <a href="kafka-api-180514009.html">Querying Product Specifications</a>.</p>
</td>
</tr>
<tr id="kafka-api-180514002__en-us_topic_0128036927_row113201727258"><td class="cellrowborder" valign="top" width="17.646464646464647%" headers="mcps1.3.4.4.2.5.1.1 "><p id="kafka-api-180514002__en-us_topic_0128036927_p13320112132514">maintain_begin</p>
</td>
<td class="cellrowborder" valign="top" width="12.727272727272728%" headers="mcps1.3.4.4.2.5.1.2 "><p id="kafka-api-180514002__en-us_topic_0128036927_p113203216259">String</p>
</td>
<td class="cellrowborder" valign="top" width="11.04040404040404%" headers="mcps1.3.4.4.2.5.1.3 "><p id="kafka-api-180514002__en-us_topic_0128036927_p18320126252">No</p>
</td>
<td class="cellrowborder" valign="top" width="58.58585858585859%" headers="mcps1.3.4.4.2.5.1.4 "><p id="kafka-api-180514002__en-us_topic_0128036927_p158729311259">Indicates the time at which a maintenance time window starts.</p>
<p id="kafka-api-180514002__en-us_topic_0128036927_p210962614258">Format: HH:mm:ss</p>
<ul id="kafka-api-180514002__en-us_topic_0128036927_ul1232022112510"><li id="kafka-api-180514002__en-us_topic_0128036927_li73201624255">The start time and end time of the maintenance time window must indicate the time segment of a supported maintenance time window. For details about how to query the time segments of supported maintenance time windows, see <a href="kafka-api-180514010.html">Querying Maintenance Time Windows</a>.</li><li id="kafka-api-180514002__en-us_topic_0128036927_li7320226253">The start time must be set to 22:00:00, 02:00:00, 06:00:00, 10:00:00, 14:00:00, or 18:00:00.</li><li id="kafka-api-180514002__en-us_topic_0128036927_li17320126251">Parameters <strong id="kafka-api-180514002__en-us_topic_0128036927_b5780519142014">maintain_begin</strong> and <strong id="kafka-api-180514002__en-us_topic_0128036927_b87804192205">maintain_end</strong> must be set in pairs. If parameter <strong id="kafka-api-180514002__en-us_topic_0128036927_b2780151913205">maintain_begin</strong> is left blank, parameter <strong id="kafka-api-180514002__en-us_topic_0128036927_b19780171942014">maintain_end</strong> is also left blank. In this case, the system automatically sets the start time to 02:00:00.</li></ul>
</td>
</tr>
<tr id="kafka-api-180514002__en-us_topic_0128036927_row63208292516"><td class="cellrowborder" valign="top" width="17.646464646464647%" headers="mcps1.3.4.4.2.5.1.1 "><p id="kafka-api-180514002__en-us_topic_0128036927_p153201826257">maintain_end</p>
</td>
<td class="cellrowborder" valign="top" width="12.727272727272728%" headers="mcps1.3.4.4.2.5.1.2 "><p id="kafka-api-180514002__en-us_topic_0128036927_p1132019212257">String</p>
</td>
<td class="cellrowborder" valign="top" width="11.04040404040404%" headers="mcps1.3.4.4.2.5.1.3 "><p id="kafka-api-180514002__en-us_topic_0128036927_p9320722251">No</p>
</td>
<td class="cellrowborder" valign="top" width="58.58585858585859%" headers="mcps1.3.4.4.2.5.1.4 "><p id="kafka-api-180514002__en-us_topic_0128036927_p228514511165">Indicates the time at which a maintenance time window ends.</p>
<p id="kafka-api-180514002__en-us_topic_0128036927_p185352485619">Format: HH:mm:ss</p>
<ul id="kafka-api-180514002__en-us_topic_0128036927_ul1432013292512"><li id="kafka-api-180514002__en-us_topic_0128036927_li9320102202516">The start time and end time of the maintenance time window must indicate the time segment of a supported maintenance time window. For details about how to query the time segments of supported maintenance time windows, see <a href="kafka-api-180514010.html">Querying Maintenance Time Windows</a>.</li><li id="kafka-api-180514002__en-us_topic_0128036927_li15320162142510">The end time is four hours later than the start time. For example, if the start time is 22:00:00, the end time is 02:00:00.</li><li id="kafka-api-180514002__en-us_topic_0128036927_li1032032132518">Parameters <strong id="kafka-api-180514002__b344214714019">maintain_begin</strong> and <strong id="kafka-api-180514002__b74423479016">maintain_end</strong> must be set in pairs. If parameter <strong id="kafka-api-180514002__b24421047804">maintain_end</strong> is left blank, parameter <strong id="kafka-api-180514002__b9442547501">maintain_start</strong> is also blank. In this case, the system automatically sets the end time to 06:00:00.</li></ul>
</td>
</tr>
<tr id="kafka-api-180514002__en-us_topic_0128036927_row974782874210"><td class="cellrowborder" valign="top" width="17.646464646464647%" headers="mcps1.3.4.4.2.5.1.1 "><p id="kafka-api-180514002__en-us_topic_0128036927_p94625574217">enable_publicip</p>
</td>
<td class="cellrowborder" valign="top" width="12.727272727272728%" headers="mcps1.3.4.4.2.5.1.2 "><p id="kafka-api-180514002__en-us_topic_0128036927_p646205584211">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="11.04040404040404%" headers="mcps1.3.4.4.2.5.1.3 "><p id="kafka-api-180514002__en-us_topic_0128036927_p15465558422">No</p>
</td>
<td class="cellrowborder" valign="top" width="58.58585858585859%" headers="mcps1.3.4.4.2.5.1.4 "><p id="kafka-api-180514002__en-us_topic_0128036927_p184635511420">Indicates whether to enable public access for an instance.</p>
<ul id="kafka-api-180514002__en-us_topic_0128036927_ul2046195510424"><li id="kafka-api-180514002__en-us_topic_0128036927_li10461855134216"><strong id="kafka-api-180514002__en-us_topic_0128036927_b1557109112915">true</strong>: enable</li><li id="kafka-api-180514002__en-us_topic_0128036927_li14481855104220"><strong id="kafka-api-180514002__en-us_topic_0128036927_b1197219556363">false</strong>: disable</li></ul>
</td>
</tr>
<tr id="kafka-api-180514002__row135402781911"><td class="cellrowborder" valign="top" width="17.646464646464647%" headers="mcps1.3.4.4.2.5.1.1 "><p id="kafka-api-180514002__p18041538929">public_bandwidth</p>
</td>
<td class="cellrowborder" valign="top" width="12.727272727272728%" headers="mcps1.3.4.4.2.5.1.2 "><p id="kafka-api-180514002__p1804938427">String</p>
</td>
<td class="cellrowborder" valign="top" width="11.04040404040404%" headers="mcps1.3.4.4.2.5.1.3 "><p id="kafka-api-180514002__p9804638323">No</p>
</td>
<td class="cellrowborder" valign="top" width="58.58585858585859%" headers="mcps1.3.4.4.2.5.1.4 "><p id="kafka-api-180514002__p0804738628">Indicates the public network bandwidth. Unit: Mbit/s</p>
<p id="kafka-api-180514002__p119215503542">Value range:</p>
<ul id="kafka-api-180514002__ul242634414559"><li id="kafka-api-180514002__li1042744455514">When <strong id="kafka-api-180514002__b738119541712">specification</strong> is <strong id="kafka-api-180514002__b1386554515">100MB</strong>, the value must be a multiple of the number of brokers and fall in the range from 3 to 900.</li><li id="kafka-api-180514002__li15427344155517">When <strong id="kafka-api-180514002__b1772518425412">specification</strong> is <strong id="kafka-api-180514002__b17726124211418">300MB</strong>, the value must be a multiple of the number of brokers and fall in the range from 3 to 900.</li><li id="kafka-api-180514002__li5427144475516">When <strong id="kafka-api-180514002__b113112593413">specification</strong> is <strong id="kafka-api-180514002__b13117590411">600MB</strong>, the value must be a multiple of the number of brokers and fall in the range from 4 to 1200.</li><li id="kafka-api-180514002__li64271344175516">When <strong id="kafka-api-180514002__b1136622184217">specification</strong> is <strong id="kafka-api-180514002__b436714214428">1200MB</strong>, the value must be a multiple of the number of brokers and fall in the range from 8 to 2400.</li></ul>
</td>
</tr>
<tr id="kafka-api-180514002__en-us_topic_0128036927_row8185632194217"><td class="cellrowborder" valign="top" width="17.646464646464647%" headers="mcps1.3.4.4.2.5.1.1 "><p id="kafka-api-180514002__en-us_topic_0128036927_p154835519428">publicip_id</p>
</td>
<td class="cellrowborder" valign="top" width="12.727272727272728%" headers="mcps1.3.4.4.2.5.1.2 "><p id="kafka-api-180514002__en-us_topic_0128036927_p154895544211">String</p>
</td>
<td class="cellrowborder" valign="top" width="11.04040404040404%" headers="mcps1.3.4.4.2.5.1.3 "><p id="kafka-api-180514002__en-us_topic_0128036927_p1548105517423">No</p>
</td>
<td class="cellrowborder" valign="top" width="58.58585858585859%" headers="mcps1.3.4.4.2.5.1.4 "><p id="kafka-api-180514002__en-us_topic_0128036927_p648355194215">Indicates the ID of the elastic IP address (EIP) bound to an instance.</p>
<p id="kafka-api-180514002__p13733924125013">Use commas (,) to separate multiple EIP IDs.</p>
<p id="kafka-api-180514002__en-us_topic_0128036927_p1148175516425">This parameter is mandatory if public access is enabled (that is, <strong id="kafka-api-180514002__en-us_topic_0128036927_b1461419415386">enable_publicip</strong> is set to <strong id="kafka-api-180514002__en-us_topic_0128036927_b661420412381">true</strong>).</p>
</td>
</tr>
<tr id="kafka-api-180514002__en-us_topic_0128036927_row144581138461"><td class="cellrowborder" valign="top" width="17.646464646464647%" headers="mcps1.3.4.4.2.5.1.1 "><p id="kafka-api-180514002__en-us_topic_0128036927_p144588354614">ssl_enable</p>
</td>
<td class="cellrowborder" valign="top" width="12.727272727272728%" headers="mcps1.3.4.4.2.5.1.2 "><p id="kafka-api-180514002__en-us_topic_0128036927_p9458836469">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="11.04040404040404%" headers="mcps1.3.4.4.2.5.1.3 "><p id="kafka-api-180514002__en-us_topic_0128036927_p7458163154618">No</p>
</td>
<td class="cellrowborder" valign="top" width="58.58585858585859%" headers="mcps1.3.4.4.2.5.1.4 "><p id="kafka-api-180514002__en-us_topic_0128036927_p112877535115">Indicates whether to enable SSL-encrypted access.</p>
<ul id="kafka-api-180514002__en-us_topic_0128036927_ul14751113025120"><li id="kafka-api-180514002__en-us_topic_0128036927_li14751163025110"><strong id="kafka-api-180514002__en-us_topic_0128036927_b17898101144611">true</strong>: enable</li><li id="kafka-api-180514002__en-us_topic_0128036927_li137511630165111"><strong id="kafka-api-180514002__en-us_topic_0128036927_b173041581467">false</strong>: disable</li></ul>
</td>
</tr>
<tr id="kafka-api-180514002__row252820711567"><td class="cellrowborder" valign="top" width="17.646464646464647%" headers="mcps1.3.4.4.2.5.1.1 "><p id="kafka-api-180514002__p196931255164113">retention_policy</p>
</td>
<td class="cellrowborder" valign="top" width="12.727272727272728%" headers="mcps1.3.4.4.2.5.1.2 "><p id="kafka-api-180514002__p86911755144111">String</p>
</td>
<td class="cellrowborder" valign="top" width="11.04040404040404%" headers="mcps1.3.4.4.2.5.1.3 "><p id="kafka-api-180514002__p468915555417">No</p>
</td>
<td class="cellrowborder" valign="top" width="58.58585858585859%" headers="mcps1.3.4.4.2.5.1.4 "><p id="kafka-api-180514002__p10687115513410">Indicates the action to be taken when the memory usage reaches the disk capacity threshold. Options:</p>
<ul id="kafka-api-180514002__ul4251160181310"><li id="kafka-api-180514002__li225112061311"><strong id="kafka-api-180514002__b1675374454417">time_base</strong>: Automatically delete the earliest messages.</li><li id="kafka-api-180514002__li725170101310"><strong id="kafka-api-180514002__b1939792154520">produce_reject</strong>: Stop producing new messages.</li></ul>
</td>
</tr>
<tr id="kafka-api-180514002__row3161828103"><td class="cellrowborder" valign="top" width="17.646464646464647%" headers="mcps1.3.4.4.2.5.1.1 "><p id="kafka-api-180514002__p61715211018">enable_auto_topic</p>
</td>
<td class="cellrowborder" valign="top" width="12.727272727272728%" headers="mcps1.3.4.4.2.5.1.2 "><p id="kafka-api-180514002__p1341910199101">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="11.04040404040404%" headers="mcps1.3.4.4.2.5.1.3 "><p id="kafka-api-180514002__p541971916107">No</p>
</td>
<td class="cellrowborder" valign="top" width="58.58585858585859%" headers="mcps1.3.4.4.2.5.1.4 "><p id="kafka-api-180514002__p1698172714106">Indicates whether to enable automatic topic creation.</p>
<ul id="kafka-api-180514002__ul898192741010"><li id="kafka-api-180514002__li8981132718104"><strong id="kafka-api-180514002__en-us_topic_0128036934_b862519318216">true</strong>: enable</li><li id="kafka-api-180514002__li394923320104"><strong id="kafka-api-180514002__b14331186194111">false</strong>: disable</li></ul>
<p id="kafka-api-180514002__p1740120571105">If automatic topic creation is enabled, a topic will be automatically created with 3 partitions and 3 replicas when a message is produced to or consumed from a topic that does not exist.</p>
</td>
</tr>
<tr id="kafka-api-180514002__en-us_topic_0128036927_row18127782467"><td class="cellrowborder" valign="top" width="17.646464646464647%" headers="mcps1.3.4.4.2.5.1.1 "><p id="kafka-api-180514002__en-us_topic_0128036927_p1755018195211">storage_spec_code</p>
</td>
<td class="cellrowborder" valign="top" width="12.727272727272728%" headers="mcps1.3.4.4.2.5.1.2 "><p id="kafka-api-180514002__en-us_topic_0128036927_p1655061105213">String</p>
</td>
<td class="cellrowborder" valign="top" width="11.04040404040404%" headers="mcps1.3.4.4.2.5.1.3 "><p id="kafka-api-180514002__en-us_topic_0128036927_p555119119524">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="58.58585858585859%" headers="mcps1.3.4.4.2.5.1.4 "><p id="kafka-api-180514002__en-us_topic_0128036927_p155101195211">Indicates storage I/O specification. </p>
<p id="kafka-api-180514002__en-us_topic_0128036927_p520913465314">Options:</p>
<ul id="kafka-api-180514002__en-us_topic_0128036927_ul15391953193214"><li id="kafka-api-180514002__li36758533493"><strong id="kafka-api-180514002__b164109217527">dms.physical.storage.high</strong> or <strong id="kafka-api-180514002__b18413152135214">dms.physical.storage.ultra</strong> when the parameter <strong id="kafka-api-180514002__b10414102105211">specification</strong> is <strong id="kafka-api-180514002__b19414726522">100MB</strong></li><li id="kafka-api-180514002__en-us_topic_0128036927_li1553955317320"><strong id="kafka-api-180514002__b1182493825214">dms.physical.storage.high</strong> or <strong id="kafka-api-180514002__b158251238155216">dms.physical.storage.ultra</strong> when the parameter <strong id="kafka-api-180514002__b1582693875211">specification</strong> is <strong id="kafka-api-180514002__b58273385528">300MB</strong></li><li id="kafka-api-180514002__en-us_topic_0128036927_li1653985373215"><strong id="kafka-api-180514002__b7204114725217">dms.physical.storage.ultra</strong> when the parameter <strong id="kafka-api-180514002__b1320584735220">specification</strong> is <strong id="kafka-api-180514002__b420594745218">600MB</strong></li><li id="kafka-api-180514002__en-us_topic_0128036927_li25399532328"><strong id="kafka-api-180514002__b2651854105216">dms.physical.storage.ultra</strong> when the parameter <strong id="kafka-api-180514002__b5660545527">specification</strong> is <strong id="kafka-api-180514002__b1566185495214">1200MB</strong></li></ul>
</td>
</tr>
<tr id="kafka-api-180514002__en-us_topic_0128036927_row26671346154919"><td class="cellrowborder" valign="top" width="17.646464646464647%" headers="mcps1.3.4.4.2.5.1.1 "><p id="kafka-api-180514002__en-us_topic_0128036927_p1448315481491">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="12.727272727272728%" headers="mcps1.3.4.4.2.5.1.2 "><p id="kafka-api-180514002__en-us_topic_0128036927_p1483348154918">String</p>
</td>
<td class="cellrowborder" valign="top" width="11.04040404040404%" headers="mcps1.3.4.4.2.5.1.3 "><p id="kafka-api-180514002__en-us_topic_0128036927_p174842048154917">No</p>
</td>
<td class="cellrowborder" valign="top" width="58.58585858585859%" headers="mcps1.3.4.4.2.5.1.4 "><p id="kafka-api-180514002__en-us_topic_0128036927_p8484174824920">Indicates the enterprise project ID.</p>
</td>
</tr>
<tr id="kafka-api-180514002__row1878124911113"><td class="cellrowborder" valign="top" width="17.646464646464647%" headers="mcps1.3.4.4.2.5.1.1 "><p id="kafka-api-180514002__p188131615507">tags</p>
</td>
<td class="cellrowborder" valign="top" width="12.727272727272728%" headers="mcps1.3.4.4.2.5.1.2 "><p id="kafka-api-180514002__p88131268506">Array&lt;Object&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="11.04040404040404%" headers="mcps1.3.4.4.2.5.1.3 "><p id="kafka-api-180514002__p158131267507">No</p>
</td>
<td class="cellrowborder" valign="top" width="58.58585858585859%" headers="mcps1.3.4.4.2.5.1.4 "><p id="kafka-api-180514002__p178131768500">Indicates the list of tags.</p>
</td>
</tr>
<tr id="kafka-api-180514002__row9634173503212"><td class="cellrowborder" valign="top" width="17.646464646464647%" headers="mcps1.3.4.4.2.5.1.1 "><p id="kafka-api-180514002__p888211842418">disk_encrypted_enable</p>
</td>
<td class="cellrowborder" valign="top" width="12.727272727272728%" headers="mcps1.3.4.4.2.5.1.2 "><p id="kafka-api-180514002__p188261802412">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="11.04040404040404%" headers="mcps1.3.4.4.2.5.1.3 "><p id="kafka-api-180514002__p888291892419">No</p>
</td>
<td class="cellrowborder" valign="top" width="58.58585858585859%" headers="mcps1.3.4.4.2.5.1.4 "><p id="kafka-api-180514002__p1288271892411">Indicates whether to enable disk encryption.</p>
<ul id="kafka-api-180514002__ul4696735152619"><li id="kafka-api-180514002__li15696103518261"><strong id="kafka-api-180514002__b5330823132611">true</strong>: enable</li><li id="kafka-api-180514002__li32221345182613"><strong id="kafka-api-180514002__b20332141472711">false</strong>: disable</li></ul>
</td>
</tr>
<tr id="kafka-api-180514002__row6657145153216"><td class="cellrowborder" valign="top" width="17.646464646464647%" headers="mcps1.3.4.4.2.5.1.1 "><p id="kafka-api-180514002__p1580332114243">disk_encrypted_key</p>
</td>
<td class="cellrowborder" valign="top" width="12.727272727272728%" headers="mcps1.3.4.4.2.5.1.2 "><p id="kafka-api-180514002__p11803192182414">String</p>
</td>
<td class="cellrowborder" valign="top" width="11.04040404040404%" headers="mcps1.3.4.4.2.5.1.3 "><p id="kafka-api-180514002__p13803162115249">No</p>
</td>
<td class="cellrowborder" valign="top" width="58.58585858585859%" headers="mcps1.3.4.4.2.5.1.4 "><p id="kafka-api-180514002__p1980315218241">Indicates the ID of the KMS key if disk encryption is enabled.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="kafka-api-180514002__request_tags" frame="border" border="1" rules="all"><caption><b>Table 3 </b>tags</caption><thead align="left"><tr id="kafka-api-180514002__row73331247502"><th align="left" class="cellrowborder" valign="top" width="17.38826117388261%" id="mcps1.3.4.5.2.5.1.1"><p id="kafka-api-180514002__p38141469506">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.878812118788122%" id="mcps1.3.4.5.2.5.1.2"><p id="kafka-api-180514002__p681419655016">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.028797120287972%" id="mcps1.3.4.5.2.5.1.3"><p id="kafka-api-180514002__p6391929637">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="58.70412958704129%" id="mcps1.3.4.5.2.5.1.4"><p id="kafka-api-180514002__p1381410635017">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="kafka-api-180514002__row1633311413501"><td class="cellrowborder" valign="top" width="17.38826117388261%" headers="mcps1.3.4.5.2.5.1.1 "><p id="kafka-api-180514002__p1081417695019">key</p>
</td>
<td class="cellrowborder" valign="top" width="11.878812118788122%" headers="mcps1.3.4.5.2.5.1.2 "><p id="kafka-api-180514002__p18814126115019">String</p>
</td>
<td class="cellrowborder" valign="top" width="12.028797120287972%" headers="mcps1.3.4.5.2.5.1.3 "><p id="kafka-api-180514002__p13932915311">No</p>
</td>
<td class="cellrowborder" valign="top" width="58.70412958704129%" headers="mcps1.3.4.5.2.5.1.4 "><p id="kafka-api-180514002__p168141360503">Indicates the tag key. A tag key can contain a maximum of 36 Unicode characters.</p>
<p id="kafka-api-180514002__p3814063502">The key cannot be left blank or be an empty string.</p>
<p id="kafka-api-180514002__p88156614509">It cannot contain nonprintable ASCII (0–31) characters and the following special characters: =*&lt;&gt;\,|/</p>
</td>
</tr>
<tr id="kafka-api-180514002__row163330435013"><td class="cellrowborder" valign="top" width="17.38826117388261%" headers="mcps1.3.4.5.2.5.1.1 "><p id="kafka-api-180514002__p158159675017">value</p>
</td>
<td class="cellrowborder" valign="top" width="11.878812118788122%" headers="mcps1.3.4.5.2.5.1.2 "><p id="kafka-api-180514002__p4815146145012">String</p>
</td>
<td class="cellrowborder" valign="top" width="12.028797120287972%" headers="mcps1.3.4.5.2.5.1.3 "><p id="kafka-api-180514002__p539529235">No</p>
</td>
<td class="cellrowborder" valign="top" width="58.70412958704129%" headers="mcps1.3.4.5.2.5.1.4 "><p id="kafka-api-180514002__p15815069508">Indicates the value. A tag value can contain a maximum of 43 Unicode characters.</p>
<p id="kafka-api-180514002__p10815860508">The value cannot be left blank or be an empty string.</p>
<p id="kafka-api-180514002__p168152613508">It cannot contain nonprintable ASCII (0–31) characters and the following special characters: =*&lt;&gt;\,|/</p>
</td>
</tr>
</tbody>
</table>
</div>
<pre class="screen" id="kafka-api-180514002__screen134142123413">POST https://{dms_endpoint}/v1.0/{project_id}/instances
{
"name": "kafka-test",
"description": "",
"engine": "kafka",
"engine_version": "2.3.0",
"storage_space": 600,
"access_user": "",
"password": "",
"vpc_id": "1e93f86e-13af-46c8-97d6-d40fa62b76c2",
"security_group_id": "0aaa0033-bf7f-4c41-a6c2-18cd04cad2c8",
"subnet_id": "b5fa806c-35e7-4299-b659-b39398dd4718",
"available_zones": ["d5731xxxb44b0"],
"product_id": "00300-30308-0--0",
"maintain_begin": "22:00",
"maintain_end": "02:00",
"ssl_enable": false,
"enable_publicip": false,
"publicip_id": "",
"specification": "100MB",
"partition_num": "300",
"retention_policy": "produce_reject",
"storage_spec_code": "dms.physical.storage.ultra"
}</pre>
</div>
<div class="section" id="kafka-api-180514002__en-us_topic_0128036927_section2013012202516"><h4 class="sectiontitle">Response</h4><p id="kafka-api-180514002__en-us_topic_0128036927_p032282162519"><strong id="kafka-api-180514002__en-us_topic_0128036927_b864062334410">Response parameters</strong></p>
<p id="kafka-api-180514002__en-us_topic_0128036927_p173223212253"><a href="#kafka-api-180514002__en-us_topic_0128036927_table91311217255">Table 4</a> describes the parameters.</p>
<div class="tablenoborder"><a name="kafka-api-180514002__en-us_topic_0128036927_table91311217255"></a><a name="en-us_topic_0128036927_table91311217255"></a><table cellpadding="4" cellspacing="0" summary="" id="kafka-api-180514002__en-us_topic_0128036927_table91311217255" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response parameters</caption><thead align="left"><tr id="kafka-api-180514002__en-us_topic_0128036927_row1322192152515"><th align="left" class="cellrowborder" valign="top" width="20.200000000000003%" id="mcps1.3.5.4.2.4.1.1"><p id="kafka-api-180514002__en-us_topic_0128036927_p173221426253">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="23.23%" id="mcps1.3.5.4.2.4.1.2"><p id="kafka-api-180514002__en-us_topic_0128036927_p43221521257">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.57%" id="mcps1.3.5.4.2.4.1.3"><p id="kafka-api-180514002__en-us_topic_0128036927_p832217252514">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="kafka-api-180514002__en-us_topic_0128036927_row10322023257"><td class="cellrowborder" valign="top" width="20.200000000000003%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514002__en-us_topic_0128036927_p832216282518">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514002__en-us_topic_0128036927_p332211219258">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.57%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514002__en-us_topic_0128036927_p123221228259">Indicates the instance ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="kafka-api-180514002__en-us_topic_0128036927_p23228212254"><strong id="kafka-api-180514002__en-us_topic_0128036927_b1051515644415">Example response</strong></p>
<pre class="screen" id="kafka-api-180514002__en-us_topic_0128036927_screen532219282517">{
"instance_id": "8959ab1c-7n1a-yyb1-a05t-93dfc361b32d"
}</pre>
</div>
<div class="section" id="kafka-api-180514002__en-us_topic_0128036927_section1713714282512"><h4 class="sectiontitle">Status Code</h4><p id="kafka-api-180514002__en-us_topic_0128036927_p1432232132511"><a href="#kafka-api-180514002__en-us_topic_0128036927_table1813714214251">Table 5</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-180514002__en-us_topic_0128036927_table1813714214251"></a><a name="en-us_topic_0128036927_table1813714214251"></a><table cellpadding="4" cellspacing="0" summary="" id="kafka-api-180514002__en-us_topic_0128036927_table1813714214251" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Status code</caption><thead align="left"><tr id="kafka-api-180514002__en-us_topic_0128036927_row63247232520"><th align="left" class="cellrowborder" valign="top" width="15.15%" id="mcps1.3.6.3.2.3.1.1"><p id="kafka-api-180514002__en-us_topic_0128036927_p193241124250">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-180514002__en-us_topic_0128036927_p17324022258">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="kafka-api-180514002__en-us_topic_0128036927_row163247212250"><td class="cellrowborder" valign="top" width="15.15%" headers="mcps1.3.6.3.2.3.1.1 "><p id="kafka-api-180514002__en-us_topic_0128036927_p163245262519">200</p>
</td>
<td class="cellrowborder" valign="top" width="84.85000000000001%" headers="mcps1.3.6.3.2.3.1.2 "><p id="kafka-api-180514002__en-us_topic_0128036927_p103242213251">The instance 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>
View Git Blame Copy Permalink