yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
b8dbeabef4e9f50c4a6f980dc75e27d5b8302df8
doc-exports/docs/dcs/api-ref/ListInstances.html
chenjunjie 63188fad94 DCS API 20240705 version 
Reviewed-by: Bobkova, Natalia <natalia.bobkova@t-systems.com>
Co-authored-by: chenjunjie <chenjunjie@huawei.com>
Co-committed-by: chenjunjie <chenjunjie@huawei.com>
2025-03-17 15:42:06 +00:00

836 lines
58 KiB
HTML
Raw Blame History

<a name="ListInstances"></a><a name="ListInstances"></a>
<h1 class="topictitle1">Querying All DCS Instances</h1>
<div id="body1708331107508"><div class="section" id="ListInstances__section1532510313594"><h4 class="sectiontitle">Function</h4><p id="ListInstances__p16325739599">This API is used to query DCS instances of a tenant, and allows you to specify query criteria.</p>
</div>
<div class="section" id="ListInstances__section8325103165912"><h4 class="sectiontitle">URI</h4><p id="ListInstances__p83261633598">GET /v2/{project_id}/instances</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListInstances__table1632718314597" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="ListInstances__row332612310592"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ListInstances__p123273312593">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ListInstances__p11327336598">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="ListInstances__p8328153175919">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="ListInstances__p183281134591">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListInstances__row33271731597"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ListInstances__p2032810335919">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ListInstances__p183283316594">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ListInstances__p8328113185914">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ListInstances__p23287345913">Project ID. For details, see <a href="dcs-api-0312045.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListInstances__table833014365918" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="ListInstances__row1329733599"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="ListInstances__p8330030592">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="ListInstances__p1733023185914">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="ListInstances__p7330131597">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="ListInstances__p03313320599">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListInstances__row1332913335910"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListInstances__p1033113317599">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListInstances__p18331103135917">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListInstances__p1333273205919">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListInstances__p10332193105918">Instance ID.</p>
</td>
</tr>
<tr id="ListInstances__row63297318590"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListInstances__p1133212385919">include_failure</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListInstances__p63321531590">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListInstances__p16332183105919">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListInstances__p13327315919">Whether to return the number of instances that fail to be created.</p>
<p id="ListInstances__p153324325912">If the value is <strong id="ListInstances__b2332173155918">true</strong>, the number of instances that failed to be created is returned. If the value is not <strong id="ListInstances__b18332103115914">true</strong>, the number is not returned.</p>
</td>
</tr>
<tr id="ListInstances__row132916335910"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListInstances__p133338385915">include_delete</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListInstances__p93333313595">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListInstances__p4333163115917">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListInstances__p1333833593">Whether to return the number of instances that have been deleted.</p>
<p id="ListInstances__p033316315590">If the value is <strong id="ListInstances__b123341037593">true</strong>, the number of instances that have been deleted is returned. If the value is not <strong id="ListInstances__b1133417395914">true</strong>, the number is not returned.</p>
</td>
</tr>
<tr id="ListInstances__row632993185910"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListInstances__p1433413105918">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListInstances__p8334183105911">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListInstances__p7334153155916">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListInstances__p1933416365920">Instance name.</p>
</td>
</tr>
<tr id="ListInstances__row193294325913"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListInstances__p163353395913">offset</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListInstances__p33355385913">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListInstances__p103359385912">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListInstances__p6335232595">Offset, which is the position where the query starts. The value must be greater than or equal to 0.</p>
</td>
</tr>
<tr id="ListInstances__row63291325919"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListInstances__p63351537596">limit</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListInstances__p153367395914">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListInstances__p23369312599">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListInstances__p7336932594">Number of records displayed on each page. The minimum value is <strong id="ListInstances__b11336732591">1</strong>. The maximum value is <strong id="ListInstances__b16336143205917">1000</strong>. If this parameter is not specified, 10 records are displayed on each page by default.</p>
</td>
</tr>
<tr id="ListInstances__row2329173195911"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListInstances__p13362395917">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListInstances__p1833617310594">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListInstances__p19336123115915">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListInstances__p4337331595">Instance status. For details, see <a href="dcs-api-0312047.html">DCS Instance Statuses</a>.</p>
</td>
</tr>
<tr id="ListInstances__row332919318593"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListInstances__p11337103185915">name_equal</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListInstances__p433719310594">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListInstances__p143372033598">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListInstances__p133713335913">Whether to search for the instance that precisely matches a specified instance name.</p>
<p id="ListInstances__p533753165920">The default value is <em id="ListInstances__i233753125912">false</em>, indicating that a fuzzy search is performed based on a specified instance name. If the value is <strong id="ListInstances__b833773135915">true</strong>, the instance that precisely matches a specified instance name is queried.</p>
</td>
</tr>
<tr id="ListInstances__row73301431593"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListInstances__p53372319598">tags</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListInstances__p333816313591">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListInstances__p18338432593">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListInstances__p203381130594">The query is based on the instance tag key and value. <em id="ListInstances__i18338203145919">{key}</em> indicates the tag key, and <em id="ListInstances__i533820320598">{value}</em> indicates the tag value.</p>
<p id="ListInstances__p6338163125919">To query instances with multiple tag keys and values, separate key-value pairs with commas (,).</p>
</td>
</tr>
<tr id="ListInstances__row2330103145917"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListInstances__p53388319592">ip</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListInstances__p933893125919">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListInstances__p73389316594">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListInstances__p163391138597">IP address of a DCS instance, for example, 192.168.7.146</p>
</td>
</tr>
<tr id="ListInstances__row7330535597"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListInstances__p734013205910">capacity</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListInstances__p1434019325910">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListInstances__p9340133175911">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListInstances__p18340143145910">DCS instance cache capacity in GB.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListInstances__section33409314599"><h4 class="sectiontitle">Request Parameters</h4><p id="ListInstances__p17341932591">None</p>
</div>
<div class="section" id="ListInstances__section634115385918"><h4 class="sectiontitle">Response Parameters</h4><p id="ListInstances__p2341113115914"><strong id="ListInstances__b934120315913">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListInstances__response_QueryInstanceListResp" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="ListInstances__row1534193105917"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.1"><p id="ListInstances__p18342123125915">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.2"><p id="ListInstances__p16342237598">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.4.1.3"><p id="ListInstances__p9342103155910">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListInstances__row1534115314592"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListInstances__p113431345912">instance_num</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListInstances__p934333105912">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListInstances__p203438313592">Number of instances.</p>
</td>
</tr>
<tr id="ListInstances__row103410317597"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListInstances__p03430312594">instances</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListInstances__p63436311599">Array of <a href="#ListInstances__response_InstanceListInfo">InstanceListInfo</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListInstances__p334353125912">Instance details array.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListInstances__response_InstanceListInfo"></a><a name="response_InstanceListInfo"></a><table cellpadding="4" cellspacing="0" summary="" id="ListInstances__response_InstanceListInfo" frame="border" border="1" rules="all"><caption><b>Table 4 </b>InstanceListInfo</caption><thead align="left"><tr id="ListInstances__row734413310591"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.1"><p id="ListInstances__p734712345915">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.2"><p id="ListInstances__p123471233593">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.4.2.4.1.3"><p id="ListInstances__p7347183105911">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListInstances__row1034413355914"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstances__p0347103145915">publicip_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstances__p634813375915">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstances__p534817335919">ID of the EIP bound to the DCS Redis instance.</p>
<p id="ListInstances__p1334803115911">This parameter is reserved. The value is <strong id="ListInstances__b133485365913">null</strong>.</p>
</td>
</tr>
<tr id="ListInstances__row734463155917"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstances__p534810315913">vpc_name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstances__p134815320595">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstances__p13481432594">VPC name.</p>
</td>
</tr>
<tr id="ListInstances__row163449313594"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstances__p1434833165917">charging_mode</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstances__p18348173125918">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstances__p193496310592">Billing mode. The value can be <strong id="ListInstances__b123499355911">0</strong>: pay-per-use.</p>
</td>
</tr>
<tr id="ListInstances__row10345113165918"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstances__p153492315915">vpc_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstances__p8349163135911">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstances__p634914316590">VPC ID.</p>
</td>
</tr>
<tr id="ListInstances__row1034511355919"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstances__p133491313591">subnet_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstances__p334913395918">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstances__p13498385919">Subnet ID.</p>
</td>
</tr>
<tr id="ListInstances__row934518325918"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstances__p3349183125910">security_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstances__p13350173115918">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstances__p153501337592">Security group ID.</p>
</td>
</tr>
<tr id="ListInstances__row1534511335912"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstances__p935013310597">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstances__p43507312598">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstances__p17350183105920">Creation time. Format: 2017-03-31T12:24:46.297Z</p>
</td>
</tr>
<tr id="ListInstances__row1734553155917"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstances__p123516319596">updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstances__p11351536598">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstances__p3351133175912">Update time. Format: 2017-03-31T19:24:46.297Z.</p>
</td>
</tr>
<tr id="ListInstances__row6345173115917"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstances__p8351932597">enable_ssl</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstances__p83514315918">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstances__p1351143115919">This parameter is reserved.</p>
</td>
</tr>
<tr id="ListInstances__row203455314594"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstances__p13524310592">max_memory</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstances__p10352153115914">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstances__p133521037597">Total memory size in MB.</p>
</td>
</tr>
<tr id="ListInstances__row23451832591"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstances__p14352173175918">used_memory</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstances__p535223175912">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstances__p1835211335918">Used memory size in MB.</p>
</td>
</tr>
<tr id="ListInstances__row113452035593"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstances__p203527395919">publicip_address</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstances__p2035219395918">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstances__p1635363145918">EIP bound to the DCS Redis instance.</p>
<p id="ListInstances__p43532030591">This parameter is reserved. The value is <strong id="ListInstances__b1435343205917">null</strong>.</p>
</td>
</tr>
<tr id="ListInstances__row113456335914"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstances__p19353103195915">capacity</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstances__p20353103185912">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstances__p5353163135916">Cache capacity (GB)</p>
</td>
</tr>
<tr id="ListInstances__row7345163125917"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstances__p113531739596">capacity_minor</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstances__p12354203135917">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstances__p19354103115918">Capacity (GB) of a small DCS instance (smaller than 1 GB).</p>
</td>
</tr>
<tr id="ListInstances__row183451938591"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstances__p9354138592">order_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstances__p1435423125911">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstances__p183544375910">Order ID. The value is null when a pay-per-use instance is created.</p>
</td>
</tr>
<tr id="ListInstances__row63450355913"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstances__p3354036591">maintain_begin</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstances__p23543318592">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstances__p183549305913">UTC time when the maintenance time window starts. The format is HH:mm:ss.</p>
</td>
</tr>
<tr id="ListInstances__row143457316595"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstances__p8355836593">maintain_end</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstances__p173556313599">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstances__p1635523175915">UTC time when the maintenance time window ends. The format is HH:mm:ss.</p>
</td>
</tr>
<tr id="ListInstances__row1334513195920"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstances__p15355936591">engine</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstances__p15356163195913">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstances__p153564313593">Cache engine.</p>
</td>
</tr>
<tr id="ListInstances__row3345113125910"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstances__p1535673165914">engine_version</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstances__p9356738594">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstances__p3356153195919">Cache version.</p>
</td>
</tr>
<tr id="ListInstances__row7345736596"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstances__p12357113175910">service_upgrade</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstances__p8357153145918">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstances__p1435718335915">Whether the instance has an upgrade task.</p>
<ul id="ListInstances__ul12357163145912"><li id="ListInstances__li93577312593"><strong id="ListInstances__b1335714317593">true</strong>: yes</li><li id="ListInstances__li5357113115916"><strong id="ListInstances__b1435783185910">false</strong>: no</li></ul>
</td>
</tr>
<tr id="ListInstances__row15345439592"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstances__p1035719310598">no_password_access</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstances__p173575315596">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstances__p4359332591">Indicates whether the instance can be accessed without a password.</p>
<ul id="ListInstances__ul1635919312599"><li id="ListInstances__li173598310599"><strong id="ListInstances__b163591031592">true</strong>: The instance can be accessed without a password.</li><li id="ListInstances__li536016317598"><strong id="ListInstances__b1636018375911">false</strong>: The instance can be accessed only after password authentication.</li></ul>
</td>
</tr>
<tr id="ListInstances__row15345837590"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstances__p73605325919">service_task_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstances__p1036073185914">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstances__p123601339599">Upgrade task ID.</p>
<ul id="ListInstances__ul536073125920"><li id="ListInstances__li1536013314599">If the value of <strong id="ListInstances__b23608365915">service_upgrade</strong> is set to <strong id="ListInstances__b1736053135917">true</strong>, the value of this parameter is the ID of the upgrade task.</li><li id="ListInstances__li536093185914">If the value of <strong id="ListInstances__b43601631597">service_upgrade</strong> is set to <strong id="ListInstances__b11360135591">false</strong>, the value of this parameter is empty.</li></ul>
</td>
</tr>
<tr id="ListInstances__row1834620355919"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstances__p143603310593">ip</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstances__p83613311598">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstances__p7361193125911">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="ListInstances__row1334663135917"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstances__p536115395912">access_user</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstances__p1036119395918">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstances__p936173155913">Username used for accessing a DCS instance after password authentication.</p>
</td>
</tr>
<tr id="ListInstances__row1234616311593"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstances__p1636117314595">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstances__p1136113135911">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstances__p636133125918">Instance ID.</p>
</td>
</tr>
<tr id="ListInstances__row334616325911"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstances__p113628318598">enable_publicip</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstances__p153620318595">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstances__p103621831596">This parameter is reserved.</p>
</td>
</tr>
<tr id="ListInstances__row93461530591"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstances__p173623375916">port</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstances__p1036263105916">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstances__p63621237591">Port of the DCS instance.</p>
</td>
</tr>
<tr id="ListInstances__row33461305920"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstances__p536219319594">user_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstances__p123629319594">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstances__p33629310599">User ID.</p>
</td>
</tr>
<tr id="ListInstances__row12346835593"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstances__p1436318315916">user_name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstances__p236319317591">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstances__p736313365919">Username.</p>
</td>
</tr>
<tr id="ListInstances__row334620312591"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstances__p193632035594">domain_name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstances__p1436314316596">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstances__p436318335910">Domain name of the instance.</p>
</td>
</tr>
<tr id="ListInstances__row1346131596"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstances__p13631338599">readonly_domain_name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstances__p936310316596">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstances__p14364103175915">Read-only domain name of the instance. This parameter is available only for master/standby instances.</p>
</td>
</tr>
<tr id="ListInstances__row8346138593"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstances__p436411375912">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstances__p93641831591">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstances__p13364183105914">Instance name.</p>
</td>
</tr>
<tr id="ListInstances__row113463316596"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstances__p183641932596">spec_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstances__p14364037598">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstances__p536483145919">Product flavor.</p>
</td>
</tr>
<tr id="ListInstances__row1234619316595"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstances__p1736516312593">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstances__p53651533596">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstances__p1542834592">Instance status. For details, see <a href="dcs-api-0312047.html">DCS Instance Statuses</a>.</p>
</td>
</tr>
<tr id="ListInstances__row434623165920"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstances__p55425395917">tags</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstances__p205425315590">Array of <a href="#ListInstances__response_ResourceTag">ResourceTag</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstances__p25424305919">Instance tag key and value.</p>
</td>
</tr>
<tr id="ListInstances__row17346836597"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstances__p05432314595">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstances__p4543332595">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstances__p1254313375919">Enterprise project ID.</p>
</td>
</tr>
<tr id="ListInstances__row934693145913"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstances__p354318314594">description</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstances__p205431336595">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstances__p45430335916">Description about the instance.</p>
</td>
</tr>
<tr id="ListInstances__row103461385911"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstances__p254323155917">cpu_type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstances__p254319318596">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstances__p9543183185915">CPU type of the instance. Generally, the value is <strong id="ListInstances__b1454373175914">x86_64</strong> or <strong id="ListInstances__b554315375918">aarch64</strong>.</p>
</td>
</tr>
<tr id="ListInstances__row1034612314591"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstances__p05437395911">az_codes</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstances__p4543038591">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstances__p13543123105913">AZs where there are available resources.</p>
</td>
</tr>
<tr id="ListInstances__row1534613105918"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstances__p1543163195910">features</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstances__p654318385913"><a href="#ListInstances__response_Features">Features</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstances__p3543123105914">Features supported by the instance.</p>
</td>
</tr>
<tr id="ListInstances__row103477385916"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstances__p12543153145914">sub_status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstances__p1954383195913">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstances__p195438345916">Instance sub-status.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListInstances__response_ResourceTag"></a><a name="response_ResourceTag"></a><table cellpadding="4" cellspacing="0" summary="" id="ListInstances__response_ResourceTag" frame="border" border="1" rules="all"><caption><b>Table 5 </b>ResourceTag</caption><thead align="left"><tr id="ListInstances__row73689319597"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.1"><p id="ListInstances__p454453185917">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.2"><p id="ListInstances__p14544430590">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.5.2.4.1.3"><p id="ListInstances__p1854453105917">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListInstances__row15368153135916"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListInstances__p25448385918">key</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListInstances__p454413313596">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListInstances__p4544035594">Tag key.</p>
</td>
</tr>
<tr id="ListInstances__row93688355910"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListInstances__p1454420318592">value</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListInstances__p7544133165910">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListInstances__p125444314595">Tag value.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListInstances__response_Features"></a><a name="response_Features"></a><table cellpadding="4" cellspacing="0" summary="" id="ListInstances__response_Features" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Features</caption><thead align="left"><tr id="ListInstances__row203704375915"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.6.2.4.1.1"><p id="ListInstances__p10545113175920">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.6.2.4.1.2"><p id="ListInstances__p854517318593">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.6.2.4.1.3"><p id="ListInstances__p75451936596">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListInstances__row537017316591"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListInstances__p85456312591">support_acl</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListInstances__p5545163165913">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ListInstances__p15456375920">Whether ACL is supported.</p>
<ul id="ListInstances__ul115452385917"><li id="ListInstances__li1454512355919"><strong id="ListInstances__b2545153105914">true</strong>: Yes</li><li id="ListInstances__li185455314593"><strong id="ListInstances__b25456313598">false</strong>: No</li></ul>
</td>
</tr>
<tr id="ListInstances__row11370133105918"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListInstances__p1154513315915">support_transparent_client_ip</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListInstances__p854510313595">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ListInstances__p354517315595">Whether client IP pass-through is enabled.</p>
<ul id="ListInstances__ul1545938591"><li id="ListInstances__li135458317594"><strong id="ListInstances__b054519311598">true</strong>: Yes</li><li id="ListInstances__li45451934591"><strong id="ListInstances__b1454516335916">false</strong>: No</li></ul>
</td>
</tr>
<tr id="ListInstances__row113702365913"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListInstances__p165451839591">support_ssl</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListInstances__p8545434596">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ListInstances__p2054512317592">Whether SSL is supported.</p>
<ul id="ListInstances__ul16545163195912"><li id="ListInstances__li1254553145911"><strong id="ListInstances__b18545203125917">true</strong>: Yes</li><li id="ListInstances__li195457305910"><strong id="ListInstances__b125453375917">false</strong>: No</li></ul>
</td>
</tr>
<tr id="ListInstances__row13706310594"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListInstances__p35451734595">support_audit_log</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListInstances__p1054616395917">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ListInstances__p1854616365915">Whether audit logs are supported</p>
<ul id="ListInstances__ul115461320593"><li id="ListInstances__li7546736596"><strong id="ListInstances__b115465325911">true</strong>: Yes</li><li id="ListInstances__li954673105910"><strong id="ListInstances__b154615314596">false</strong>: No</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ListInstances__p654663125912"><strong id="ListInstances__b185461336596">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListInstances__response_ErrorResponse" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Response body parameters</caption><thead align="left"><tr id="ListInstances__row133748375917"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.8.2.4.1.1"><p id="ListInstances__p654610325912">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.8.2.4.1.2"><p id="ListInstances__p19546143195916">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.8.2.4.1.3"><p id="ListInstances__p205469345911">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListInstances__row23742305915"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.1 "><p id="ListInstances__p25469310594">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.2 "><p id="ListInstances__p15465335912">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.8.2.4.1.3 "><p id="ListInstances__p354613314598">Error message.</p>
</td>
</tr>
<tr id="ListInstances__row113740355914"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.1 "><p id="ListInstances__p054693195919">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.2 "><p id="ListInstances__p1546532598">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.8.2.4.1.3 "><p id="ListInstances__p354620314598">Error code.</p>
</td>
</tr>
<tr id="ListInstances__row113741337593"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.1 "><p id="ListInstances__p55462335911">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.2 "><p id="ListInstances__p6546133195915">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.8.2.4.1.3 "><p id="ListInstances__p1854653165918">Extended error information. This parameter is not used currently and is set to <strong id="ListInstances__b654673165911">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ListInstances__p1854693165915"><strong id="ListInstances__b2546193185910">Status code: 401</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListInstances__table173776314592" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Response body parameters</caption><thead align="left"><tr id="ListInstances__row1437714320593"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.10.2.4.1.1"><p id="ListInstances__p1554615395918">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.10.2.4.1.2"><p id="ListInstances__p154663165913">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.10.2.4.1.3"><p id="ListInstances__p13546103175911">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListInstances__row637714318597"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.1 "><p id="ListInstances__p754623135913">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.2 "><p id="ListInstances__p1654719305916">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.10.2.4.1.3 "><p id="ListInstances__p054712314598">Error message.</p>
</td>
</tr>
<tr id="ListInstances__row12377183195915"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.1 "><p id="ListInstances__p3547132595">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.2 "><p id="ListInstances__p1654710316593">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.10.2.4.1.3 "><p id="ListInstances__p185475355910">Error code.</p>
</td>
</tr>
<tr id="ListInstances__row153778315592"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.1 "><p id="ListInstances__p205472315917">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.2 "><p id="ListInstances__p95471932592">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.10.2.4.1.3 "><p id="ListInstances__p135478316592">Extended error information. This parameter is not used currently and is set to <strong id="ListInstances__b20547333591">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ListInstances__p25470313599"><strong id="ListInstances__b1554733135915">Status code: 403</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListInstances__table123791932595" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Response body parameters</caption><thead align="left"><tr id="ListInstances__row93793355920"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.12.2.4.1.1"><p id="ListInstances__p205472316595">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.12.2.4.1.2"><p id="ListInstances__p354715385915">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.12.2.4.1.3"><p id="ListInstances__p1154710317591">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListInstances__row123791332597"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.1 "><p id="ListInstances__p554753195913">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.2 "><p id="ListInstances__p11547153125914">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.12.2.4.1.3 "><p id="ListInstances__p185479317591">Error message.</p>
</td>
</tr>
<tr id="ListInstances__row9379203105913"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.1 "><p id="ListInstances__p125478375911">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.2 "><p id="ListInstances__p5547531597">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.12.2.4.1.3 "><p id="ListInstances__p95478319593">Error code.</p>
</td>
</tr>
<tr id="ListInstances__row2379163205915"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.1 "><p id="ListInstances__p12547133105919">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.2 "><p id="ListInstances__p165471632598">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.12.2.4.1.3 "><p id="ListInstances__p3547143125918">Extended error information. This parameter is not used currently and is set to <strong id="ListInstances__b65471434595">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ListInstances__p12547839596"><strong id="ListInstances__b1354712315597">Status code: 404</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListInstances__table738033165918" frame="border" border="1" rules="all"><caption><b>Table 10 </b>Response body parameters</caption><thead align="left"><tr id="ListInstances__row1138119375917"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.14.2.4.1.1"><p id="ListInstances__p25471038595">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.14.2.4.1.2"><p id="ListInstances__p11548434598">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.14.2.4.1.3"><p id="ListInstances__p15548183105917">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListInstances__row73812317599"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.1 "><p id="ListInstances__p354813345918">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.2 "><p id="ListInstances__p1254823115917">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.14.2.4.1.3 "><p id="ListInstances__p1754811305910">Error message.</p>
</td>
</tr>
<tr id="ListInstances__row1038113185916"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.1 "><p id="ListInstances__p145485375912">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.2 "><p id="ListInstances__p135486325920">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.14.2.4.1.3 "><p id="ListInstances__p19548103185913">Error code.</p>
</td>
</tr>
<tr id="ListInstances__row338114311594"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.1 "><p id="ListInstances__p165484319595">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.2 "><p id="ListInstances__p155487311591">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.14.2.4.1.3 "><p id="ListInstances__p2548133125917">Extended error information. This parameter is not used currently and is set to <strong id="ListInstances__b11548938593">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ListInstances__p15548123165918"><strong id="ListInstances__b354816317597">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListInstances__table11382173155918" frame="border" border="1" rules="all"><caption><b>Table 11 </b>Response body parameters</caption><thead align="left"><tr id="ListInstances__row1138218314591"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.16.2.4.1.1"><p id="ListInstances__p1854893145920">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.16.2.4.1.2"><p id="ListInstances__p17548193145914">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.16.2.4.1.3"><p id="ListInstances__p65483310599">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListInstances__row1538214395912"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.16.2.4.1.1 "><p id="ListInstances__p12548536597">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.16.2.4.1.2 "><p id="ListInstances__p4548123175911">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.16.2.4.1.3 "><p id="ListInstances__p55487335912">Error message.</p>
</td>
</tr>
<tr id="ListInstances__row10382636595"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.16.2.4.1.1 "><p id="ListInstances__p65480355911">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.16.2.4.1.2 "><p id="ListInstances__p6548431594">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.16.2.4.1.3 "><p id="ListInstances__p165481030594">Error code.</p>
</td>
</tr>
<tr id="ListInstances__row113831236597"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.16.2.4.1.1 "><p id="ListInstances__p55481315916">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.16.2.4.1.2 "><p id="ListInstances__p554883175913">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.16.2.4.1.3 "><p id="ListInstances__p18548337598">Extended error information. This parameter is not used currently and is set to <strong id="ListInstances__b195482318599">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListInstances__section65481936593"><h4 class="sectiontitle">Example Requests</h4><pre class="screen" id="ListInstances__screen354820319599">GET https://{dcs_endpoint}/v2/{project_id}/instances?offset=0&amp;limit=10&amp;name={name}&amp;status={status}&amp;id={id}&amp;include_failure=true&amp;include_delete=true&amp;name_equal=false</pre>
</div>
<div class="section" id="ListInstances__section2054923105911"><h4 class="sectiontitle">Example Responses</h4><p id="ListInstances__p321714467211"><strong id="ListInstances__b721717461627">Status code: 200</strong></p>
<p id="ListInstances__p8934124565619">All DCS instances queried successfully.</p>
<pre class="screen" id="ListInstances__screen189341452563">{
"instance_num" : 1,
"instances" : [ {
"publicip_id" : { },
"vpc_name" : "dcs-beta",
"charging_mode" : 0,
"vpc_id" : "5e37b3be-950a-48e1-b498-65b63d336481",
"subnet_id" : "a4112635-3ec0-471c-95c3-5cf49b9533af",
"user_name" : "clouduser",
"created_at" : "2022-08-29T09:00:34.335Z",
"updated_at" : "2022-08-29T09:00:34.335Z",
"enable_ssl" : false,
"max_memory" : 128,
"publicip_address" : null,
"capacity" : 0,
"order_id" : null,
"maintain_begin" : "18:00:00",
"engine" : "Redis",
"maintain_end" : "19:00:00",
"capacity_minor" : ".125",
"service_upgrade" : false,
"no_password_access" : true,
"service_task_id" : "",
"ip" : "192.168.0.195",
"used_memory" : 2,
"access_user" : null,
"instance_id" : "c830053e-d5a3-4bc0-b6d6-ca37d1ea9dd5",
"enable_publicip" : false,
"port" : 6379,
"user_id" : "d53977d1adfb49c5b025ba7d33a13fd7",
"domain_name" : "redis-c830053e-d5a3-4bc0-b6d6-ca37d1ea9dd5.dcs.**cloud.com",
"name" : "dcs-lpvo0829",
"spec_code" : "redis.ha.xu1.tiny.r2.128",
"engine_version" : "5.0",
"status" : "RUNNING",
"security_group_id" : "securityGroupId",
"enterprise_project_id" : 0,
"tags" : [ {
"key" : 1,
"value" : "DCS"
} ],
"az_codes" : [ "region01", "region02" ],
"description" : "redis instance description",
"cpu_type" : "x86_64",
"features" : {
"support_acl" : true,
"support_transparent_client_ip" : true,
"support_ssl" : false,
"support_audit_log" : false
},
"sub_status" : "normal"
} ]
}</pre>
<p id="ListInstances__p1154911311592"><strong id="ListInstances__b1354963135914">Status code: 400</strong></p>
<p id="ListInstances__p1954917320597">Invalid request.</p>
<pre class="screen" id="ListInstances__screen145495318591">{
"error_code" : "DCS.4800",
"error_msg" : "Invalid offset in the request."
}</pre>
</div>
<div class="section" id="ListInstances__section1454913325910"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListInstances__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="ListInstances__row113851430596"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="ListInstances__p125493335910">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="ListInstances__p145493313593">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListInstances__row438515318595"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListInstances__p195493316596">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListInstances__p1654913195916">All instances are listed successfully.</p>
</td>
</tr>
<tr id="ListInstances__row133853310594"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListInstances__p254914335917">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListInstances__p12549113115910">Invalid request.</p>
</td>
</tr>
<tr id="ListInstances__row438620315594"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListInstances__p454910325917">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListInstances__p254920315591">Invalid authentication information.</p>
</td>
</tr>
<tr id="ListInstances__row238611311597"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListInstances__p25499395916">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListInstances__p10549143205917">The request is rejected.</p>
</td>
</tr>
<tr id="ListInstances__row938611345914"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListInstances__p115491139595">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListInstances__p4549183175919">The requested resource is not found.</p>
</td>
</tr>
<tr id="ListInstances__row33862318591"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListInstances__p135491638595">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListInstances__p135491338597">Internal service error.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListInstances__section95491234596"><h4 class="sectiontitle">Error Codes</h4><p id="ListInstances__p1954914315597">See <a href="ErrorCode.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="LifecycleManagement.html">Lifecycle Management</a></div>
</div>
</div>
View Git Blame Copy Permalink