youjiageng1/doc-exports
1
0
Fork 0
forked from laiweijian4/doc-exports
Code Pull Requests Activity
doc-exports/docs/dms/api-ref/kafka-api-180514007.html
Chen, Junjie 7f68b84da4 DMS API-REF Initial Version 
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Chen, Junjie <chenjunjie@huawei.com>
Co-committed-by: Chen, Junjie <chenjunjie@huawei.com>
2022-12-08 00:34:44 +00:00

633 lines
55 KiB
HTML
Raw Blame History

<a name="kafka-api-180514007"></a><a name="kafka-api-180514007"></a>
<h1 class="topictitle1">Querying All Instances</h1>
<div id="body1524661275118"><div class="note" id="kafka-api-180514007__note159644115208"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="kafka-api-180514007__p0964111132019">This API is out-of-date and may not be maintained in the future. Please use the API described in <a href="ListInstances.html">Listing All Instances</a>.</p>
</div></div>
<div class="section" id="kafka-api-180514007__section1834720100172"><h4 class="sectiontitle">Function</h4><p id="kafka-api-180514007__en-us_topic_0128036934_p1557112715315">This API is used to query the instances of a tenant by set conditions.</p>
</div>
<div class="section" id="kafka-api-180514007__en-us_topic_0128036934_section426522743113"><h4 class="sectiontitle">URI</h4><p id="kafka-api-180514007__en-us_topic_0128036934_p95711274317">GET /v1.0/{project_id}/instances?engine={engine}&amp;name={name}&amp;status={status}&amp;id={id}&amp;includeFailure={includeFailure}&amp;exactMatchName={exactMatchName}</p>
<p id="kafka-api-180514007__en-us_topic_0128036934_p657111279314"><a href="#kafka-api-180514007__en-us_topic_0128036934_table18266132712318">Table 1</a> describes the parameters.</p>
<div class="tablenoborder"><a name="kafka-api-180514007__en-us_topic_0128036934_table18266132712318"></a><a name="en-us_topic_0128036934_table18266132712318"></a><table cellpadding="4" cellspacing="0" summary="" id="kafka-api-180514007__en-us_topic_0128036934_table18266132712318" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters</caption><thead align="left"><tr id="kafka-api-180514007__en-us_topic_0128036934_row175711227103112"><th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.3.4.2.5.1.1"><p id="kafka-api-180514007__en-us_topic_0128036934_p1157112710315">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.3.4.2.5.1.2"><p id="kafka-api-180514007__en-us_topic_0128036934_p1457110277317">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.96%" id="mcps1.3.3.4.2.5.1.3"><p id="kafka-api-180514007__en-us_topic_0128036934_p5571827203118">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.04%" id="mcps1.3.3.4.2.5.1.4"><p id="kafka-api-180514007__en-us_topic_0128036934_p11571527103111">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="kafka-api-180514007__en-us_topic_0128036934_row185711027143116"><td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.4.2.5.1.1 "><p id="kafka-api-180514007__en-us_topic_0128036934_p135714274313">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.4.2.5.1.2 "><p id="kafka-api-180514007__en-us_topic_0128036934_p105721727173110">String</p>
</td>
<td class="cellrowborder" valign="top" width="13.96%" headers="mcps1.3.3.4.2.5.1.3 "><p id="kafka-api-180514007__en-us_topic_0128036934_p5572112714314">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="55.04%" headers="mcps1.3.3.4.2.5.1.4 "><p id="kafka-api-180514007__en-us_topic_0128036934_p15572227133118">Indicates the ID of a project.</p>
</td>
</tr>
<tr id="kafka-api-180514007__en-us_topic_0128036934_row057272713119"><td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.4.2.5.1.1 "><p id="kafka-api-180514007__en-us_topic_0128036934_p957252733119">engine</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.4.2.5.1.2 "><p id="kafka-api-180514007__en-us_topic_0128036934_p155721027133116">String</p>
</td>
<td class="cellrowborder" valign="top" width="13.96%" headers="mcps1.3.3.4.2.5.1.3 "><p id="kafka-api-180514007__en-us_topic_0128036934_p17572102733116">No</p>
</td>
<td class="cellrowborder" valign="top" width="55.04%" headers="mcps1.3.3.4.2.5.1.4 "><p id="kafka-api-180514007__en-us_topic_0128036934_p1657211274314">Indicates the message engine. Value: <strong id="kafka-api-180514007__b1379165111110">kafka</strong></p>
</td>
</tr>
<tr id="kafka-api-180514007__en-us_topic_0128036934_row457242753118"><td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.4.2.5.1.1 "><p id="kafka-api-180514007__en-us_topic_0128036934_p11572142714314">name</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.4.2.5.1.2 "><p id="kafka-api-180514007__en-us_topic_0128036934_p155721227153118">String</p>
</td>
<td class="cellrowborder" valign="top" width="13.96%" headers="mcps1.3.3.4.2.5.1.3 "><p id="kafka-api-180514007__en-us_topic_0128036934_p16572112773110">No</p>
</td>
<td class="cellrowborder" valign="top" width="55.04%" headers="mcps1.3.3.4.2.5.1.4 "><p id="kafka-api-180514007__en-us_topic_0128036934_p1057272723112">Indicates the instance name.</p>
</td>
</tr>
<tr id="kafka-api-180514007__en-us_topic_0128036934_row55721927203116"><td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.4.2.5.1.1 "><p id="kafka-api-180514007__en-us_topic_0128036934_p185721027183117">id</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.4.2.5.1.2 "><p id="kafka-api-180514007__en-us_topic_0128036934_p157222793118">String</p>
</td>
<td class="cellrowborder" valign="top" width="13.96%" headers="mcps1.3.3.4.2.5.1.3 "><p id="kafka-api-180514007__en-us_topic_0128036934_p7572182711319">No</p>
</td>
<td class="cellrowborder" valign="top" width="55.04%" headers="mcps1.3.3.4.2.5.1.4 "><p id="kafka-api-180514007__en-us_topic_0128036934_p16572192723115">Indicates the instance ID.</p>
</td>
</tr>
<tr id="kafka-api-180514007__en-us_topic_0128036934_row165721827183118"><td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.4.2.5.1.1 "><p id="kafka-api-180514007__en-us_topic_0128036934_p135721427163118">status</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.4.2.5.1.2 "><p id="kafka-api-180514007__en-us_topic_0128036934_p7572182713311">String</p>
</td>
<td class="cellrowborder" valign="top" width="13.96%" headers="mcps1.3.3.4.2.5.1.3 "><p id="kafka-api-180514007__en-us_topic_0128036934_p45721327193113">No</p>
</td>
<td class="cellrowborder" valign="top" width="55.04%" headers="mcps1.3.3.4.2.5.1.4 "><p id="kafka-api-180514007__en-us_topic_0128036934_p1557272719314">Indicates the instance status. For details, see <a href="kafka-api-180514012.html">Instance Status</a>.</p>
</td>
</tr>
<tr id="kafka-api-180514007__en-us_topic_0128036934_row125721827183111"><td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.4.2.5.1.1 "><p id="kafka-api-180514007__en-us_topic_0128036934_p1057216272319">includeFailure</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.4.2.5.1.2 "><p id="kafka-api-180514007__en-us_topic_0128036934_p155721727103111">String</p>
</td>
<td class="cellrowborder" valign="top" width="13.96%" headers="mcps1.3.3.4.2.5.1.3 "><p id="kafka-api-180514007__en-us_topic_0128036934_p6572727173119">No</p>
</td>
<td class="cellrowborder" valign="top" width="55.04%" headers="mcps1.3.3.4.2.5.1.4 "><p id="kafka-api-180514007__en-us_topic_0128036934_p1757232753115">Indicates whether to return the number of instances that fail to be created.</p>
<p id="kafka-api-180514007__en-us_topic_0128036934_p10572112716319">If the value is <strong id="kafka-api-180514007__en-us_topic_0128036934_b27991553164110">true</strong>, the number of instances that failed to be created is returned. If the value is not <strong id="kafka-api-180514007__en-us_topic_0128036934_b266184264218">true</strong>, the number is not returned.</p>
</td>
</tr>
<tr id="kafka-api-180514007__en-us_topic_0128036934_row45731827103111"><td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.4.2.5.1.1 "><p id="kafka-api-180514007__en-us_topic_0128036934_p35732027103110">exactMatchName</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.4.2.5.1.2 "><p id="kafka-api-180514007__en-us_topic_0128036934_p18573162718314">String</p>
</td>
<td class="cellrowborder" valign="top" width="13.96%" headers="mcps1.3.3.4.2.5.1.3 "><p id="kafka-api-180514007__en-us_topic_0128036934_p957392714314">No</p>
</td>
<td class="cellrowborder" valign="top" width="55.04%" headers="mcps1.3.3.4.2.5.1.4 "><p id="kafka-api-180514007__en-us_topic_0128036934_p1957372793113">Indicates whether to search for the instance that precisely matches a specified instance name.</p>
<p id="kafka-api-180514007__en-us_topic_0128036934_p195731927153115">The default value is <strong id="kafka-api-180514007__en-us_topic_0128036934_b187231814174318">false</strong>, indicating that a fuzzy search is performed based on a specified instance name. If the value is <strong id="kafka-api-180514007__en-us_topic_0128036934_b3411918436">true</strong>, the instance that precisely matches a specified instance name is queried.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="kafka-api-180514007__en-us_topic_0128036934_section9295727203111"><h4 class="sectiontitle">Request</h4><p id="kafka-api-180514007__en-us_topic_0128036934_p1557362773113"><strong id="kafka-api-180514007__en-us_topic_0128036934_b2015054714552">Request parameters</strong></p>
<p id="kafka-api-180514007__en-us_topic_0128036934_p657319276317">None.</p>
<p id="kafka-api-180514007__en-us_topic_0128036934_p10573182753114"><strong id="kafka-api-180514007__en-us_topic_0128036934_b1218117498559">Example request</strong></p>
<pre class="screen" id="kafka-api-180514007__en-us_topic_0128036934_screen1857392715312">GET https://{dms_endpoint}/v1.0/{project_id}/instances?start=1&amp;limit=10&amp;name=&amp;status=&amp;id=&amp;includeFailure=true&amp;exactMatchName=false</pre>
</div>
<div class="section" id="kafka-api-180514007__en-us_topic_0128036934_section152971327193118"><h4 class="sectiontitle">Response</h4><p id="kafka-api-180514007__en-us_topic_0128036934_p1957372763115"><strong id="kafka-api-180514007__en-us_topic_0128036934_b1632225313556">Response parameters</strong></p>
<p id="kafka-api-180514007__en-us_topic_0128036934_p857322716319"><a href="#kafka-api-180514007__en-us_topic_0128036934_table11299182793112">Table 2</a> describes the parameters.</p>
<div class="tablenoborder"><a name="kafka-api-180514007__en-us_topic_0128036934_table11299182793112"></a><a name="en-us_topic_0128036934_table11299182793112"></a><table cellpadding="4" cellspacing="0" summary="" id="kafka-api-180514007__en-us_topic_0128036934_table11299182793112" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="kafka-api-180514007__en-us_topic_0128036934_row175738277312"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.5.4.2.4.1.1"><p id="kafka-api-180514007__en-us_topic_0128036934_p10573112733113">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.5.4.2.4.1.2"><p id="kafka-api-180514007__en-us_topic_0128036934_p2057332733112">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.5.4.2.4.1.3"><p id="kafka-api-180514007__en-us_topic_0128036934_p19573102714310">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="kafka-api-180514007__en-us_topic_0128036934_row757372716315"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514007__en-us_topic_0128036934_p65734273313">instances</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514007__en-us_topic_0128036934_p12573112793110">Array</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514007__en-us_topic_0128036934_p1257372713111">Indicates instance details.</p>
</td>
</tr>
<tr id="kafka-api-180514007__en-us_topic_0128036934_row957352733119"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514007__en-us_topic_0128036934_p95732273317">instance_num</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514007__en-us_topic_0128036934_p18573327153119">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514007__en-us_topic_0128036934_p8573192718314">Indicates the number of instances.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="kafka-api-180514007__en-us_topic_0128036934_table3307172743119" frame="border" border="1" rules="all"><caption><b>Table 3 </b>instance parameter description</caption><thead align="left"><tr id="kafka-api-180514007__en-us_topic_0128036934_row6573827193112"><th align="left" class="cellrowborder" valign="top" width="21.544554455445546%" id="mcps1.3.5.5.2.4.1.1"><p id="kafka-api-180514007__en-us_topic_0128036934_p14573132793114">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.059405940594058%" id="mcps1.3.5.5.2.4.1.2"><p id="kafka-api-180514007__en-us_topic_0128036934_p957320271319">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60.396039603960396%" id="mcps1.3.5.5.2.4.1.3"><p id="kafka-api-180514007__en-us_topic_0128036934_p115731827103110">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="kafka-api-180514007__en-us_topic_0128036934_row8573112783118"><td class="cellrowborder" valign="top" width="21.544554455445546%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514007__en-us_topic_0128036934_p2057302723118">name</p>
</td>
<td class="cellrowborder" valign="top" width="18.059405940594058%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514007__en-us_topic_0128036934_p257342719317">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.396039603960396%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514007__en-us_topic_0128036934_p457317272311">Indicates the instance name.</p>
</td>
</tr>
<tr id="kafka-api-180514007__en-us_topic_0128036934_row35731727123118"><td class="cellrowborder" valign="top" width="21.544554455445546%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514007__en-us_topic_0128036934_p157311275319">engine</p>
</td>
<td class="cellrowborder" valign="top" width="18.059405940594058%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514007__en-us_topic_0128036934_p2057312273317">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.396039603960396%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514007__en-us_topic_0128036934_p15739279311">Indicates the message engine.</p>
</td>
</tr>
<tr id="kafka-api-180514007__en-us_topic_0128036934_row12573132743117"><td class="cellrowborder" valign="top" width="21.544554455445546%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514007__en-us_topic_0128036934_p185731927153114">engine_version</p>
</td>
<td class="cellrowborder" valign="top" width="18.059405940594058%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514007__en-us_topic_0128036934_p9573427123113">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.396039603960396%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514007__en-us_topic_0128036934_p145731527193113">Indicates the engine version.</p>
</td>
</tr>
<tr id="kafka-api-180514007__en-us_topic_0128036934_row2574427113112"><td class="cellrowborder" valign="top" width="21.544554455445546%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514007__en-us_topic_0128036934_p18574142773116">specification</p>
</td>
<td class="cellrowborder" valign="top" width="18.059405940594058%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514007__en-us_topic_0128036934_p1357412716318">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.396039603960396%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514007__en-us_topic_0128036934_p1063171143716">Indicates the specifications of an instance.</p>
</td>
</tr>
<tr id="kafka-api-180514007__en-us_topic_0128036934_row145742027193110"><td class="cellrowborder" valign="top" width="21.544554455445546%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514007__en-us_topic_0128036934_p18574727173116">storage_space</p>
</td>
<td class="cellrowborder" valign="top" width="18.059405940594058%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514007__en-us_topic_0128036934_p105742272312">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60.396039603960396%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514007__en-us_topic_0128036934_p057412719313">Indicates the message storage space. Unit: GB</p>
</td>
</tr>
<tr id="kafka-api-180514007__en-us_topic_0128036934_row5574727183111"><td class="cellrowborder" valign="top" width="21.544554455445546%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514007__en-us_topic_0128036934_p3574127123110">partition_num</p>
</td>
<td class="cellrowborder" valign="top" width="18.059405940594058%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514007__en-us_topic_0128036934_p2574427143110">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.396039603960396%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514007__en-us_topic_0128036934_p105757271313">Indicates the maximum number of topics in a Kafka instance.</p>
</td>
</tr>
<tr id="kafka-api-180514007__en-us_topic_0128036934_row14575192720313"><td class="cellrowborder" valign="top" width="21.544554455445546%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514007__en-us_topic_0128036934_p85751827183117">used_storage_space</p>
</td>
<td class="cellrowborder" valign="top" width="18.059405940594058%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514007__en-us_topic_0128036934_p457552743117">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60.396039603960396%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514007__en-us_topic_0128036934_p12575152718318">Indicates the used message storage space. Unit: GB</p>
</td>
</tr>
<tr id="kafka-api-180514007__en-us_topic_0128036934_row1057517277311"><td class="cellrowborder" valign="top" width="21.544554455445546%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514007__en-us_topic_0128036934_p6575202717314">connect_address</p>
</td>
<td class="cellrowborder" valign="top" width="18.059405940594058%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514007__en-us_topic_0128036934_p457511272316">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.396039603960396%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514007__en-us_topic_0128036934_p205751927133113">Indicates the IP address of an instance.</p>
</td>
</tr>
<tr id="kafka-api-180514007__en-us_topic_0128036934_row14575102713319"><td class="cellrowborder" valign="top" width="21.544554455445546%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514007__en-us_topic_0128036934_p195751727133110">port</p>
</td>
<td class="cellrowborder" valign="top" width="18.059405940594058%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514007__en-us_topic_0128036934_p45751277316">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60.396039603960396%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514007__en-us_topic_0128036934_p45751827173116">Indicates the port number of an instance.</p>
</td>
</tr>
<tr id="kafka-api-180514007__en-us_topic_0128036934_row45755277314"><td class="cellrowborder" valign="top" width="21.544554455445546%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514007__en-us_topic_0128036934_p105754278312">status</p>
</td>
<td class="cellrowborder" valign="top" width="18.059405940594058%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514007__en-us_topic_0128036934_p17575727183116">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.396039603960396%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514007__en-us_topic_0128036934_p7575627103119">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-180514007__en-us_topic_0128036934_row557522713319"><td class="cellrowborder" valign="top" width="21.544554455445546%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514007__en-us_topic_0128036934_p195757275316">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="18.059405940594058%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514007__en-us_topic_0128036934_p18575927153112">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.396039603960396%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514007__en-us_topic_0128036934_p18575182773119">Indicates the instance ID.</p>
</td>
</tr>
<tr id="kafka-api-180514007__en-us_topic_0128036934_row4575172720319"><td class="cellrowborder" valign="top" width="21.544554455445546%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514007__en-us_topic_0128036934_p1575132783113">resource_spec_code</p>
</td>
<td class="cellrowborder" valign="top" width="18.059405940594058%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514007__en-us_topic_0128036934_p2576142713314">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.396039603960396%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514007__en-us_topic_0128036934_p1957682763116">Indicates the resource specifications identifier.</p>
<ul id="kafka-api-180514007__en-us_topic_0128036934_ul265171193719"><li id="kafka-api-180514007__li479324315331"><strong id="kafka-api-180514007__b8765810848">dms.instance.kafka.cluster.c3.mini</strong>: Kafka instance, 100 MB/s reference bandwidth</li><li id="kafka-api-180514007__li897421943712"><strong id="kafka-api-180514007__b1353645310174">dms.instance.kafka.cluster.c3.small.2</strong>: Kafka instance, 300 MB/s reference bandwidth</li><li id="kafka-api-180514007__en-us_topic_0128036934_li83591027113718"><strong id="kafka-api-180514007__b10783112218287">dms.instance.kafka.cluster.c3.middle.2</strong>: Kafka instance, 600 MB reference bandwidth</li><li id="kafka-api-180514007__en-us_topic_0128036934_li159670462377"><strong id="kafka-api-180514007__b16981727122813">dms.instance.kafka.cluster.c3.high.2</strong>: Kafka instance, 1200 MB reference bandwidth</li></ul>
</td>
</tr>
<tr id="kafka-api-180514007__en-us_topic_0128036934_row5576927133111"><td class="cellrowborder" valign="top" width="21.544554455445546%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514007__en-us_topic_0128036934_p18576122703116">charging_mode</p>
</td>
<td class="cellrowborder" valign="top" width="18.059405940594058%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514007__en-us_topic_0128036934_p135761427123110">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60.396039603960396%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514007__p564753902418">Billing mode.</p>
</td>
</tr>
<tr id="kafka-api-180514007__en-us_topic_0128036934_row2576142753118"><td class="cellrowborder" valign="top" width="21.544554455445546%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514007__en-us_topic_0128036934_p1857822723111">vpc_id</p>
</td>
<td class="cellrowborder" valign="top" width="18.059405940594058%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514007__en-us_topic_0128036934_p257817271313">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.396039603960396%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514007__en-us_topic_0128036934_p3578927143113">Indicates the ID of a VPC.</p>
</td>
</tr>
<tr id="kafka-api-180514007__en-us_topic_0128036934_row757872763117"><td class="cellrowborder" valign="top" width="21.544554455445546%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514007__en-us_topic_0128036934_p14578627133114">vpc_name</p>
</td>
<td class="cellrowborder" valign="top" width="18.059405940594058%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514007__en-us_topic_0128036934_p85781127153117">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.396039603960396%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514007__en-us_topic_0128036934_p457810274319">Indicates the name of a VPC.</p>
</td>
</tr>
<tr id="kafka-api-180514007__en-us_topic_0128036934_row11578127143114"><td class="cellrowborder" valign="top" width="21.544554455445546%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514007__en-us_topic_0128036934_p957812713114">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="18.059405940594058%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514007__en-us_topic_0128036934_p65789275312">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.396039603960396%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514007__en-us_topic_0128036934_p157816279315">Indicates the time when an instance is created. </p>
<p id="kafka-api-180514007__en-us_topic_0128036934_p66601112371">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-180514007__en-us_topic_0128036934_row35784274319"><td class="cellrowborder" valign="top" width="21.544554455445546%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514007__en-us_topic_0128036934_p55781427153110">user_id</p>
</td>
<td class="cellrowborder" valign="top" width="18.059405940594058%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514007__en-us_topic_0128036934_p20578192712318">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.396039603960396%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514007__en-us_topic_0128036934_p3578927153120">Indicates the user ID.</p>
</td>
</tr>
<tr id="kafka-api-180514007__en-us_topic_0128036934_row1157842793115"><td class="cellrowborder" valign="top" width="21.544554455445546%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514007__en-us_topic_0128036934_p457814276312">user_name</p>
</td>
<td class="cellrowborder" valign="top" width="18.059405940594058%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514007__en-us_topic_0128036934_p4578162793118">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.396039603960396%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514007__en-us_topic_0128036934_p5578122710311">Indicates the username.</p>
</td>
</tr>
<tr id="kafka-api-180514007__en-us_topic_0128036934_row05781027153111"><td class="cellrowborder" valign="top" width="21.544554455445546%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514007__en-us_topic_0128036934_p1457818275315">maintain_begin</p>
</td>
<td class="cellrowborder" valign="top" width="18.059405940594058%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514007__en-us_topic_0128036934_p13578127163110">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.396039603960396%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514007__en-us_topic_0128036934_p81093614219">Indicates the time at which a maintenance time window starts.</p>
<p id="kafka-api-180514007__en-us_topic_0128036934_p173615219113">Format: HH:mm:ss</p>
</td>
</tr>
<tr id="kafka-api-180514007__en-us_topic_0128036934_row1257882783115"><td class="cellrowborder" valign="top" width="21.544554455445546%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514007__en-us_topic_0128036934_p1578182743117">maintain_end</p>
</td>
<td class="cellrowborder" valign="top" width="18.059405940594058%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514007__en-us_topic_0128036934_p75789276314">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.396039603960396%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514007__en-us_topic_0128036934_p11109136229">Time at which the maintenance time window ends.</p>
<p id="kafka-api-180514007__en-us_topic_0128036934_p103593211218">Format: HH:mm:ss</p>
</td>
</tr>
<tr id="kafka-api-180514007__en-us_topic_0128036934_row162851018141618"><td class="cellrowborder" valign="top" width="21.544554455445546%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514007__en-us_topic_0128036934_p974553544713">enable_publicip</p>
</td>
<td class="cellrowborder" valign="top" width="18.059405940594058%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514007__en-us_topic_0128036934_p10745123554715">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60.396039603960396%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514007__en-us_topic_0128036934_p137451135174712">Indicates whether to enable public access for an instance.</p>
<ul id="kafka-api-180514007__en-us_topic_0128036934_ul16745143518477"><li id="kafka-api-180514007__en-us_topic_0128036934_li14745133514475"><strong id="kafka-api-180514007__en-us_topic_0128036934_b862519318216">true</strong>: enable</li><li id="kafka-api-180514007__en-us_topic_0128036934_li5745335194718"><strong id="kafka-api-180514007__en-us_topic_0128036934_b534914817385">false</strong>: disable</li></ul>
</td>
</tr>
<tr id="kafka-api-180514007__en-us_topic_0128036934_row4285718141613"><td class="cellrowborder" valign="top" width="21.544554455445546%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514007__en-us_topic_0128036934_p71092245167">ssl_enable</p>
</td>
<td class="cellrowborder" valign="top" width="18.059405940594058%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514007__en-us_topic_0128036934_p10109162471615">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60.396039603960396%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514007__en-us_topic_0128036934_p71091624131614">Indicates whether to enable security authentication.</p>
<ul id="kafka-api-180514007__en-us_topic_0128036934_ul10462144102117"><li id="kafka-api-180514007__en-us_topic_0128036934_li19462247212"><strong id="kafka-api-180514007__en-us_topic_0128036934_b205164461325">true</strong>: enable</li><li id="kafka-api-180514007__en-us_topic_0128036934_li19462154152112"><strong id="kafka-api-180514007__en-us_topic_0128036934_b2162163623818">false</strong>: disable</li></ul>
</td>
</tr>
<tr id="kafka-api-180514007__en-us_topic_0128036934_row183099074514"><td class="cellrowborder" valign="top" width="21.544554455445546%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514007__en-us_topic_0128036934_p1666717478420">extend_times</p>
</td>
<td class="cellrowborder" valign="top" width="18.059405940594058%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514007__en-us_topic_0128036934_p16667164713421">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60.396039603960396%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514007__en-us_topic_0128036934_p16667247164219">Indicates the number of disk expansion times. If it exceeds 20, the disk cannot be expanded.</p>
</td>
</tr>
<tr id="kafka-api-180514007__row1230683102016"><td class="cellrowborder" valign="top" width="21.544554455445546%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514007__p745015562019">enable_auto_topic</p>
</td>
<td class="cellrowborder" valign="top" width="18.059405940594058%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514007__p54507556200">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60.396039603960396%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514007__p7450165552018">Indicates whether automatic topic creation is enabled.</p>
<ul id="kafka-api-180514007__ul345025512209"><li id="kafka-api-180514007__li144501455132020"><strong id="kafka-api-180514007__b39868298714">true</strong>: enabled</li><li id="kafka-api-180514007__li44501055182017"><strong id="kafka-api-180514007__b624693116712">false</strong>: disabled</li></ul>
</td>
</tr>
<tr id="kafka-api-180514007__row057519140561"><td class="cellrowborder" valign="top" width="21.544554455445546%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514007__p15761114175617">type</p>
</td>
<td class="cellrowborder" valign="top" width="18.059405940594058%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514007__en-us_topic_0128036896_p166511133720">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.396039603960396%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514007__en-us_topic_0128036896_p20877106205912">Indicates the instance type. Value: <strong id="kafka-api-180514007__b29822716488">cluster</strong>.</p>
</td>
</tr>
<tr id="kafka-api-180514007__row3576161413568"><td class="cellrowborder" valign="top" width="21.544554455445546%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514007__p125767145564">product_id</p>
</td>
<td class="cellrowborder" valign="top" width="18.059405940594058%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514007__en-us_topic_0128036896_p9661011193716">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.396039603960396%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514007__en-us_topic_0128036896_p66681133712">Indicates the product ID.</p>
</td>
</tr>
<tr id="kafka-api-180514007__row125771014125619"><td class="cellrowborder" valign="top" width="21.544554455445546%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514007__p105771714175618">security_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="18.059405940594058%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514007__en-us_topic_0128036896_p1566121123714">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.396039603960396%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514007__en-us_topic_0128036896_p966141113716">Indicates the security group ID.</p>
</td>
</tr>
<tr id="kafka-api-180514007__row9577191465610"><td class="cellrowborder" valign="top" width="21.544554455445546%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514007__p957719145565">security_group_name</p>
</td>
<td class="cellrowborder" valign="top" width="18.059405940594058%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514007__en-us_topic_0128036896_p1366211203718">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.396039603960396%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514007__en-us_topic_0128036896_p5661411163716">Indicates the security group name.</p>
</td>
</tr>
<tr id="kafka-api-180514007__row156291529165712"><td class="cellrowborder" valign="top" width="21.544554455445546%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514007__p1162962935717">subnet_id</p>
</td>
<td class="cellrowborder" valign="top" width="18.059405940594058%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514007__en-us_topic_0128036896_p366811133711">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.396039603960396%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514007__en-us_topic_0128036896_p1166201143713">Indicates the subnet ID.</p>
</td>
</tr>
<tr id="kafka-api-180514007__row2062972995716"><td class="cellrowborder" valign="top" width="21.544554455445546%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514007__p116292029105716">available_zones</p>
</td>
<td class="cellrowborder" valign="top" width="18.059405940594058%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514007__en-us_topic_0128036896_p1168121163713">Array</p>
</td>
<td class="cellrowborder" valign="top" width="60.396039603960396%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514007__en-us_topic_0128036896_p668191116370">Indicates the AZ to which the instance node belongs. The AZ ID is returned.</p>
</td>
</tr>
<tr id="kafka-api-180514007__row13629629165714"><td class="cellrowborder" valign="top" width="21.544554455445546%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514007__p16629229185716">total_storage_space</p>
</td>
<td class="cellrowborder" valign="top" width="18.059405940594058%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514007__p4834185773111">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60.396039603960396%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514007__p5834105711315">Indicates the message storage space. Unit: GB</p>
</td>
</tr>
<tr id="kafka-api-180514007__row166296297571"><td class="cellrowborder" valign="top" width="21.544554455445546%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514007__p1662915293578">public_connect_address</p>
</td>
<td class="cellrowborder" valign="top" width="18.059405940594058%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514007__p3525285014">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.396039603960396%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514007__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-180514007__row121251658125719"><td class="cellrowborder" valign="top" width="21.544554455445546%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514007__p61255588579">storage_resource_id</p>
</td>
<td class="cellrowborder" valign="top" width="18.059405940594058%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514007__p251415413281">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.396039603960396%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514007__p651215544286">Indicates the storage resource ID.</p>
</td>
</tr>
<tr id="kafka-api-180514007__row31251258155712"><td class="cellrowborder" valign="top" width="21.544554455445546%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514007__p14125145835717">storage_spec_code</p>
</td>
<td class="cellrowborder" valign="top" width="18.059405940594058%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514007__p34481152265">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.396039603960396%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514007__p194481158263">Indicates the I/O specification.</p>
</td>
</tr>
<tr id="kafka-api-180514007__row912575819578"><td class="cellrowborder" valign="top" width="21.544554455445546%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514007__p6125185865713">service_type</p>
</td>
<td class="cellrowborder" valign="top" width="18.059405940594058%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514007__p163673873510">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.396039603960396%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514007__p183673810358">Indicates the service type.</p>
</td>
</tr>
<tr id="kafka-api-180514007__row1912610581578"><td class="cellrowborder" valign="top" width="21.544554455445546%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514007__p112619588579">storage_type</p>
</td>
<td class="cellrowborder" valign="top" width="18.059405940594058%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514007__p1836818873517">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.396039603960396%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514007__p16368181357">Indicates the storage type.</p>
</td>
</tr>
<tr id="kafka-api-180514007__row2704142613585"><td class="cellrowborder" valign="top" width="21.544554455445546%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514007__p970472675811">retention_policy</p>
</td>
<td class="cellrowborder" valign="top" width="18.059405940594058%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514007__p12875114133513">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.396039603960396%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514007__p887534116352">Indicates the message retention policy.</p>
</td>
</tr>
<tr id="kafka-api-180514007__row167041626165816"><td class="cellrowborder" valign="top" width="21.544554455445546%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514007__p4704192619584">kafka_public_status</p>
</td>
<td class="cellrowborder" valign="top" width="18.059405940594058%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514007__p911034065717">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.396039603960396%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514007__p1211054020574">Indicates whether Kafka public access is enabled.</p>
</td>
</tr>
<tr id="kafka-api-180514007__row470552616588"><td class="cellrowborder" valign="top" width="21.544554455445546%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514007__p10705126205813">public_bandwidth</p>
</td>
<td class="cellrowborder" valign="top" width="18.059405940594058%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514007__p1719011110583">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60.396039603960396%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514007__p171907114589">Indicates the public network bandwidth.</p>
</td>
</tr>
<tr id="kafka-api-180514007__row2032920378147"><td class="cellrowborder" valign="top" width="21.544554455445546%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514007__p1836214103218">enable_log_collection</p>
</td>
<td class="cellrowborder" valign="top" width="18.059405940594058%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514007__p73628106215">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60.396039603960396%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514007__p636217105218">Indicates whether log collection is enabled.</p>
</td>
</tr>
<tr id="kafka-api-180514007__row243616592148"><td class="cellrowborder" valign="top" width="21.544554455445546%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514007__p936291018215">cross_vpc_info</p>
</td>
<td class="cellrowborder" valign="top" width="18.059405940594058%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514007__p203624101624">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.396039603960396%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514007__p14362810223">Indicates cross-VPC access information.</p>
</td>
</tr>
<tr id="kafka-api-180514007__row867631411512"><td class="cellrowborder" valign="top" width="21.544554455445546%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514007__p436313101723">ipv6_enable</p>
</td>
<td class="cellrowborder" valign="top" width="18.059405940594058%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514007__p123632010922">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60.396039603960396%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514007__p113631710821">Indicates whether IPv6 is enabled.</p>
</td>
</tr>
<tr id="kafka-api-180514007__row480810110159"><td class="cellrowborder" valign="top" width="21.544554455445546%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514007__p13631910729">ipv6_connect_addresses</p>
</td>
<td class="cellrowborder" valign="top" width="18.059405940594058%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514007__p1036315101722">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="60.396039603960396%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514007__p123633101727">Indicates the IPv6 connection address.</p>
</td>
</tr>
<tr id="kafka-api-180514007__row199214281514"><td class="cellrowborder" valign="top" width="21.544554455445546%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514007__p113641810222">rest_enable</p>
</td>
<td class="cellrowborder" valign="top" width="18.059405940594058%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514007__p16364210520">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60.396039603960396%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514007__p3364141017212">Indicates whether the Kafka REST function is enabled.</p>
</td>
</tr>
<tr id="kafka-api-180514007__row759065611143"><td class="cellrowborder" valign="top" width="21.544554455445546%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514007__p13364610924">rest_connect_address</p>
</td>
<td class="cellrowborder" valign="top" width="18.059405940594058%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514007__p15364101014218">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.396039603960396%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514007__p1836418101928">Indicates the Kafka REST address.</p>
</td>
</tr>
<tr id="kafka-api-180514007__row1445175312146"><td class="cellrowborder" valign="top" width="21.544554455445546%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514007__p17364151016218">message_query_inst_enable</p>
</td>
<td class="cellrowborder" valign="top" width="18.059405940594058%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514007__p11364910824">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60.396039603960396%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514007__p636417101020">Indicates whether message query is enabled.</p>
</td>
</tr>
<tr id="kafka-api-180514007__row59475494142"><td class="cellrowborder" valign="top" width="21.544554455445546%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514007__p1336515102219">vpc_client_plain</p>
</td>
<td class="cellrowborder" valign="top" width="18.059405940594058%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514007__p1236551014214">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60.396039603960396%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514007__p193651110825">Indicates whether intra-VPC plaintext access is enabled.</p>
</td>
</tr>
<tr id="kafka-api-180514007__row757944616144"><td class="cellrowborder" valign="top" width="21.544554455445546%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514007__p123651610723">support_features</p>
</td>
<td class="cellrowborder" valign="top" width="18.059405940594058%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514007__p93655104218">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.396039603960396%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514007__p83652101126">Indicates the list of features supported by the Kafka instance.</p>
</td>
</tr>
<tr id="kafka-api-180514007__row4378114318145"><td class="cellrowborder" valign="top" width="21.544554455445546%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514007__p1636511014211">trace_enable</p>
</td>
<td class="cellrowborder" valign="top" width="18.059405940594058%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514007__p123651110523">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60.396039603960396%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514007__p1836591012214">Indicates whether message tracing is enabled.</p>
</td>
</tr>
<tr id="kafka-api-180514007__row45341340111415"><td class="cellrowborder" valign="top" width="21.544554455445546%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514007__p18365131019218">pod_connect_address</p>
</td>
<td class="cellrowborder" valign="top" width="18.059405940594058%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514007__p53655101624">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.396039603960396%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514007__p1736611012211">Indicates the connection address on the tenant side.</p>
</td>
</tr>
<tr id="kafka-api-180514007__row12932183017143"><td class="cellrowborder" valign="top" width="21.544554455445546%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514007__p183660106220">disk_encrypted</p>
</td>
<td class="cellrowborder" valign="top" width="18.059405940594058%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514007__p736621018216">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60.396039603960396%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514007__p4366101010212">Indicates whether disk encryption is enabled.</p>
</td>
</tr>
<tr id="kafka-api-180514007__row10324102052510"><td class="cellrowborder" valign="top" width="21.544554455445546%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514007__p1673135210401">disk_encrypted_key</p>
</td>
<td class="cellrowborder" valign="top" width="18.059405940594058%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514007__p17673205274014">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.396039603960396%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514007__p126731952124016">Indicates the ID of the KMS key if disk encryption is enabled.</p>
</td>
</tr>
<tr id="kafka-api-180514007__row1745170142614"><td class="cellrowborder" valign="top" width="21.544554455445546%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514007__p16411117695">public_resource_id</p>
</td>
<td class="cellrowborder" valign="top" width="18.059405940594058%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514007__p11411111717917">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.396039603960396%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514007__p114111817893">Indicates the public network resource ID.</p>
<p id="kafka-api-180514007__p3230142910115">This parameter is returned only when public access is enabled for the instance.</p>
</td>
</tr>
<tr id="kafka-api-180514007__row15685143520502"><td class="cellrowborder" valign="top" width="21.544554455445546%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514007__p236651018215">kafka_private_connect_address</p>
</td>
<td class="cellrowborder" valign="top" width="18.059405940594058%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514007__p15366101017219">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.396039603960396%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514007__p143668106219">Indicates the private connection address of a Kafka instance.</p>
</td>
</tr>
<tr id="kafka-api-180514007__row1172293819506"><td class="cellrowborder" valign="top" width="21.544554455445546%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514007__p836620101326">ces_version</p>
</td>
<td class="cellrowborder" valign="top" width="18.059405940594058%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514007__p133665101126">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.396039603960396%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514007__p1366510425">Indicates the Cloud Eye version.</p>
</td>
</tr>
<tr id="kafka-api-180514007__row752284819501"><td class="cellrowborder" valign="top" width="21.544554455445546%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514007__p1367110429">tags</p>
</td>
<td class="cellrowborder" valign="top" width="18.059405940594058%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514007__p836713104219">Array&lt;Object&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="60.396039603960396%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514007__p336716108210">Indicates the list of tags.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="kafka-api-180514007__response_tags" frame="border" border="1" rules="all"><caption><b>Table 4 </b>tags</caption><thead align="left"><tr id="kafka-api-180514007__row11533109725"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.6.2.4.1.1"><p id="kafka-api-180514007__p1536710108210">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.6.2.4.1.2"><p id="kafka-api-180514007__p13671102025">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.6.2.4.1.3"><p id="kafka-api-180514007__p7367710527">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="kafka-api-180514007__row5533189420"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p id="kafka-api-180514007__p183685101423">key</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.2 "><p id="kafka-api-180514007__p1536814105216">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.6.2.4.1.3 "><p id="kafka-api-180514007__p3368171020219">Indicates the tag key.</p>
</td>
</tr>
<tr id="kafka-api-180514007__row5533393210"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p id="kafka-api-180514007__p133688100210">value</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.2 "><p id="kafka-api-180514007__p536971015216">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.6.2.4.1.3 "><p id="kafka-api-180514007__p1836913101422">Indicates the tag value.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="kafka-api-180514007__en-us_topic_0128036934_p257822723112"><strong id="kafka-api-180514007__en-us_topic_0128036934_b12948185333">Example response</strong></p>
<pre class="screen" id="kafka-api-180514007__screen079744463418">{
"instances": [
{
"name": "kafka-lxy-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",
"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
}
],
"instance_num": 1}</pre>
</div>
<div class="section" id="kafka-api-180514007__en-us_topic_0128036934_section103948275315"><h4 class="sectiontitle">Status Code</h4><p id="kafka-api-180514007__en-us_topic_0128036934_p1358112773114"><a href="#kafka-api-180514007__en-us_topic_0128036934_table1239452718312">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-180514007__en-us_topic_0128036934_table1239452718312"></a><a name="en-us_topic_0128036934_table1239452718312"></a><table cellpadding="4" cellspacing="0" summary="" id="kafka-api-180514007__en-us_topic_0128036934_table1239452718312" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Status code</caption><thead align="left"><tr id="kafka-api-180514007__en-us_topic_0128036934_row7581182719318"><th align="left" class="cellrowborder" valign="top" width="15.15%" id="mcps1.3.6.3.2.3.1.1"><p id="kafka-api-180514007__en-us_topic_0128036934_p1858192719314">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-180514007__en-us_topic_0128036934_p15811927203112">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="kafka-api-180514007__en-us_topic_0128036934_row9581127103111"><td class="cellrowborder" valign="top" width="15.15%" headers="mcps1.3.6.3.2.3.1.1 "><p id="kafka-api-180514007__en-us_topic_0128036934_p458111273315">200</p>
</td>
<td class="cellrowborder" valign="top" width="84.85000000000001%" headers="mcps1.3.6.3.2.3.1.2 "><p id="kafka-api-180514007__en-us_topic_0128036934_p4581927153115">All instances are 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>
View Git Blame Copy Permalink