vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/dcs/api-ref/dcs-api-0312006.html
Chen, Junjie a03981f7be DCS API 20230220 Version 
Reviewed-by: Bobkova, Natalia <natalia.bobkova@t-systems.com>
Co-authored-by: Chen, Junjie <chenjunjie@huawei.com>
Co-committed-by: Chen, Junjie <chenjunjie@huawei.com>
2024-04-22 14:08:39 +00:00

521 lines
47 KiB
HTML
Raw Permalink Blame History

<a name="dcs-api-0312006"></a><a name="dcs-api-0312006"></a>
<h1 class="topictitle1">Querying All DCS Instances of a Tenant</h1>
<div id="body59450282"><div class="section" id="dcs-api-0312006__en-us_topic_0166889639_section152981849191118"><h4 class="sectiontitle">Function</h4><p class="msonormal" id="dcs-api-0312006__en-us_topic_0166889639_p48194049">This API is used to query DCS instances of a tenant, and allows you to specify query criteria.</p>
</div>
<div class="section" id="dcs-api-0312006__en-us_topic_0166889639_section241813305156"><h4 class="sectiontitle">URI</h4><p id="dcs-api-0312006__en-us_topic_0166889639_p538414513189">GET /v1.0/{project_id}/instances?start={start}&amp;limit={limit}&amp;name={name}&amp;status={status}&amp;id={id}&amp;include_failure={include_failure}&amp;ip={ip}&amp;tags={key}={value}</p>
<div class="p" id="dcs-api-0312006__en-us_topic_0166889639_p18874418395"><a href="#dcs-api-0312006__en-us_topic_0166889639_table1971216413394">Table 1</a> describes the parameters.
<div class="tablenoborder"><a name="dcs-api-0312006__en-us_topic_0166889639_table1971216413394"></a><a name="en-us_topic_0166889639_table1971216413394"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312006__en-us_topic_0166889639_table1971216413394" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="dcs-api-0312006__en-us_topic_0166889639_row471164123918"><th align="left" class="cellrowborder" valign="top" width="19.191919191919194%" id="mcps1.3.2.3.2.2.5.1.1"><p id="dcs-api-0312006__en-us_topic_0166889639_p1671124183918">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.151515151515152%" id="mcps1.3.2.3.2.2.5.1.2"><p id="dcs-api-0312006__en-us_topic_0166889639_p9711640395">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10.101010101010102%" id="mcps1.3.2.3.2.2.5.1.3"><p id="dcs-api-0312006__en-us_topic_0166889639_p6711134123919">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.55555555555556%" id="mcps1.3.2.3.2.2.5.1.4"><p id="dcs-api-0312006__en-us_topic_0166889639_p371111419391">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dcs-api-0312006__en-us_topic_0166889639_row1971164153918"><td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dcs-api-0312006__en-us_topic_0166889639_p1871118413915">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="15.151515151515152%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dcs-api-0312006__en-us_topic_0166889639_p67119403914">String</p>
</td>
<td class="cellrowborder" valign="top" width="10.101010101010102%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dcs-api-0312006__en-us_topic_0166889639_p1971114133914">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="55.55555555555556%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dcs-api-0312006__en-us_topic_0166889639_p1571112453911">Project ID. For details on how to obtain the value of this parameter, see <a href="dcs-api-0312045.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
<tr id="dcs-api-0312006__en-us_topic_0166889639_row35781458193419"><td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dcs-api-0312006__en-us_topic_0166889639_p1056385913419">start</p>
</td>
<td class="cellrowborder" valign="top" width="15.151515151515152%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dcs-api-0312006__en-us_topic_0166889639_p1656455973412">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="10.101010101010102%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dcs-api-0312006__en-us_topic_0166889639_p35641259133416">No</p>
</td>
<td class="cellrowborder" valign="top" width="55.55555555555556%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dcs-api-0312006__en-us_topic_0166889639_p155291255164420">Start number for querying DCS instances. It cannot be lower than 1.</p>
<p id="dcs-api-0312006__en-us_topic_0166889639_p874301694015">By default, the start number is 1.</p>
</td>
</tr>
<tr id="dcs-api-0312006__en-us_topic_0166889639_row369210914352"><td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dcs-api-0312006__en-us_topic_0166889639_p982313289356">limit</p>
</td>
<td class="cellrowborder" valign="top" width="15.151515151515152%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dcs-api-0312006__en-us_topic_0166889639_p1282382873520">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="10.101010101010102%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dcs-api-0312006__en-us_topic_0166889639_p208234286356">No</p>
</td>
<td class="cellrowborder" valign="top" width="55.55555555555556%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dcs-api-0312006__en-us_topic_0166889639_p31411454192212">Number of DCS instances displayed on each page.</p>
<p id="dcs-api-0312006__en-us_topic_0166889639_p18991528226">Minimum value: <strong id="dcs-api-0312006__en-us_topic_0166889639_b12604124814265">1</strong></p>
<p id="dcs-api-0312006__en-us_topic_0166889639_p687663014320">Maximum value: <strong id="dcs-api-0312006__en-us_topic_0166889639_b8502123603218">2000</strong></p>
<p id="dcs-api-0312006__en-us_topic_0166889639_p117431016134018">If this parameter is left unspecified, a maximum of 1000 DCS instances are displayed on each page.</p>
</td>
</tr>
<tr id="dcs-api-0312006__en-us_topic_0166889639_row571194103917"><td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dcs-api-0312006__en-us_topic_0166889639_p1071194183918">name</p>
</td>
<td class="cellrowborder" valign="top" width="15.151515151515152%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dcs-api-0312006__en-us_topic_0166889639_p1971194143913">String</p>
</td>
<td class="cellrowborder" valign="top" width="10.101010101010102%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dcs-api-0312006__en-us_topic_0166889639_p1271154103919">No</p>
</td>
<td class="cellrowborder" valign="top" width="55.55555555555556%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dcs-api-0312006__en-us_topic_0166889639_p971115443917">DCS instance name.</p>
</td>
</tr>
<tr id="dcs-api-0312006__en-us_topic_0166889639_row29521548173814"><td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dcs-api-0312006__en-us_topic_0166889639_p1681750143817">id</p>
</td>
<td class="cellrowborder" valign="top" width="15.151515151515152%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dcs-api-0312006__en-us_topic_0166889639_p5681650143817">String</p>
</td>
<td class="cellrowborder" valign="top" width="10.101010101010102%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dcs-api-0312006__en-us_topic_0166889639_p66855016386">No</p>
</td>
<td class="cellrowborder" valign="top" width="55.55555555555556%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dcs-api-0312006__en-us_topic_0166889639_p268205023811">Instance ID.</p>
</td>
</tr>
<tr id="dcs-api-0312006__en-us_topic_0166889639_row12786653163512"><td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dcs-api-0312006__en-us_topic_0166889639_p38591137369">status</p>
</td>
<td class="cellrowborder" valign="top" width="15.151515151515152%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dcs-api-0312006__en-us_topic_0166889639_p15859333361">String</p>
</td>
<td class="cellrowborder" valign="top" width="10.101010101010102%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dcs-api-0312006__en-us_topic_0166889639_p285910343614">No</p>
</td>
<td class="cellrowborder" valign="top" width="55.55555555555556%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dcs-api-0312006__en-us_topic_0166889639_p885911333617">DCS instance status. For details about status, see <a href="dcs-api-0312047.html">DCS Instance Statuses</a>.</p>
</td>
</tr>
<tr id="dcs-api-0312006__en-us_topic_0166889639_row1282212951812"><td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dcs-api-0312006__en-us_topic_0166889639_p118231029101817">ip</p>
</td>
<td class="cellrowborder" valign="top" width="15.151515151515152%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dcs-api-0312006__en-us_topic_0166889639_p12823229191817">String</p>
</td>
<td class="cellrowborder" valign="top" width="10.101010101010102%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dcs-api-0312006__en-us_topic_0166889639_p198232295186">No</p>
</td>
<td class="cellrowborder" valign="top" width="55.55555555555556%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dcs-api-0312006__en-us_topic_0166889639_p14818579184">IP address for connecting to the DCS instance</p>
</td>
</tr>
<tr id="dcs-api-0312006__en-us_topic_0166889639_row1755617651610"><td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dcs-api-0312006__en-us_topic_0166889639_p35567641610">include_failure</p>
</td>
<td class="cellrowborder" valign="top" width="15.151515151515152%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dcs-api-0312006__en-us_topic_0166889639_p1555618621616">String</p>
</td>
<td class="cellrowborder" valign="top" width="10.101010101010102%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dcs-api-0312006__en-us_topic_0166889639_p9556563163">No</p>
</td>
<td class="cellrowborder" valign="top" width="55.55555555555556%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dcs-api-0312006__en-us_topic_0166889639_p7669181914458">An indicator of whether the number of DCS instances that failed to be created will be returned to the API caller.</p>
<p id="dcs-api-0312006__en-us_topic_0166889639_p1293413195320">Options:</p>
<ul id="dcs-api-0312006__en-us_topic_0166889639_ul1614112811458"><li id="dcs-api-0312006__en-us_topic_0166889639_li4614928114517"><strong id="dcs-api-0312006__en-us_topic_0166889639_b209751421194520">true</strong>: The number of DCS instances that failed to be created will be returned to the API caller.</li><li id="dcs-api-0312006__en-us_topic_0166889639_li13614172811459"><strong id="dcs-api-0312006__en-us_topic_0166889639_b164651564234">false</strong> or others: The number of DCS instances that failed to be created will not be returned to the API caller.</li></ul>
</td>
</tr>
<tr id="dcs-api-0312006__en-us_topic_0166889639_row1543715181117"><td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dcs-api-0312006__en-us_topic_0166889639_p943817181514">tags</p>
</td>
<td class="cellrowborder" valign="top" width="15.151515151515152%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dcs-api-0312006__en-us_topic_0166889639_p1743891817115">Array of Objects</p>
</td>
<td class="cellrowborder" valign="top" width="10.101010101010102%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dcs-api-0312006__en-us_topic_0166889639_p204389181112">No</p>
</td>
<td class="cellrowborder" valign="top" width="55.55555555555556%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dcs-api-0312006__en-us_topic_0166889639_p184387181915">Query based on the instance tag key and value. <em id="dcs-api-0312006__en-us_topic_0166889639_i8102231115818">{key}</em> indicates the tag key, and <em id="dcs-api-0312006__en-us_topic_0166889639_i17418184125810">{value}</em> indicates the tag value.</p>
<p id="dcs-api-0312006__en-us_topic_0166889639_p147943394212">To query instances with multiple tag keys and values, separate key-value pairs with commas (,).</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<p id="dcs-api-0312006__en-us_topic_0166889639_p19434111919"><strong id="dcs-api-0312006__en-us_topic_0166889639_b18809121415011">Example</strong></p>
<pre class="screen" id="dcs-api-0312006__en-us_topic_0166889639_screen1594491112118">GET https://{dcs_endpoint}/v1.0/bd6b78e2ff9e4e47bc260803ddcc7a21/instances?start=1&amp;limit=10&amp;name=&amp;status=&amp;id=&amp;include_failure=true </pre>
</div>
<div class="section" id="dcs-api-0312006__en-us_topic_0166889639_section12833102510169"><h4 class="sectiontitle">Request</h4><p id="dcs-api-0312006__en-us_topic_0166889639_p144323478416"><strong id="dcs-api-0312006__en-us_topic_0166889639_b1945123944615">Request parameters</strong></p>
<p id="dcs-api-0312006__en-us_topic_0166889639_p174325475412">None</p>
<p id="dcs-api-0312006__en-us_topic_0166889639_p1243214713417"><strong id="dcs-api-0312006__en-us_topic_0166889639_b1889511443469">Example request</strong></p>
<p id="dcs-api-0312006__en-us_topic_0166889639_p16432164711414">None</p>
</div>
<div class="section" id="dcs-api-0312006__en-us_topic_0166889639_section1357695041617"><h4 class="sectiontitle">Response</h4><p class="msonormal" id="dcs-api-0312006__en-us_topic_0166889639_p13724352184111"><strong id="dcs-api-0312006__en-us_topic_0166889639_b67211448174613">Response parameters</strong></p>
<div class="msonormal" id="dcs-api-0312006__en-us_topic_0166889639_p2198512103910"><a href="#dcs-api-0312006__en-us_topic_0166889639_table189371511113913">Table 2</a> describes the response parameters.
<div class="tablenoborder"><a name="dcs-api-0312006__en-us_topic_0166889639_table189371511113913"></a><a name="en-us_topic_0166889639_table189371511113913"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312006__en-us_topic_0166889639_table189371511113913" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="dcs-api-0312006__en-us_topic_0166889639_row19371311103911"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.3.2.2.4.1.1"><p id="dcs-api-0312006__en-us_topic_0166889639_p1793761183919">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.3.2.2.4.1.2"><p id="dcs-api-0312006__en-us_topic_0166889639_p1093731111398">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.3.2.2.4.1.3"><p id="dcs-api-0312006__en-us_topic_0166889639_p17937111153918">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dcs-api-0312006__en-us_topic_0166889639_row3202104544912"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.2.4.1.1 "><p id="dcs-api-0312006__en-us_topic_0166889639_p2281341504">instances</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.2.4.1.2 "><p id="dcs-api-0312006__en-us_topic_0166889639_p172816412505">Array</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.2.4.1.3 "><p id="dcs-api-0312006__en-us_topic_0166889639_p22822425019">Array of DCS instance details.</p>
</td>
</tr>
<tr id="dcs-api-0312006__en-us_topic_0166889639_row893791193918"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.2.4.1.1 "><p id="dcs-api-0312006__en-us_topic_0166889639_p149376118392">instance_num</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.2.4.1.2 "><p id="dcs-api-0312006__en-us_topic_0166889639_p1193711112392">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.2.4.1.3 "><p id="dcs-api-0312006__en-us_topic_0166889639_p19937711123913">Number of DCS instances.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312006__en-us_topic_0166889639_table369734810017" frame="border" border="1" rules="all"><caption><b>Table 3 </b>instances parameters</caption><thead align="left"><tr id="dcs-api-0312006__en-us_topic_0166889639_row669810481608"><th align="left" class="cellrowborder" valign="top" width="28.000000000000004%" id="mcps1.3.4.4.2.4.1.1"><p id="dcs-api-0312006__en-us_topic_0166889639_p2698848701">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="dcs-api-0312006__en-us_topic_0166889639_p16698134812020">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52%" id="mcps1.3.4.4.2.4.1.3"><p id="dcs-api-0312006__en-us_topic_0166889639_p2069814482002">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dcs-api-0312006__en-us_topic_0166889639_row569813481702"><td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312006__en-us_topic_0166889639_p1869994817016">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312006__en-us_topic_0166889639_p6699204817015">String</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312006__en-us_topic_0166889639_p4699448306">DCS instance name.</p>
</td>
</tr>
<tr id="dcs-api-0312006__en-us_topic_0166889639_row969954818015"><td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312006__en-us_topic_0166889639_p3699194818010">engine</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312006__en-us_topic_0166889639_p1169911481205">String</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312006__en-us_topic_0166889639_p66991848702">Cache engine.</p>
</td>
</tr>
<tr id="dcs-api-0312006__en-us_topic_0166889639_row73791340465"><td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312006__en-us_topic_0166889639_p11395113184611">capacity</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312006__en-us_topic_0166889639_p2039520135468">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312006__en-us_topic_0166889639_p18782152184620">Cache capacity.</p>
<p id="dcs-api-0312006__en-us_topic_0166889639_p1074361620405">Unit: GB.</p>
</td>
</tr>
<tr id="dcs-api-0312006__en-us_topic_0166889639_row193961184614"><td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312006__en-us_topic_0166889639_p284717204463">ip</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312006__en-us_topic_0166889639_p10848102018461">String</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312006__en-us_topic_0166889639_p198485207467">IP address for connecting to the DCS instance For a cluster instance, multiple IP addresses are returned and separated by commas (,). For example, 192.168.0.1,192.168.0.2.</p>
</td>
</tr>
<tr id="dcs-api-0312006__en-us_topic_0166889639_row149358172617"><td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312006__en-us_topic_0166889639_p174944882611">domainName</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312006__en-us_topic_0166889639_p1349412892616">String</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312006__en-us_topic_0166889639_p249408182611">Domain name of the instance.</p>
</td>
</tr>
<tr id="dcs-api-0312006__en-us_topic_0166889639_row113761049104515"><td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312006__en-us_topic_0166889639_p384812034619">port</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312006__en-us_topic_0166889639_p7848122013462">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312006__en-us_topic_0166889639_p108481520134614">Port number of the cache node.</p>
</td>
</tr>
<tr id="dcs-api-0312006__en-us_topic_0166889639_row104917353465"><td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312006__en-us_topic_0166889639_p2043125115467">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312006__en-us_topic_0166889639_p0431951114611">String</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312006__en-us_topic_0166889639_p6431105164611">Cache instance status. For details about status, see <a href="dcs-api-0312047.html">DCS Instance Statuses</a>.</p>
</td>
</tr>
<tr id="dcs-api-0312006__en-us_topic_0166889639_row9591173417615"><td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312006__en-us_topic_0166889639_p1922216541369">max_memory</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312006__en-us_topic_0166889639_p922213543615">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312006__en-us_topic_0166889639_p4163813193015">Overall memory size.</p>
<p id="dcs-api-0312006__en-us_topic_0166889639_p1312171063014">Unit: MB.</p>
</td>
</tr>
<tr id="dcs-api-0312006__en-us_topic_0166889639_row56279371966"><td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312006__en-us_topic_0166889639_p192220546614">used_memory</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312006__en-us_topic_0166889639_p1922213541860">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312006__en-us_topic_0166889639_p117951449303">Size of the used memory.</p>
<p id="dcs-api-0312006__en-us_topic_0166889639_p13743116144015">Unit: MB.</p>
</td>
</tr>
<tr id="dcs-api-0312006__en-us_topic_0166889639_row47802328460"><td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312006__en-us_topic_0166889639_p166055815469">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312006__en-us_topic_0166889639_p460658144617">String</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312006__en-us_topic_0166889639_p186114581469">DCS instance ID.</p>
</td>
</tr>
<tr id="dcs-api-0312006__en-us_topic_0166889639_row694618119478"><td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312006__en-us_topic_0166889639_p1922812198471">resource_spec_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312006__en-us_topic_0166889639_p16228151919475">String</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312006__en-us_topic_0166889639_p1822812195472">Resource specifications.</p>
<p id="dcs-api-0312006__en-us_topic_0166889639_p873772610177">For example:</p>
<ul id="dcs-api-0312006__en-us_topic_0166889639_ul103859344523"><li id="dcs-api-0312006__en-us_topic_0166889639_li2385133455220"><strong id="dcs-api-0312006__en-us_topic_0166889639_b795502413017">dcs.single_node</strong>: indicates a DCS instance in single-node mode.</li><li id="dcs-api-0312006__en-us_topic_0166889639_li7385103485210"><strong id="dcs-api-0312006__en-us_topic_0166889639_b1373103283019">dcs.master_standby</strong>: indicates a DCS instance in master/standby mode.</li><li id="dcs-api-0312006__en-us_topic_0166889639_li188516155015"><strong id="dcs-api-0312006__en-us_topic_0166889639_b12699340183014">dcs.cluster</strong>: indicates a DCS instance in cluster mode.</li></ul>
</td>
</tr>
<tr id="dcs-api-0312006__en-us_topic_0166889639_row1769904814011"><td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312006__en-us_topic_0166889639_p1699348901">engine_version</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312006__en-us_topic_0166889639_p76991483017">String</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312006__en-us_topic_0166889639_p106999489010">Cache engine version.</p>
</td>
</tr>
<tr id="dcs-api-0312006__en-us_topic_0166889639_row1169916481907"><td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312006__en-us_topic_0166889639_p96991848800">internal_version</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312006__en-us_topic_0166889639_p9699104812010">String</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312006__en-us_topic_0166889639_p1269934817017">Internal DCS version.</p>
</td>
</tr>
<tr id="dcs-api-0312006__en-us_topic_0166889639_row8699134814017"><td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312006__en-us_topic_0166889639_p1369913481403">charging_mode</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312006__en-us_topic_0166889639_p126992481601">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312006__en-us_topic_0166889639_p39546309494">Billing mode. <strong id="dcs-api-0312006__en-us_topic_0166889639_b22127498117">0</strong>: pay-per-use.</p>
</td>
</tr>
<tr id="dcs-api-0312006__en-us_topic_0166889639_row193781351113220"><td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312006__en-us_topic_0166889639_p1815911534325">capacity_minor</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312006__en-us_topic_0166889639_p81659537320">String</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312006__en-us_topic_0166889639_p1716914531324">Small-scale cache capacity. Unit: GB.</p>
</td>
</tr>
<tr id="dcs-api-0312006__en-us_topic_0166889639_row1570074814019"><td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312006__en-us_topic_0166889639_p970012481002">vpc_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312006__en-us_topic_0166889639_p1270012481407">String</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312006__en-us_topic_0166889639_p18700114816015">VPC ID.</p>
</td>
</tr>
<tr id="dcs-api-0312006__en-us_topic_0166889639_row207001048803"><td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312006__en-us_topic_0166889639_p157009481802">vpc_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312006__en-us_topic_0166889639_p157001748203">String</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312006__en-us_topic_0166889639_p670074820013">VPC name.</p>
</td>
</tr>
<tr id="dcs-api-0312006__en-us_topic_0166889639_row570084820016"><td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312006__en-us_topic_0166889639_p117009481706">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312006__en-us_topic_0166889639_p77008481401">String</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312006__en-us_topic_0166889639_p1870013481502">Time at which the DCS instance is created. For example, 2017-03-31<strong id="dcs-api-0312006__en-us_topic_0166889639_b134311842153518">T</strong>12:24:46.297<strong id="dcs-api-0312006__en-us_topic_0166889639_b13431174214354">Z</strong>.</p>
</td>
</tr>
<tr id="dcs-api-0312006__en-us_topic_0166889639_row19101720521"><td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312006__en-us_topic_0166889639_p1912813665211">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312006__en-us_topic_0166889639_p21281736165212">String</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312006__en-us_topic_0166889639_p4128153619521">Error code returned when the DCS instance fails to be created or is abnormal. For details about error codes, see <a href="ErrorCode.html">Error Codes</a>.</p>
</td>
</tr>
<tr id="dcs-api-0312006__en-us_topic_0166889639_row366816435535"><td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312006__en-us_topic_0166889639_p11801751135315">user_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312006__en-us_topic_0166889639_p318015515539">String</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312006__en-us_topic_0166889639_p191801051165317">User ID.</p>
</td>
</tr>
<tr id="dcs-api-0312006__en-us_topic_0166889639_row55081444537"><td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312006__en-us_topic_0166889639_p2018075115531">user_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312006__en-us_topic_0166889639_p91804516534">String</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312006__en-us_topic_0166889639_p1818085118536">Username.</p>
</td>
</tr>
<tr id="dcs-api-0312006__en-us_topic_0166889639_row114981744170"><td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312006__en-us_topic_0166889639_p13545101053910">maintain_begin</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312006__en-us_topic_0166889639_p354520108395">String</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312006__en-us_topic_0166889639_p65461110173913">Time at which the maintenance time window starts. Format: hh:mm:ss.</p>
</td>
</tr>
<tr id="dcs-api-0312006__en-us_topic_0166889639_row931451171715"><td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312006__en-us_topic_0166889639_p654621033913">maintain_end</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312006__en-us_topic_0166889639_p125461810203910">String</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312006__en-us_topic_0166889639_p15546610113919">Time at which the maintenance time window ends. Format: hh:mm:ss.</p>
</td>
</tr>
<tr id="dcs-api-0312006__en-us_topic_0166889639_row19390125123413"><td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312006__en-us_topic_0166889639_p1358694218354">no_password_access</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312006__en-us_topic_0166889639_p1058614420357">String</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312006__en-us_topic_0166889639_p175864424351">An indicator of whether a DCS instance can be accessed in password-free mode.</p>
<ul id="dcs-api-0312006__en-us_topic_0166889639_ul145877425352"><li id="dcs-api-0312006__en-us_topic_0166889639_li19587164217356"><strong id="dcs-api-0312006__en-us_topic_0166889639_b72564320406">true</strong>: indicates that a DCS instance can be accessed without a password.</li><li id="dcs-api-0312006__en-us_topic_0166889639_li2058714220352"><strong id="dcs-api-0312006__en-us_topic_0166889639_b16268838104011">false</strong>: indicates that a DCS instance can be accessed only after password authentication.</li></ul>
</td>
</tr>
<tr id="dcs-api-0312006__en-us_topic_0166889639_row642453993419"><td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312006__en-us_topic_0166889639_p95871642133518">access_user</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312006__en-us_topic_0166889639_p5587184223519">String</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312006__en-us_topic_0166889639_p205871542183512">Username used for accessing a DCS instance with password authentication.</p>
</td>
</tr>
<tr id="dcs-api-0312006__en-us_topic_0166889639_row7641155834014"><td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312006__en-us_topic_0166889639_p133414611412">enable_publicip</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312006__en-us_topic_0166889639_p33341362413">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312006__en-us_topic_0166889639_p5334568411">An indicator of whether public access is enabled for a DCS Redis instance.</p>
<ul id="dcs-api-0312006__en-us_topic_0166889639_ul18334764416"><li id="dcs-api-0312006__en-us_topic_0166889639_li4334567419"><strong id="dcs-api-0312006__en-us_topic_0166889639_b17747143010380">true</strong>: enabled.</li><li id="dcs-api-0312006__en-us_topic_0166889639_li193368614416"><strong id="dcs-api-0312006__en-us_topic_0166889639_b1066833415386">false</strong>: disabled.</li></ul>
</td>
</tr>
<tr id="dcs-api-0312006__en-us_topic_0166889639_row239815314019"><td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312006__en-us_topic_0166889639_p1933612644115">publicip_address</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312006__en-us_topic_0166889639_p123368616412">String</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312006__en-us_topic_0166889639_p63365684119">Elastic IP address bound to a DCS Redis instance.</p>
<p id="dcs-api-0312006__en-us_topic_0166889639_p833696204114">The parameter value is <strong id="dcs-api-0312006__en-us_topic_0166889639_b10719165320387">null</strong> if public access is disabled.</p>
</td>
</tr>
<tr id="dcs-api-0312006__en-us_topic_0166889639_row163985535408"><td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312006__en-us_topic_0166889639_p173362613414">publicip_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312006__en-us_topic_0166889639_p533615610415">String</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312006__en-us_topic_0166889639_p633656134117">ID of the elastic IP address bound to a DCS Redis instance.</p>
<p id="dcs-api-0312006__en-us_topic_0166889639_p11336146164116">The parameter value is <strong id="dcs-api-0312006__en-us_topic_0166889639_b655012184017">null</strong> if public access is disabled.</p>
</td>
</tr>
<tr id="dcs-api-0312006__en-us_topic_0166889639_row9332102310350"><td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312006__en-us_topic_0166889639_p533252317351">enable_ssl</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312006__en-us_topic_0166889639_p14333823193515">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312006__en-us_topic_0166889639_p125521036125811">An indicator of whether to enable SSL for public access to a DCS Redis instance.</p>
<ul id="dcs-api-0312006__en-us_topic_0166889639_ul55521036185811"><li id="dcs-api-0312006__en-us_topic_0166889639_li055253620588"><strong id="dcs-api-0312006__en-us_topic_0166889639_b503374838">true</strong>: enabled.</li><li id="dcs-api-0312006__en-us_topic_0166889639_li17552113695817"><strong id="dcs-api-0312006__en-us_topic_0166889639_b588071673">false</strong>: disabled.</li></ul>
</td>
</tr>
<tr id="dcs-api-0312006__en-us_topic_0166889639_row112521750203410"><td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312006__en-us_topic_0166889639_p132524503346">service_upgrade</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312006__en-us_topic_0166889639_p182521050113419">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312006__en-us_topic_0166889639_p7253125013415">An indicator of whether an upgrade task has been created for a DCS instance.</p>
<ul id="dcs-api-0312006__en-us_topic_0166889639_ul249561864113"><li id="dcs-api-0312006__en-us_topic_0166889639_li124981118194112"><strong id="dcs-api-0312006__en-us_topic_0166889639_b11358812194113">true</strong>: yes.</li><li id="dcs-api-0312006__en-us_topic_0166889639_li150316188419"><strong id="dcs-api-0312006__en-us_topic_0166889639_b169091618416">false</strong>: no.</li></ul>
</td>
</tr>
<tr id="dcs-api-0312006__en-us_topic_0166889639_row1887111523347"><td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312006__en-us_topic_0166889639_p15871135233417">service_task_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312006__en-us_topic_0166889639_p387120528342">String</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312006__en-us_topic_0166889639_p1787112522346">Upgrade task ID.</p>
<ul id="dcs-api-0312006__en-us_topic_0166889639_ul169679916444"><li id="dcs-api-0312006__en-us_topic_0166889639_li149672096440">If the value of <strong id="dcs-api-0312006__en-us_topic_0166889639_b246813262425">service_upgrade</strong> is set to <strong id="dcs-api-0312006__en-us_topic_0166889639_b164687267426">true</strong>, the value of this parameter is the ID of the upgrade task.</li><li id="dcs-api-0312006__en-us_topic_0166889639_li16967189154416">If the value of <strong id="dcs-api-0312006__en-us_topic_0166889639_b10381123764219">service_upgrade</strong> is set to <strong id="dcs-api-0312006__en-us_topic_0166889639_b1338153717429">false</strong>, the value of this parameter is empty.</li></ul>
</td>
</tr>
<tr id="dcs-api-0312006__en-us_topic_0166889639_row10102225175414"><td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312006__en-us_topic_0166889639_p1510242510546">security_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312006__en-us_topic_0166889639_p25821513486">String</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312006__en-us_topic_0166889639_p1458214131886">Security group name.</p>
</td>
</tr>
<tr id="dcs-api-0312006__en-us_topic_0166889639_row8670146103711"><td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312006__en-us_topic_0166889639_p1367114611379">tags</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312006__en-us_topic_0166889639_p667117643717">Array of Objects</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312006__en-us_topic_0166889639_p46710613371">Instance tag key and value.</p>
</td>
</tr>
<tr id="dcs-api-0312006__en-us_topic_0166889639_row1959744851313"><td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312006__en-us_topic_0166889639_p205981648131313">spec_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312006__en-us_topic_0166889639_p1759834831312">String</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312006__en-us_topic_0166889639_p14598174818139">Product specification code.</p>
</td>
</tr>
<tr id="dcs-api-0312006__en-us_topic_0166889639_row38497536131"><td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312006__en-us_topic_0166889639_p28491153151311">domain_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312006__en-us_topic_0166889639_p19849253151313">String</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312006__en-us_topic_0166889639_p168491153141320">Domain name of the instance.</p>
</td>
</tr>
<tr id="dcs-api-0312006__en-us_topic_0166889639_row99256365169"><td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312006__en-us_topic_0166889639_p109252036171615">readonlyDomainName</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312006__en-us_topic_0166889639_p19925836101615">String</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312006__en-us_topic_0166889639_p19925536101611">Read-only domain name.</p>
</td>
</tr>
<tr id="dcs-api-0312006__en-us_topic_0166889639_row1438719191717"><td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312006__en-us_topic_0166889639_p1538871181715">readonly_domain_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312006__en-us_topic_0166889639_p23881171715">String</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312006__en-us_topic_0166889639_p1638861151714">Read-only domain name.</p>
</td>
</tr>
<tr id="dcs-api-0312006__en-us_topic_0166889639_row988913255171"><td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312006__en-us_topic_0166889639_p128891825181718">freeze_scene</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312006__en-us_topic_0166889639_p58893259173">String</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312006__en-us_topic_0166889639_p2889125161710">Scenario where the instance is frozen.</p>
</td>
</tr>
<tr id="dcs-api-0312006__en-us_topic_0166889639_row113719319173"><td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312006__en-us_topic_0166889639_p81373318176">update_at</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312006__en-us_topic_0166889639_p9137231101720">String</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312006__en-us_topic_0166889639_p990162513912">Update time. For example, 2017-03-31T12:24:46.297Z.</p>
</td>
</tr>
<tr id="dcs-api-0312006__en-us_topic_0166889639_row10435194471917"><td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312006__en-us_topic_0166889639_p1543554471910">subnet_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312006__en-us_topic_0166889639_p18435164431913">String</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312006__en-us_topic_0166889639_p1743574417192">Subnet ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p class="msonormal" id="dcs-api-0312006__en-us_topic_0166889639_p4484710124217"><strong id="dcs-api-0312006__en-us_topic_0166889639_b3157271499">Example response</strong></p>
<pre class="screen" id="dcs-api-0312006__en-us_topic_0166889639_screen18091343173519">{"instances":[
{
"max_memory":2048,
"used_memory":1,
"instance_id":"add1eee3-eaad-4975-a8d7-8cf853460e3d",
"name":"lboka-single-4",
"resource_spec_code":"redis.single.xu1.large.2",
"spec_code":"redis.single.xu1.large.2",
"engine":"Redis",
"engine_version":"4.0",
"internal_version":null,
"charging_mode":0,
"capacity":2,
"capacity_minor":null,
"vpc_id":"9d3938d4-d622-48f3-ab62-23f8ff8b7830",
"vpc_name":null,
"ip":"192.168.1.91",
"domainName":"redis-add1eee3-eaad-4975-a8d7-8cf853460e3d.dcs.com",
"domain_name":"redis-add1eee3-eaad-4975-a8d7-8cf853460e3d.dcs.com",
"readonlyDomainName":null,
"readonly_domain_name":null,
"port":6379,
"status":"RUNNING",
"freeze_scene":null,
"created_at":"2021-04-18T13:36:44.144Z",
"update_at":"2021-04-18T13:37:10.575Z",
"error_code":null,
"user_id":"e96cb82994ef49648c2bfad79455b0ef",
"user_name":"lboka",
"maintain_begin":"02:00:00",
"maintain_end":"06:00:00",
"no_password_access":"false",
"access_user":null,
"enable_publicip":false,
"publicip_id":null,
"publicip_address":null,
"enable_ssl":false,
"service_upgrade":false,
"service_task_id":"",
"security_group_id":null,
"tags":null,
"subnet_id":"fd47ed9c-78a9-44c5-a712-06d251381e04"},
],
"instance_num":1
} </pre>
</div>
<div class="section" id="dcs-api-0312006__en-us_topic_0166889639_section11445132514139"><h4 class="sectiontitle">Status Code</h4><p id="dcs-api-0312006__en-us_topic_0166889639_p644552516130"><a href="#dcs-api-0312006__en-us_topic_0166889639_table3445625171318">Table 4</a> describes the status code of successful operations. For details about other status codes, see <a href="dcs-api-0312043.html#dcs-api-0312043__table5210141351517">Table 1</a>.</p>
<div class="tablenoborder"><a name="dcs-api-0312006__en-us_topic_0166889639_table3445625171318"></a><a name="en-us_topic_0166889639_table3445625171318"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312006__en-us_topic_0166889639_table3445625171318" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Status code</caption><thead align="left"><tr id="dcs-api-0312006__en-us_topic_0166889639_row184461225121311"><th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.5.3.2.3.1.1"><p id="dcs-api-0312006__en-us_topic_0166889639_p144682518130">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="84%" id="mcps1.3.5.3.2.3.1.2"><p id="dcs-api-0312006__en-us_topic_0166889639_p244602517132">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dcs-api-0312006__en-us_topic_0166889639_row94465257132"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.5.3.2.3.1.1 "><p id="dcs-api-0312006__en-us_topic_0166889639_p194464259135">200</p>
</td>
<td class="cellrowborder" valign="top" width="84%" headers="mcps1.3.5.3.2.3.1.2 "><p id="dcs-api-0312006__en-us_topic_0166889639_p1444614258139">All DCS instances of the tenant queried successfully.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dcs-api-0312003.html">Lifecycle Management APIs</a></div>
</div>
</div>
View Git Blame Copy Permalink