forked from docs/doc-exports
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>
542 lines
46 KiB
HTML
542 lines
46 KiB
HTML
<a name="kafka-api-180514003"></a><a name="kafka-api-180514003"></a>
|
|
|
|
<h1 class="topictitle1">Querying an Instance</h1>
|
|
<div id="body1524661275118"><div class="note" id="kafka-api-180514003__note159644115208"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="kafka-api-180514003__p0964111132019">This API is out-of-date and may not be maintained in the future. Please use the API described in <a href="ShowInstance.html">Querying an Instance</a>.</p>
|
|
</div></div>
|
|
<div class="section" id="kafka-api-180514003__en-us_topic_0128036896_section838810374282"><h4 class="sectiontitle">Function</h4><p id="kafka-api-180514003__en-us_topic_0128036896_p8611114378">This API is used to query the details about an instance.</p>
|
|
</div>
|
|
<div class="section" id="kafka-api-180514003__en-us_topic_0128036896_section972051016372"><h4 class="sectiontitle">URI</h4><p id="kafka-api-180514003__en-us_topic_0128036896_p5613112370">GET /v1.0/{project_id}/instances/{instance_id}</p>
|
|
<p id="kafka-api-180514003__en-us_topic_0128036896_p5617113376"><a href="#kafka-api-180514003__en-us_topic_0128036896_table1372212109375">Table 1</a> describes the parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="kafka-api-180514003__en-us_topic_0128036896_table1372212109375"></a><a name="en-us_topic_0128036896_table1372212109375"></a><table cellpadding="4" cellspacing="0" summary="" id="kafka-api-180514003__en-us_topic_0128036896_table1372212109375" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters</caption><thead align="left"><tr id="kafka-api-180514003__en-us_topic_0128036896_row1061141116373"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.4.2.5.1.1"><p id="kafka-api-180514003__en-us_topic_0128036896_p1661811103718">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="23%" id="mcps1.3.3.4.2.5.1.2"><p id="kafka-api-180514003__en-us_topic_0128036896_p116110111377">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="23%" id="mcps1.3.3.4.2.5.1.3"><p id="kafka-api-180514003__en-us_topic_0128036896_p186191120375">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="28.999999999999996%" id="mcps1.3.3.4.2.5.1.4"><p id="kafka-api-180514003__en-us_topic_0128036896_p461171117376">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="kafka-api-180514003__en-us_topic_0128036896_row1061111193710"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.4.2.5.1.1 "><p id="kafka-api-180514003__en-us_topic_0128036896_p11612112379">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.3.4.2.5.1.2 "><p id="kafka-api-180514003__en-us_topic_0128036896_p11611111183714">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.3.4.2.5.1.3 "><p id="kafka-api-180514003__en-us_topic_0128036896_p661161119376">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.3.4.2.5.1.4 "><p id="kafka-api-180514003__en-us_topic_0128036896_p86111111372">Indicates the ID of a project.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514003__en-us_topic_0128036896_row96215114371"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.4.2.5.1.1 "><p id="kafka-api-180514003__en-us_topic_0128036896_p1962111123716">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.3.4.2.5.1.2 "><p id="kafka-api-180514003__en-us_topic_0128036896_p1262161120373">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.3.4.2.5.1.3 "><p id="kafka-api-180514003__en-us_topic_0128036896_p18628119374">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.3.4.2.5.1.4 "><p id="kafka-api-180514003__en-us_topic_0128036896_p1562151119375">Indicates the instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="kafka-api-180514003__en-us_topic_0128036896_section87301910123719"><h4 class="sectiontitle">Request</h4><p id="kafka-api-180514003__en-us_topic_0128036896_p2621311123718"><strong id="kafka-api-180514003__en-us_topic_0128036896_b20767321519">Request parameters</strong></p>
|
|
<p id="kafka-api-180514003__en-us_topic_0128036896_p262151112375">None.</p>
|
|
<p id="kafka-api-180514003__en-us_topic_0128036896_p13621311103716"><strong id="kafka-api-180514003__en-us_topic_0128036896_b1949785171510">Example request</strong></p>
|
|
<pre class="screen" id="kafka-api-180514003__screen8808020347">GET https://{dms_endpoint}/v1.0/{project_id}/instances/{instance_id}</pre>
|
|
</div>
|
|
<div class="section" id="kafka-api-180514003__en-us_topic_0128036896_section2073021063712"><h4 class="sectiontitle">Response</h4><p id="kafka-api-180514003__en-us_topic_0128036896_p186217113374"><strong id="kafka-api-180514003__en-us_topic_0128036896_b12826198141515">Response parameters</strong></p>
|
|
<p id="kafka-api-180514003__en-us_topic_0128036896_p17621711133711"><a href="#kafka-api-180514003__en-us_topic_0128036896_table873341011371">Table 2</a> describes the parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="kafka-api-180514003__en-us_topic_0128036896_table873341011371"></a><a name="en-us_topic_0128036896_table873341011371"></a><table cellpadding="4" cellspacing="0" summary="" id="kafka-api-180514003__en-us_topic_0128036896_table873341011371" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="kafka-api-180514003__en-us_topic_0128036896_row26210111372"><th align="left" class="cellrowborder" valign="top" width="22.009999999999998%" id="mcps1.3.5.4.2.4.1.1"><p id="kafka-api-180514003__en-us_topic_0128036896_p1762181153719">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.97%" id="mcps1.3.5.4.2.4.1.2"><p id="kafka-api-180514003__en-us_topic_0128036896_p6621911173716">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="61.019999999999996%" id="mcps1.3.5.4.2.4.1.3"><p id="kafka-api-180514003__en-us_topic_0128036896_p46221119372">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="kafka-api-180514003__en-us_topic_0128036896_row14621811193717"><td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514003__en-us_topic_0128036896_p962311183718">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.97%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514003__en-us_topic_0128036896_p2063111163713">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.019999999999996%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514003__en-us_topic_0128036896_p146361163714">Indicates the instance name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514003__en-us_topic_0128036896_row1263511203717"><td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514003__en-us_topic_0128036896_p186331123713">engine</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.97%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514003__en-us_topic_0128036896_p3631411153720">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.019999999999996%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514003__en-us_topic_0128036896_p146391143716">Indicates the message engine.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514003__en-us_topic_0128036896_row13631311143716"><td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514003__en-us_topic_0128036896_p1563131113375">engine_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.97%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514003__en-us_topic_0128036896_p9631611193713">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.019999999999996%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514003__en-us_topic_0128036896_p14635115372">Indicates the version of the message engine.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514003__en-us_topic_0128036896_row116341112371"><td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514003__en-us_topic_0128036896_p1663111113714">specification</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.97%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514003__en-us_topic_0128036896_p4631211153713">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.019999999999996%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514003__en-us_topic_0128036896_p1063171143716">Indicates the instance specification.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514003__en-us_topic_0128036896_row96331183713"><td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514003__en-us_topic_0128036896_p26321193713">storage_space</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.97%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514003__en-us_topic_0128036896_p165161133715">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.019999999999996%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514003__en-us_topic_0128036896_p6652011133720">Indicates the message storage space. Unit: GB</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514003__en-us_topic_0128036896_row68691941845"><td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514003__en-us_topic_0128036896_p1353720132417">partition_num</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.97%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514003__en-us_topic_0128036896_p115372131947">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.019999999999996%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514003__en-us_topic_0128036896_p19537813649">Indicates the total number of partitions in a Kafka instance.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514003__en-us_topic_0128036896_row565151113719"><td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514003__en-us_topic_0128036896_p26513117379">used_storage_space</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.97%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514003__en-us_topic_0128036896_p66561173718">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.019999999999996%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514003__en-us_topic_0128036896_p7651711193715">Indicates the used message storage space. Unit: GB</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514003__en-us_topic_0128036896_row1765101111375"><td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514003__en-us_topic_0128036896_p865911163713">connect_address</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.97%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514003__en-us_topic_0128036896_p7651211143711">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.019999999999996%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514003__en-us_topic_0128036896_p965161163711">Indicates the IP address of an instance.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514003__en-us_topic_0128036896_row126531110374"><td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514003__en-us_topic_0128036896_p17653119371">port</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.97%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514003__en-us_topic_0128036896_p2065911133711">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.019999999999996%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514003__en-us_topic_0128036896_p1651811113714">Indicates the port number of an instance.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514003__en-us_topic_0128036896_row1665191119374"><td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514003__en-us_topic_0128036896_p11654117371">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.97%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514003__en-us_topic_0128036896_p1065121115370">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.019999999999996%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514003__en-us_topic_0128036896_p56531112371">Indicates the status of an instance. For details, see <a href="kafka-api-180514012.html">Instance Status</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514003__en-us_topic_0128036896_row1865811163716"><td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514003__en-us_topic_0128036896_p76581193713">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.97%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514003__en-us_topic_0128036896_p76521110374">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.019999999999996%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514003__en-us_topic_0128036896_p46571116371">Indicates the instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514003__en-us_topic_0128036896_row126512117373"><td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514003__en-us_topic_0128036896_p965811133717">resource_spec_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.97%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514003__en-us_topic_0128036896_p12651911143711">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.019999999999996%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514003__en-us_topic_0128036896_p176521114379">Indicates the resource specifications identifier.</p>
|
|
<ul id="kafka-api-180514003__en-us_topic_0128036896_ul265171193719"><li id="kafka-api-180514003__li14565191843015"><strong id="kafka-api-180514003__en-us_topic_0140858141_b1492323118434">dms.instance.kafka.cluster.c3.mini</strong>: Kafka instance, 100 MB/s reference bandwidth</li><li id="kafka-api-180514003__en-us_topic_0128036896_li897421943712"><strong id="kafka-api-180514003__b46475292711">dms.instance.kafka.cluster.c3.small.2</strong>: Kafka instance, 300 MB/s reference bandwidth</li><li id="kafka-api-180514003__en-us_topic_0128036896_li83591027113718"><strong id="kafka-api-180514003__en-us_topic_0128036896_b1448713276212">dms.instance.kafka.cluster.c3.middle.2</strong>: Kafka instance, 600 MB/s reference bandwidth</li><li id="kafka-api-180514003__en-us_topic_0128036896_li159670462377"><strong id="kafka-api-180514003__en-us_topic_0128036896_b18275154872119">dms.instance.kafka.cluster.c3.high.2</strong>: Kafka instance, 1200 MB/s reference bandwidth</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514003__en-us_topic_0128036896_row965211153711"><td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514003__en-us_topic_0128036896_p136531119370">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.97%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514003__en-us_topic_0128036896_p166511133720">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.019999999999996%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514003__en-us_topic_0128036896_p20877106205912">Indicates the instance type. Value: <strong id="kafka-api-180514003__b189602913411">cluster</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514003__en-us_topic_0128036896_row15651511123717"><td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514003__en-us_topic_0128036896_p1965151113372">charging_mode</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.97%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514003__en-us_topic_0128036896_p176541116371">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.019999999999996%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514003__p564753902418">Indicates the billing mode.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514003__en-us_topic_0128036896_row10651711143716"><td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514003__en-us_topic_0128036896_p16650116370">vpc_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.97%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514003__en-us_topic_0128036896_p116591112371">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.019999999999996%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514003__en-us_topic_0128036896_p765201110375">Indicates the ID of a VPC.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514003__en-us_topic_0128036896_row16591115374"><td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514003__en-us_topic_0128036896_p1765111163717">vpc_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.97%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514003__en-us_topic_0128036896_p56651133713">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.019999999999996%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514003__en-us_topic_0128036896_p10661711183717">Indicates the name of a VPC.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514003__en-us_topic_0128036896_row176691123712"><td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514003__en-us_topic_0128036896_p196601120375">created_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.97%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514003__en-us_topic_0128036896_p1966171163712">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.019999999999996%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514003__en-us_topic_0128036896_p66601112371">Indicates the time when an instance is created. The time is in the format of timestamp, that is, the offset milliseconds from 1970-01-01 00:00:00 UTC to the specified time.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514003__en-us_topic_0128036896_row666141153720"><td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514003__en-us_topic_0128036896_p136641113711">product_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.97%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514003__en-us_topic_0128036896_p9661011193716">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.019999999999996%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514003__en-us_topic_0128036896_p66681133712">Indicates the product ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514003__en-us_topic_0128036896_row156617113372"><td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514003__en-us_topic_0128036896_p7667116373">security_group_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.97%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514003__en-us_topic_0128036896_p1566121123714">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.019999999999996%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514003__en-us_topic_0128036896_p966141113716">Indicates the security group ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514003__en-us_topic_0128036896_row866151123716"><td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514003__en-us_topic_0128036896_p96612117377">security_group_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.97%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514003__en-us_topic_0128036896_p1366211203718">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.019999999999996%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514003__en-us_topic_0128036896_p5661411163716">Indicates the security group name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514003__en-us_topic_0128036896_row196691117379"><td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514003__en-us_topic_0128036896_p2066111103711">subnet_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.97%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514003__en-us_topic_0128036896_p366811133711">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.019999999999996%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514003__en-us_topic_0128036896_p1166201143713">Indicates the subnet ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514003__row11211938133612"><td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514003__en-us_topic_0128036896_p156617118374">subnet_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.97%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514003__en-us_topic_0128036896_p17667115372">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.019999999999996%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514003__en-us_topic_0128036896_p136651112378">Indicates the subnet name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514003__row1328819411361"><td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514003__en-us_topic_0128036896_p4681911103716">subnet_cidr</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.97%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514003__en-us_topic_0128036896_p176861163710">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.019999999999996%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514003__en-us_topic_0128036896_p4683117375">Indicates the subnet CIDR block.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514003__en-us_topic_0128036896_row268211193718"><td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514003__en-us_topic_0128036896_p0683116377">available_zones</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.97%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514003__en-us_topic_0128036896_p1168121163713">Array</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.019999999999996%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514003__en-us_topic_0128036896_p668191116370">Indicates the ID of the AZ to which the instance node belongs. The AZ ID is returned.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514003__en-us_topic_0128036896_row16811163715"><td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514003__en-us_topic_0128036896_p868181183717">user_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.97%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514003__en-us_topic_0128036896_p1868171111371">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.019999999999996%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514003__en-us_topic_0128036896_p3681611203714">Indicates the user ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514003__en-us_topic_0128036896_row168201119375"><td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514003__en-us_topic_0128036896_p18681211153711">user_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.97%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514003__en-us_topic_0128036896_p76810115374">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.019999999999996%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514003__en-us_topic_0128036896_p068191123712">Indicates the username.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514003__row98201284376"><td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514003__en-us_topic_0128036896_p782331591216">access_user</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.97%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514003__en-us_topic_0128036896_p18823715171218">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.019999999999996%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514003__en-us_topic_0128036896_p1823181551214">Indicates the username of an instance.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514003__en-us_topic_0128036896_row14681011193713"><td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514003__en-us_topic_0128036896_p166811143710">maintain_begin</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.97%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514003__en-us_topic_0128036896_p1968111123712">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.019999999999996%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514003__en-us_topic_0128036896_p194001012143316">Indicates the time at which a maintenance time window starts.</p>
|
|
<p id="kafka-api-180514003__en-us_topic_0128036896_p54441822173310">Format: HH:mm:ss</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514003__en-us_topic_0128036896_row1368111163713"><td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514003__en-us_topic_0128036896_p96811114371">maintain_end</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.97%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514003__en-us_topic_0128036896_p368191133711">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.019999999999996%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514003__en-us_topic_0128036896_p513111910337">Indicates the time at which a maintenance time window ends.</p>
|
|
<p id="kafka-api-180514003__en-us_topic_0128036896_p5444112213314">Format: HH:mm:ss</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514003__en-us_topic_0128036896_row23991034134712"><td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514003__en-us_topic_0128036896_p974553544713">enable_publicip</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.97%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514003__en-us_topic_0128036896_p10745123554715">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.019999999999996%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514003__en-us_topic_0128036896_p137451135174712">Indicates whether to enable public access for an instance.</p>
|
|
<ul id="kafka-api-180514003__en-us_topic_0128036896_ul16745143518477"><li id="kafka-api-180514003__en-us_topic_0128036896_li14745133514475"><strong id="kafka-api-180514003__en-us_topic_0128036896_b4934121416322">true</strong>: enable</li><li id="kafka-api-180514003__en-us_topic_0128036896_li5745335194718"><strong id="kafka-api-180514003__en-us_topic_0128036896_b131687176320">false</strong>: disable</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514003__en-us_topic_0128036896_row19451135165"><td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514003__en-us_topic_0128036896_p71092245167">ssl_enable</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.97%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514003__en-us_topic_0128036896_p10109162471615">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.019999999999996%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514003__en-us_topic_0128036896_p71091624131614">Indicates whether to enable security authentication.</p>
|
|
<ul id="kafka-api-180514003__en-us_topic_0128036896_ul10462144102117"><li id="kafka-api-180514003__en-us_topic_0128036896_li19462247212"><strong id="kafka-api-180514003__en-us_topic_0128036896_b961581083411">true</strong>: enable</li><li id="kafka-api-180514003__en-us_topic_0128036896_li19462154152112"><strong id="kafka-api-180514003__en-us_topic_0128036896_b2492393342">false</strong>: disable</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514003__en-us_topic_0128036896_row16489155316528"><td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514003__en-us_topic_0128036896_p1448315481491">enterprise_project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.97%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514003__en-us_topic_0128036896_p1483348154918">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.019999999999996%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514003__en-us_topic_0128036896_p8484174824920">Indicates the enterprise project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514003__row1629183918619"><td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514003__p9834175713316">total_storage_space</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.97%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514003__p4834185773111">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.019999999999996%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514003__p5834105711315">Indicates the message storage space. Unit: GB</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514003__row45991771574"><td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514003__p2516175432812">storage_resource_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.97%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514003__p251415413281">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.019999999999996%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514003__p651215544286">Indicates the storage resource ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514003__row17417325710"><td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514003__p54253862613">storage_spec_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.97%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514003__p34481152265">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.019999999999996%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514003__p194481158263">Indicates the I/O specification.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514003__row12316978813"><td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514003__p63671687358">service_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.97%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514003__p163673873510">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.019999999999996%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514003__p183673810358">Indicates the service type.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514003__row173161975819"><td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514003__p12367158183514">storage_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.97%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514003__p1836818873517">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.019999999999996%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514003__p16368181357">Indicates the storage type.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514003__row298510451689"><td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514003__p3875114173517">retention_policy</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.97%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514003__p12875114133513">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.019999999999996%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514003__p887534116352">Indicates the message retention policy.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514003__row2384162517915"><td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514003__p81102403578">kafka_public_status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.97%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514003__p911034065717">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.019999999999996%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514003__p1211054020574">Indicates whether Kafka public access is enabled.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514003__row123845258916"><td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514003__p1319041114588">public_bandwidth</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.97%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514003__p1719011110583">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.019999999999996%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514003__p171907114589">Indicates the public network bandwidth.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514003__row173072715503"><td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514003__p17731142745010">public_connect_address</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.97%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514003__p3525285014">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.019999999999996%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514003__p15952165020">Indicates the instance IP address for public access. This parameter is displayed only when public access is enabled.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514003__row149858247189"><td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514003__p16784899219">enable_log_collection</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.97%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514003__p1378439929">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.019999999999996%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514003__p197851498218">Indicates whether log collection is enabled.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514003__row221115287184"><td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514003__p67851799216">cross_vpc_info</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.97%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514003__p19786997215">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.019999999999996%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514003__p1778699528">Indicates cross-VPC access information.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514003__row171113114185"><td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514003__p14787891424">ipv6_enable</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.97%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514003__p15787991629">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.019999999999996%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514003__p107872091523">Indicates whether IPv6 is enabled.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514003__row752103551811"><td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514003__p3788193217">ipv6_connect_addresses</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.97%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514003__p207881915218">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.019999999999996%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514003__p5789179826">Indicates the IPv6 connection address.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514003__row6662184520184"><td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514003__p67921691529">rest_enable</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.97%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514003__p17931791322">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.019999999999996%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514003__p1579479322">Indicates whether the Kafka REST function is enabled.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514003__row19688248141816"><td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514003__p57952914217">rest_connect_address</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.97%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514003__p8795291629">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.019999999999996%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514003__p779619917215">Indicates the Kafka REST connection address.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514003__row176121011196"><td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514003__p7412910327">trace_enable</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.97%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514003__p184131310025">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.019999999999996%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514003__p7413191010216">Indicates whether message tracing is enabled.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514003__row8484145111910"><td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514003__p114132102215">pod_connect_address</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.97%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514003__p941319102027">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.019999999999996%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514003__p74132101125">Indicates the connection address on the tenant side.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514003__row92249920196"><td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514003__p144138108210">disk_encrypted</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.97%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514003__p19413151013216">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.019999999999996%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514003__p194137101927">Indicates whether disk encryption is enabled.</p>
|
|
<ul id="kafka-api-180514003__ul69118113619"><li id="kafka-api-180514003__li79113173616"><strong id="kafka-api-180514003__b4632164811273">true</strong>: enabled</li><li id="kafka-api-180514003__li2065612715365"><strong id="kafka-api-180514003__b55151958202715">false</strong>: disabled</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514003__row18273165754313"><td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514003__p56771102443">disk_encrypted_key</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.97%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514003__p17673205274014">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.019999999999996%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514003__p126731952124016">Indicates the ID of the KMS key if disk encryption is enabled.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514003__row11456812121911"><td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514003__p12413610627">kafka_private_connect_address</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.97%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514003__p241412109212">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.019999999999996%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514003__p16414141011215">Indicates the private connection address of a Kafka instance.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514003__row743021561912"><td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514003__p10414161019214">ces_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.97%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514003__p04141210421">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.019999999999996%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514003__p44142106218">Indicates the Cloud Eye version.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514003__row20712171814194"><td class="cellrowborder" valign="top" width="22.009999999999998%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514003__p13414151019211">tags</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.97%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514003__p164141101922">Array<Object></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.019999999999996%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514003__p194148106214">Indicates the list of tags.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="kafka-api-180514003__response_tags" frame="border" border="1" rules="all"><caption><b>Table 3 </b>tags</caption><thead align="left"><tr id="kafka-api-180514003__row5810696217"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.5.2.4.1.1"><p id="kafka-api-180514003__p1841531015220">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.5.2.4.1.2"><p id="kafka-api-180514003__p841541017214">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.5.2.4.1.3"><p id="kafka-api-180514003__p104151910924">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="kafka-api-180514003__row16811292217"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514003__p12415410921">key</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514003__p14156101927">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514003__p154154102210">Indicates the tag key.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514003__row168111891725"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514003__p144151108217">value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514003__p341521015216">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514003__p144156108216">Indicates the tag value.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="kafka-api-180514003__en-us_topic_0128036896_p27041153714"><strong id="kafka-api-180514003__en-us_topic_0128036896_b19162144318369">Example response</strong></p>
|
|
<pre class="screen" id="kafka-api-180514003__screen14241727201514">{
|
|
"name": "kafka-test",
|
|
"engine": "kafka",
|
|
"port": 9093,
|
|
"status": "RUNNING",
|
|
"type": "cluster",
|
|
"specification": "100MB",
|
|
"engine_version": "2.3.0",
|
|
"connect_address": "192.168.1.239,192.168.1.126,192.168.1.176",
|
|
"instance_id": "8354dde6-8229-4ff4-844d-ab7121be9745",
|
|
"resource_spec_code": "dms.instance.kafka.cluster.c3.mini",
|
|
"charging_mode": 1,
|
|
"vpc_id": "aaa5c155-7a9a-4d92-a804-e19cadcbca63",
|
|
"vpc_name": "vpc-3a7f",
|
|
"created_at": "1572866120990",
|
|
"product_id": "00300-30308-0--0",
|
|
"security_group_id": "3283b880-2256-498c-aa70-154f08f65331",
|
|
"security_group_name": "Default_All",
|
|
"subnet_id": "598d6280-a437-4c2f-9870-a4fc80e7ba66",
|
|
"subnet_name": "subnet-3a7f",
|
|
"subnet_cidr": "192.168.1.0/24",
|
|
"available_zones": [
|
|
"xxx"
|
|
],
|
|
"user_id": "674f286936eb47f28f4fa54b130d4db9",
|
|
"user_name": "hby-cwx522020",
|
|
"access_user": "root",
|
|
"maintain_begin": "22:00:00",
|
|
"maintain_end": "02:00:00",
|
|
"storage_space": 492,
|
|
"total_storage_space": 600,
|
|
"used_storage_space": 25,
|
|
"partition_num": "300",
|
|
"enable_publicip": false,
|
|
"ssl_enable": true,
|
|
"storage_resource_id": "3d737481-04d7-4874-a04b-2b3d884eab99",
|
|
"storage_spec_code": "dms.physical.storage.ultra",
|
|
"service_type": "advanced",
|
|
"storage_type": "hec",
|
|
"retention_policy": "time_base",
|
|
"kafka_public_status": "closed",
|
|
"public_boundwidth": 0
|
|
"disk_encrypted": false
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="kafka-api-180514003__en-us_topic_0128036896_section1686212108376"><h4 class="sectiontitle">Status Code</h4><p id="kafka-api-180514003__en-us_topic_0128036896_p1370121103718"><a href="#kafka-api-180514003__en-us_topic_0128036896_table1986391010376">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-180514003__en-us_topic_0128036896_table1986391010376"></a><a name="en-us_topic_0128036896_table1986391010376"></a><table cellpadding="4" cellspacing="0" summary="" id="kafka-api-180514003__en-us_topic_0128036896_table1986391010376" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Status code</caption><thead align="left"><tr id="kafka-api-180514003__en-us_topic_0128036896_row187014114378"><th align="left" class="cellrowborder" valign="top" width="15.15%" id="mcps1.3.6.3.2.3.1.1"><p id="kafka-api-180514003__en-us_topic_0128036896_p107011115374">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-180514003__en-us_topic_0128036896_p15701311173718">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="kafka-api-180514003__en-us_topic_0128036896_row070121193718"><td class="cellrowborder" valign="top" width="15.15%" headers="mcps1.3.6.3.2.3.1.1 "><p id="kafka-api-180514003__en-us_topic_0128036896_p5721511153711">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="84.85000000000001%" headers="mcps1.3.6.3.2.3.1.2 "><p id="kafka-api-180514003__en-us_topic_0128036896_p177211163716">Specified instance 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>
|
|
|