vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/geminidb/api-ref/nosql_05_0016.html
Ru, Li Yi 37b97ffc06 geminidb_api 
Reviewed-by: Boka, Ladislav <ladislav.boka@t-systems.com>
Co-authored-by: Ru, Li Yi <liyiru7@huawei.com>
Co-committed-by: Ru, Li Yi <liyiru7@huawei.com>
2024-07-04 11:26:33 +00:00

699 lines
50 KiB
HTML
Raw Blame History

<a name="nosql_05_0016"></a><a name="nosql_05_0016"></a>
<h1 class="topictitle1">Querying Instances and Details</h1>
<div id="body42460955120"><div class="section" id="nosql_05_0016__section16247169175111"><h4 class="sectiontitle">Function</h4><p id="nosql_05_0016__p19247495514">This API is used to query instances and details based on specified conditions.</p>
</div>
<div class="section" id="nosql_05_0016__section10248119105117"><h4 class="sectiontitle">Constraints</h4><p id="nosql_05_0016__nosql_05_0015_p153256865116">This API supports GeminiDB Cassandra instances.</p>
</div>
<div class="section" id="nosql_05_0016__section72693985115"><h4 class="sectiontitle">URI</h4><p id="nosql_05_0016__p122707955119">GET https://{Endpoint}/v3/{project_id}/instances</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0016__table1027417912511" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="nosql_05_0016__row132721891518"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="nosql_05_0016__p1274094516">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="nosql_05_0016__p182751915517">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.98%" id="mcps1.3.3.3.2.5.1.3"><p id="nosql_05_0016__p82768910515">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40.02%" id="mcps1.3.3.3.2.5.1.4"><p id="nosql_05_0016__p727720925112">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_05_0016__row122723911511"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="nosql_05_0016__p1727814911515">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="nosql_05_0016__p1227914911513">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="19.98%" headers="mcps1.3.3.3.2.5.1.3 "><p id="nosql_05_0016__p228014911513">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.02%" headers="mcps1.3.3.3.2.5.1.4 "><p id="nosql_05_0016__p42814915515">Project ID of a tenant in a region. To obtain this value, see <a href="nosql_projectid.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0016__table32845925114" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query parameters</caption><thead align="left"><tr id="nosql_05_0016__row62821495517"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="nosql_05_0016__p172855905116">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.2"><p id="nosql_05_0016__p162864975111">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.3"><p id="nosql_05_0016__p7287199175119">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.4.2.5.1.4"><p id="nosql_05_0016__p72887919512">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_05_0016__row02826914510"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="nosql_05_0016__p62899915518">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="nosql_05_0016__p162908945110">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="nosql_05_0016__p429114935120">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="nosql_05_0016__p329216985116">Instance ID.</p>
<p id="nosql_05_0016__p1154594922510">If you enter an instance ID starting with an asterisk (*), fuzzy search results are returned. If you enter a valid instance ID, an exact result is returned.</p>
</td>
</tr>
<tr id="nosql_05_0016__row82821394518"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="nosql_05_0016__p129429165114">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="nosql_05_0016__p029518975114">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="nosql_05_0016__p102996912519">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="nosql_05_0016__p143004918514">Instance name.</p>
<p id="nosql_05_0016__p1069142722615">If you enter an instance name starting with an asterisk (*), fuzzy search results are returned. If you enter a valid instance name, an exact result is returned.</p>
</td>
</tr>
<tr id="nosql_05_0016__row1928216925110"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="nosql_05_0016__p103058935117">datastore_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="nosql_05_0016__p1430618945115">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="nosql_05_0016__p173074915513">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="nosql_05_0016__p23084914519">Database type. The value can be:</p>
<p id="nosql_05_0016__p712310465405"><strong id="nosql_05_0016__b185361809910">cassandra</strong>, indicating that <span id="nosql_05_0016__text5790123765117">GeminiDB Cassandra</span> instances are queried.</p>
<p id="nosql_05_0016__p1912394610403"> </p>
</td>
</tr>
<tr id="nosql_05_0016__row4283169165110"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="nosql_05_0016__p43161698511">mode</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="nosql_05_0016__p12317119135118">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="nosql_05_0016__p931999155119">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="nosql_05_0016__p163201895519">Instance type. The value can be:</p>
<p id="nosql_05_0016__p16547324105017"><strong id="nosql_05_0016__b1078155513189">Cluster</strong>, indicating that GeminiDB Cassandra cluster instances are queried.</p>
<p id="nosql_05_0016__p6197153310392">The system ignores this parameter if parameter <strong id="nosql_05_0016__b1060613510339">datastore_type</strong> is not transferred.</p>
</td>
</tr>
<tr id="nosql_05_0016__row22833915115"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="nosql_05_0016__p13328189175118">vpc_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="nosql_05_0016__p12329891517">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="nosql_05_0016__p933029105113">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="nosql_05_0016__p333216911515">VPC ID. You can obtain the value with either of the following methods:</p>
<ul id="nosql_05_0016__ul250415512347"><li id="nosql_05_0016__en-us_topic_0198711251_li67651171359">Method 1: Log in to the VPC console and view the VPC ID on the VPC details page.</li><li id="nosql_05_0016__en-us_topic_0198711251_li17405132214423">Method 2: See section "Querying VPCs" in the <em id="nosql_05_0016__i201346613417">Virtual Private Cloud API Reference</em>.</li></ul>
</td>
</tr>
<tr id="nosql_05_0016__row82836925110"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="nosql_05_0016__p233869185111">subnet_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="nosql_05_0016__p23391196510">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="nosql_05_0016__p1334013925114">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="nosql_05_0016__p53413912518">Subnet ID. You can obtain the subnet ID with either of the following methods:</p>
<ul id="nosql_05_0016__ul9152102763919"><li id="nosql_05_0016__en-us_topic_0198711251_li121534277395">Method 1: Log in to the VPC console and click the target subnet on the <strong id="nosql_05_0016__b14666418163416">Subnets</strong> page. You can view the network ID on the displayed page.</li><li id="nosql_05_0016__en-us_topic_0198711251_li628710358517">Method 2: See section "Querying Subnets" in the <em id="nosql_05_0016__i16111240183418">Virtual Private Cloud API Reference</em>.</li></ul>
</td>
</tr>
<tr id="nosql_05_0016__row1728369145110"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="nosql_05_0016__p634918995115">offset</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="nosql_05_0016__p73503955116">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="nosql_05_0016__p5351899518">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="nosql_05_0016__p1435213925115">Index position. The query starts from the next instance creation time indexed by this parameter under a specified project. If offset is set to N, the resource query starts from the N+1 piece of data.</p>
<p id="nosql_05_0016__p235349205111">The value must be no less than <strong id="nosql_05_0016__b15608195114348">0</strong>. If this parameter is not transferred, the index offset is <strong id="nosql_05_0016__b191819289496">0</strong> by default, indicating that the query starts from the latest created instance.</p>
</td>
</tr>
<tr id="nosql_05_0016__row628329105113"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="nosql_05_0016__p1535499125110">limit</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="nosql_05_0016__p135514935119">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="nosql_05_0016__p153561796519">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="nosql_05_0016__p13571890517">Maximum number of instances that can be queried.</p>
<p id="nosql_05_0016__p63587975111">The value ranges from <strong id="nosql_05_0016__b65714176356">1</strong> to <strong id="nosql_05_0016__b1259181733515">100</strong>. If this parameter is not transferred, the first 100 instances are queried by default.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="nosql_05_0016__section1359197515"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0016__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="nosql_05_0016__row1836011915517"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_05_0016__p93632985112">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="nosql_05_0016__p12363595519">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="nosql_05_0016__p1236479105116">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="nosql_05_0016__p936512917519">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_05_0016__row1436018955116"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_05_0016__p169541915184517">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_05_0016__p536718925118">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_05_0016__p193689915115">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_05_0016__p1369998511">User token.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="nosql_05_0016__section5370896516"><h4 class="sectiontitle">Response Parameters</h4><p id="nosql_05_0016__p12371599514"><strong id="nosql_05_0016__b9266555103116">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0016__response_ListInstancesResponseBody" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="nosql_05_0016__row33721595518"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="nosql_05_0016__p1737316911512">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.5.3.2.4.1.2"><p id="nosql_05_0016__p11374209135110">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.3.2.4.1.3"><p id="nosql_05_0016__p637619920516">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_05_0016__row1937259195113"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="nosql_05_0016__p13773914519">instances</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.3.2.4.1.2 "><p id="nosql_05_0016__p6378139125113">Array of <a href="#nosql_05_0016__response_ListInstancesResult">ListInstancesResult</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="nosql_05_0016__p11379893515">Instance information.</p>
</td>
</tr>
<tr id="nosql_05_0016__row637211925110"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="nosql_05_0016__p1838019115119">total_count</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.3.2.4.1.2 "><p id="nosql_05_0016__p1238117985114">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="nosql_05_0016__p238214914516">Total number of records.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="nosql_05_0016__response_ListInstancesResult"></a><a name="response_ListInstancesResult"></a><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0016__response_ListInstancesResult" frame="border" border="1" rules="all"><caption><b>Table 5 </b>ListInstancesResult</caption><thead align="left"><tr id="nosql_05_0016__row1438315911515"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.1"><p id="nosql_05_0016__p2390179175115">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.5.4.2.4.1.2"><p id="nosql_05_0016__p53911498510">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.4.2.4.1.3"><p id="nosql_05_0016__p23921914513">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_05_0016__row163847915514"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_05_0016__p63931797514">id</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_05_0016__p133942091514">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_05_0016__p18395209135118">Instance ID.</p>
</td>
</tr>
<tr id="nosql_05_0016__row1438449175111"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_05_0016__p10396139125119">name</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_05_0016__p139710911512">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_05_0016__p11397189105113">Instance name.</p>
</td>
</tr>
<tr id="nosql_05_0016__row10384119145114"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_05_0016__p1439815985113">status</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_05_0016__p143991918513">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_05_0016__p54011193513">Instance status.</p>
<p id="nosql_05_0016__p144011398516">The value can be:</p>
<ul id="nosql_05_0016__ul34021897516"><li id="nosql_05_0016__li15403197511"><strong id="nosql_05_0016__b1564864191110">normal</strong>, indicating that the instance is running normally.</li><li id="nosql_05_0016__li114033911517"><strong id="nosql_05_0016__b10132145651119">abnormal</strong>, indicating that the instance is abnormal.</li><li id="nosql_05_0016__li440411912516"><strong id="nosql_05_0016__b639013251220">creating</strong>, indicating that the instance is being created.</li><li id="nosql_05_0016__li640512914518"><strong id="nosql_05_0016__b2095869181217">frozen</strong>, indicating that the instance is frozen.</li><li id="nosql_05_0016__li540611915110"><strong id="nosql_05_0016__b13837201771220">data_disk_full</strong>, indicating that the instance disk is full.</li><li id="nosql_05_0016__li340717975110"><strong id="nosql_05_0016__b17792122519124">createfail</strong>, indicating that the instance failed to be created.</li><li id="nosql_05_0016__li154083918514"><strong id="nosql_05_0016__b79186332128">enlargefail</strong>, indicating that nodes failed to be added to the instance.</li></ul>
</td>
</tr>
<tr id="nosql_05_0016__row113841891514"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_05_0016__p144093915514">port</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_05_0016__p541019965116">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_05_0016__p1341117935112">Database port.</p>
</td>
</tr>
<tr id="nosql_05_0016__row11384149185117"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_05_0016__p164126955111">mode</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_05_0016__p3413999516">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_05_0016__p2414209105116">Instance type. This parameter is the same as the corresponding request parameter.</p>
</td>
</tr>
<tr id="nosql_05_0016__row738489125116"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_05_0016__p18415797513">region</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_05_0016__p34161916511">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_05_0016__p1741718935112">Region where the instance is deployed.</p>
</td>
</tr>
<tr id="nosql_05_0016__row133844985110"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_05_0016__p1241869205116">datastore</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_05_0016__p1141949165113"><a href="#nosql_05_0016__response_ListInstancesDatastoreResult">ListInstancesDatastoreResult</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_05_0016__p54199912514">Database information.</p>
</td>
</tr>
<tr id="nosql_05_0016__row1238479105111"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_05_0016__p94201917511">engine</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_05_0016__p5421594517">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_05_0016__p44229975118">Storage engine.</p>
<p id="nosql_05_0016__p24233910511">The value is <strong id="nosql_05_0016__b57047496133">rocksDB</strong>.</p>
</td>
</tr>
<tr id="nosql_05_0016__row103841595518"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_05_0016__p184242914518">created</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_05_0016__p12424129175117">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_05_0016__p942669185111">Instance creation time.</p>
</td>
</tr>
<tr id="nosql_05_0016__row838414995116"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_05_0016__p104261397516">updated</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_05_0016__p144274955117">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_05_0016__p1442859155115">Time when an instance is updated.</p>
</td>
</tr>
<tr id="nosql_05_0016__row93856911511"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_05_0016__p134291295516">db_user_name</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_05_0016__p1430296518">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_05_0016__p1743110910511">Default username. The value is <strong id="nosql_05_0016__b119308294149">rwuser</strong>.</p>
</td>
</tr>
<tr id="nosql_05_0016__row18385149165119"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_05_0016__p20432159165118">vpc_id</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_05_0016__p143311915510">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_05_0016__p16433209165118">VPC ID.</p>
</td>
</tr>
<tr id="nosql_05_0016__row938516918511"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_05_0016__p64341793517">subnet_id</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_05_0016__p3435799515">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_05_0016__p16436119165119">Subnet ID.</p>
<p id="nosql_05_0016__p643915935118">One <span id="nosql_05_0016__text78441114155410">GeminiDB Cassandra</span> instance may use multiple subnets. For the subnet ID, see <a href="#nosql_05_0016__response_ListInstancesNodeResult">Table 10</a>.</p>
</td>
</tr>
<tr id="nosql_05_0016__row33857925117"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_05_0016__p13441169155115">security_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_05_0016__p15442209155114">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_05_0016__p1544212918515">Security group ID.</p>
</td>
</tr>
<tr id="nosql_05_0016__row838518917514"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_05_0016__p1144317918518">backup_strategy</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_05_0016__p184441296517"><a href="#nosql_05_0016__response_ListInstancesBackupStrategyResult">ListInstancesBackupStrategyResult</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_05_0016__p9445209195119">Backup policy.</p>
</td>
</tr>
<tr id="nosql_05_0016__row1238512905116"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_05_0016__p15446393518">pay_mode</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_05_0016__p11447209205116">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_05_0016__p04511697514">The value is <strong id="nosql_05_0016__b146426691917">0</strong>.</p>
</td>
</tr>
<tr id="nosql_05_0016__row338514914517"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_05_0016__p174529913515">maintenance_window</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_05_0016__p3453119145114">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_05_0016__p445412905113">Maintenance time window.</p>
</td>
</tr>
<tr id="nosql_05_0016__row113865945118"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_05_0016__p74555913511">groups</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_05_0016__p1945617919514">Array of <a href="#nosql_05_0016__response_ListInstancesGroupResult">ListInstancesGroupResult</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_05_0016__p645739115114">Group information.</p>
</td>
</tr>
<tr id="nosql_05_0016__row16386109175119"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_05_0016__p545815945118">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_05_0016__p13459995510">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_05_0016__p346013925116">Enterprise project ID.</p>
<p id="nosql_05_0016__p64600995115">If you set this parameter to <strong id="nosql_05_0016__b1930018379199">0</strong>, the resource belongs to the <strong id="nosql_05_0016__b15301163741910">default</strong> enterprise project.</p>
</td>
</tr>
<tr id="nosql_05_0016__row438679185114"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_05_0016__p194611896511">time_zone</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_05_0016__p846209125111">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_05_0016__p154633985119">Time zone.</p>
</td>
</tr>
<tr id="nosql_05_0016__row33861097512"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_05_0016__p1546420916514">actions</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_05_0016__p101801510165110">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_05_0016__p111811910115120">Operation that is executed on the instance. Example values:</p>
<ul id="nosql_05_0016__ul8419611211"><li id="nosql_05_0016__li184186202118"><strong id="nosql_05_0016__b0515171164619">CREATE</strong></li><li id="nosql_05_0016__li199983911214"><strong id="nosql_05_0016__b91576105464">REBOOT</strong></li><li id="nosql_05_0016__li121031148132120"><strong id="nosql_05_0016__b41421816184615">RESTORE</strong></li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="nosql_05_0016__response_ListInstancesDatastoreResult"></a><a name="response_ListInstancesDatastoreResult"></a><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0016__response_ListInstancesDatastoreResult" frame="border" border="1" rules="all"><caption><b>Table 6 </b>ListInstancesDatastoreResult</caption><thead align="left"><tr id="nosql_05_0016__row14473298515"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.5.2.4.1.1"><p id="nosql_05_0016__p818481035119">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.5.5.2.4.1.2"><p id="nosql_05_0016__p51851410165116">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.5.2.4.1.3"><p id="nosql_05_0016__p1618521018514">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_05_0016__row1747379165115"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="nosql_05_0016__p14185161095120">type</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.5.2.4.1.2 "><p id="nosql_05_0016__p1218617103516">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p id="nosql_05_0016__p318611095118">DB <span id="nosql_05_0016__text157284617195">API</span>.</p>
</td>
</tr>
<tr id="nosql_05_0016__row174731895515"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="nosql_05_0016__p51861810125112">version</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.5.2.4.1.2 "><p id="nosql_05_0016__p1318710108514">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p id="nosql_05_0016__p1718813108516">DB version number.</p>
</td>
</tr>
<tr id="nosql_05_0016__row1841512401461"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="nosql_05_0016__p79162457237">whole_version</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.5.2.4.1.2 "><p id="nosql_05_0016__p4683710247">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p id="nosql_05_0016__p16683181112411">Complete database version number. This parameter is available only to <span id="nosql_05_0016__text184322919544">GeminiDB Cassandra</span>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="nosql_05_0016__response_ListInstancesBackupStrategyResult"></a><a name="response_ListInstancesBackupStrategyResult"></a><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0016__response_ListInstancesBackupStrategyResult" frame="border" border="1" rules="all"><caption><b>Table 7 </b>ListInstancesBackupStrategyResult</caption><thead align="left"><tr id="nosql_05_0016__row164821793513"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.6.2.4.1.1"><p id="nosql_05_0016__p1719015108512">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.5.6.2.4.1.2"><p id="nosql_05_0016__p20191161015115">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.6.2.4.1.3"><p id="nosql_05_0016__p8191141015512">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_05_0016__row144823917511"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p id="nosql_05_0016__p13191510195111">start_time</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.6.2.4.1.2 "><p id="nosql_05_0016__p141921106518">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="nosql_05_0016__p2192141025111">Backup time window. Automated backup will be triggered during the backup time window. The current time is the UTC time.</p>
</td>
</tr>
<tr id="nosql_05_0016__row114821699512"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p id="nosql_05_0016__p171920106519">keep_days</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.6.2.4.1.2 "><p id="nosql_05_0016__p20192010185114">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="nosql_05_0016__p11193101085114">Backup retention days. The value ranges from <strong id="nosql_05_0016__b187859304104">0</strong> to <strong id="nosql_05_0016__b5786143081019">35</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="nosql_05_0016__response_ListInstancesGroupResult"></a><a name="response_ListInstancesGroupResult"></a><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0016__response_ListInstancesGroupResult" frame="border" border="1" rules="all"><caption><b>Table 8 </b>ListInstancesGroupResult</caption><thead align="left"><tr id="nosql_05_0016__row18489139155120"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.7.2.4.1.1"><p id="nosql_05_0016__p41931510145118">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.5.7.2.4.1.2"><p id="nosql_05_0016__p10194201013511">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.7.2.4.1.3"><p id="nosql_05_0016__p21941810185112">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_05_0016__row18489896512"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p id="nosql_05_0016__p7195410185119">id</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.7.2.4.1.2 "><p id="nosql_05_0016__p13195191014519">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="nosql_05_0016__p19196121018516">Group ID.</p>
</td>
</tr>
<tr id="nosql_05_0016__row1848929125117"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p id="nosql_05_0016__p519611005120">status</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.7.2.4.1.2 "><p id="nosql_05_0016__p41961110135112">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="nosql_05_0016__p11196610165111">Group status.</p>
<p id="nosql_05_0016__p149991228142316">The value can be:</p>
<ul id="nosql_05_0016__ul1501290233"><li id="nosql_05_0016__li11011297232"><strong id="nosql_05_0016__b444915270123">normal</strong>, indicating that the group is normal.</li><li id="nosql_05_0016__li16072982316"><strong id="nosql_05_0016__b1568133361317">abnormal</strong>, indicating that the group is abnormal.</li><li id="nosql_05_0016__li1602295237"><strong id="nosql_05_0016__b105452041161313">creating</strong>, indicating that the group is being created.</li><li id="nosql_05_0016__li18012910236"><strong id="nosql_05_0016__b9364549151317">createfail</strong>, indicating that the group failed to be created.</li><li id="nosql_05_0016__li337712313245"><strong id="nosql_05_0016__b845365148">deleted</strong>: indicating that the group has been deleted.</li><li id="nosql_05_0016__li178941150162418"><strong id="nosql_05_0016__b118897449146">resizefailed</strong>: indicating that the group specifications failed to be changed.</li><li id="nosql_05_0016__li1607294234"><strong id="nosql_05_0016__b36531430161517">enlargefail</strong>: indicating the group failed to be scaled out.</li></ul>
</td>
</tr>
<tr id="nosql_05_0016__row148912985111"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p id="nosql_05_0016__p101976102516">volume</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.7.2.4.1.2 "><p id="nosql_05_0016__p20197141035112"><a href="#nosql_05_0016__response_Volume">Volume</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="nosql_05_0016__p1119771010513">Volume information.</p>
</td>
</tr>
<tr id="nosql_05_0016__row17489129165111"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p id="nosql_05_0016__p6198191065111">nodes</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.7.2.4.1.2 "><p id="nosql_05_0016__p10202131055113">Array of <a href="#nosql_05_0016__response_ListInstancesNodeResult">ListInstancesNodeResult</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p id="nosql_05_0016__p122029107516">Node information.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="nosql_05_0016__response_Volume"></a><a name="response_Volume"></a><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0016__response_Volume" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Volume</caption><thead align="left"><tr id="nosql_05_0016__row115006911515"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.8.2.4.1.1"><p id="nosql_05_0016__p32031310125111">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.5.8.2.4.1.2"><p id="nosql_05_0016__p1420311015114">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.8.2.4.1.3"><p id="nosql_05_0016__p10203151015116">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_05_0016__row135019915519"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.8.2.4.1.1 "><p id="nosql_05_0016__p220331015516">size</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.8.2.4.1.2 "><p id="nosql_05_0016__p1020412102519">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.8.2.4.1.3 "><p id="nosql_05_0016__p920410102513">Storage space in GB.</p>
</td>
</tr>
<tr id="nosql_05_0016__row3501098513"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.8.2.4.1.1 "><p id="nosql_05_0016__p1920481010513">used</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.8.2.4.1.2 "><p id="nosql_05_0016__p18204141018518">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.8.2.4.1.3 "><p id="nosql_05_0016__p32051610195116">Used storage space, in GB.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="nosql_05_0016__response_ListInstancesNodeResult"></a><a name="response_ListInstancesNodeResult"></a><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0016__response_ListInstancesNodeResult" frame="border" border="1" rules="all"><caption><b>Table 10 </b>ListInstancesNodeResult</caption><thead align="left"><tr id="nosql_05_0016__row650911995116"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.9.2.4.1.1"><p id="nosql_05_0016__p82072010145118">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.5.9.2.4.1.2"><p id="nosql_05_0016__p7207910175112">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.9.2.4.1.3"><p id="nosql_05_0016__p42072105518">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_05_0016__row8509996518"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p id="nosql_05_0016__p1820781075116">id</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.9.2.4.1.2 "><p id="nosql_05_0016__p17208201015514">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="nosql_05_0016__p12208151035110">Node ID.</p>
</td>
</tr>
<tr id="nosql_05_0016__row3509149145115"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p id="nosql_05_0016__p0208121015117">name</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.9.2.4.1.2 "><p id="nosql_05_0016__p20208410175117">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="nosql_05_0016__p18209710195118">Node name.</p>
</td>
</tr>
<tr id="nosql_05_0016__row1450949145116"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p id="nosql_05_0016__p162098104516">status</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.9.2.4.1.2 "><p id="nosql_05_0016__p620913103515">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="nosql_05_0016__p4210101015512">Node status.</p>
<p id="nosql_05_0016__p6878103614266">The value can be:</p>
<ul id="nosql_05_0016__ul1587813365261"><li id="nosql_05_0016__li118792366262"><strong id="nosql_05_0016__b161213091618">normal</strong>, indicating that the node is running normally.</li><li id="nosql_05_0016__li687953682615"><strong id="nosql_05_0016__b116001139101614">abnormal</strong>, indicating that the node is abnormal.</li><li id="nosql_05_0016__li18791236112610"><strong id="nosql_05_0016__b77472539163">creating</strong>, indicating that the node is being created.</li><li id="nosql_05_0016__li1387903610260"><strong id="nosql_05_0016__b1515914318172">createfail</strong>, indicating that the node failed to be created.</li><li id="nosql_05_0016__li687953613260"><strong id="nosql_05_0016__b199832015179">deleted</strong>, indicating that the node has been deleted.</li><li id="nosql_05_0016__li18879136132610"><strong id="nosql_05_0016__b2511120131818">resizefailed</strong>: indicating that the node specifications failed to be changed.</li><li id="nosql_05_0016__li487915365265"><strong id="nosql_05_0016__b10360232161811">enlargefail</strong>: indicating nodes failed to be added.</li></ul>
</td>
</tr>
<tr id="nosql_05_0016__row125091295517"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p id="nosql_05_0016__p18211131035113">subnet_id</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.9.2.4.1.2 "><p id="nosql_05_0016__p18211161065119">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="nosql_05_0016__p32121810185116">ID of the subnet where the instance node is deployed.</p>
</td>
</tr>
<tr id="nosql_05_0016__row750917911518"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p id="nosql_05_0016__p10212151065119">private_ip</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.9.2.4.1.2 "><p id="nosql_05_0016__p121241065114">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="nosql_05_0016__p721231075113">Private IP address of the node. This parameter value is available after an ECS is created. Otherwise, the value is <strong id="nosql_05_0016__b1262825855611">""</strong>.</p>
</td>
</tr>
<tr id="nosql_05_0016__row1510693516"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p id="nosql_05_0016__p321341010517">public_ip</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.9.2.4.1.2 "><p id="nosql_05_0016__p162131610195113">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="nosql_05_0016__p112131710135118">Bound EIP. This parameter is valid only for nodes bound with EIPs.</p>
</td>
</tr>
<tr id="nosql_05_0016__row4510093511"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p id="nosql_05_0016__p121471065112">spec_code</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.9.2.4.1.2 "><p id="nosql_05_0016__p1521420101513">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="nosql_05_0016__p1121417106515">Resource specification code. For the code, see the value of parameter <strong id="nosql_05_0016__b187315411611">flavors.spec_code</strong> in <a href="nosql_instance_specification.html">Querying Instance Specifications</a>.</p>
</td>
</tr>
<tr id="nosql_05_0016__row155101690518"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p id="nosql_05_0016__p18214191075112">availability_zone</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.9.2.4.1.2 "><p id="nosql_05_0016__p17215010115113">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="nosql_05_0016__p4216121014516">AZ.</p>
</td>
</tr>
<tr id="nosql_05_0016__row1551059145116"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p id="nosql_05_0016__p72165105511">support_reduce</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.9.2.4.1.2 "><p id="nosql_05_0016__p72169108513">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.2.4.1.3 "><p id="nosql_05_0016__p19217171014515">Whether instance nodes can be deleted. The value can be:</p>
<ul id="nosql_05_0016__ul1521881015114"><li id="nosql_05_0016__li221820104518"><strong id="nosql_05_0016__b586014261028">true</strong>, indicating that instance nodes can be deleted.</li><li id="nosql_05_0016__li14219121045118"><strong id="nosql_05_0016__b29115491219">false</strong>, indicating that instance nodes cannot be deleted.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="nosql_05_0016__section12191010105120"><h4 class="sectiontitle">Example Requests</h4><ul id="nosql_05_0016__ul3220171013519"><li id="nosql_05_0016__li162201410205116">URI example<p id="nosql_05_0016__p1822051019511"><a name="nosql_05_0016__li162201410205116"></a><a name="li162201410205116"></a>Querying all instances and details</p>
<pre class="screen" id="nosql_05_0016__screen42212010145118">GET https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances</pre>
</li><li id="nosql_05_0016__li1122131035116">URI example<p id="nosql_05_0016__p82211210115113"><a name="nosql_05_0016__li1122131035116"></a><a name="li1122131035116"></a>Querying instances and details based on specified conditions</p>
<pre class="screen" id="nosql_05_0016__screen17222151075111">GET https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances?offset=0&amp;limit=10&amp;id=ed7cc6166ec24360a5ed5c5c9c2ed726in06&amp;name=hy&amp;mode={mode}&amp;datastore_type={datastore_type}&amp;vpc_id=19e5d45d-70fd-4a91-87e9-b27e71c9891f&amp;subnet_id=bd51fb45-2dcb-4296-8783-8623bfe89bb7</pre>
</li></ul>
</div>
<div class="section" id="nosql_05_0016__section32272103511"><h4 class="sectiontitle">Example Responses</h4><p id="nosql_05_0016__p122731085118"><strong id="nosql_05_0016__b93265207129">Status code: 200</strong></p>
<p id="nosql_05_0016__p112283100512">Success</p>
<pre class="screen" id="nosql_05_0016__screen1926451015517">{
"instances" : [ {
"id" : "8436a91546294036b75931e879882200in06",
"name" : "nno-efa6",
"status" : "normal",
"port" : "8635",
"mode" : "Cluster",
"region" : "aaa",
"datastore" : {
"type" : "cassandra",
"version" : "3.11",
"patch_available" : false
},
"engine" : "rocksDB",
"created" : "2019-01-17T07:05:52",
"updated" : "2019-01-17T07:05:47",
"db_user_name" : "rwuser",
"vpc_id" : "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
"subnet_id" : "f1df08c5-71d1-406a-aff0-de435a51007b",
"security_group_id" : "7aa51dbf-5b63-40db-9724-dad3c4828b58",
"backup_strategy" : {
"start_time" : "16:00-17:00",
"keep_days" : 7
},
"pay_mode" : 0,
"maintenance_window" : "02:00-06:00",
"groups" : [ {
"id" : "0b0ff12541794e1084f6827e424be2d6gr06",
"status" : "creating",
"volume" : {
"size" : 100,
"used" : 0.003
},
"nodes" : [ {
"id" : "233eaac9c6f245c0bb9c2d21eea12d1bno06",
"name" : "nosql-efa6_priam_node_2",
"status" : "normal",
"subnet_id" : "f1df08c5-71d1-406a-aff0-de435a51007b",
"private_ip" : "192.168.0.174",
"spec_code" : "geminidb.cassandra.xlarge.4",
"availability_zone" : "bbb"
}, {
"id" : "d57d76d6320a4a7b86db82c317550c4ano02",
"name" : "nosql-efa6_priam_node_1",
"status" : "normal",
"subnet_id" : "f1df08c5-71d1-406a-aff0-de435a51007b",
"private_ip" : "192.168.0.39",
"spec_code" : "geminidb.cassandra.xlarge.4",
"availability_zone" : "bbb"
}, {
"id" : "f46b0a1cf4d9400e9fd7af17f8742d37no02",
"name" : "nosql-efa6_priam_node_3",
"status" : "normal",
"subnet_id" : "f1df08c5-71d1-406a-aff0-de435a51007b",
"private_ip" : "192.168.0.176",
"spec_code" : "geminidb.cassandra.xlarge.4",
"availability_zone" : "bbb"
} ]
} ],
"enterprise_project_id" : "0",
"time_zone" : "",
"actions" : [ "CREATE" ]
}, {
"id" : "1236a91546294036b75931e879882200in06",
"name" : "nosql-efa7",
"status" : "Cluster",
"port" : "8635",
"mode" : "ReplicaSet",
"region" : "aaa",
"datastore" : {
"type" : "cassandra",
"version" : "3.11",
"patch_available" : false
},
"engine" : "rocksDB",
"created" : "2019-01-17T07:05:52",
"updated" : "2019-01-17T07:05:47",
"db_user_name" : "rwuser",
"vpc_id" : "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
"subnet_id" : "f1df08c5-71d1-406a-aff0-de435a51007b",
"security_group_id" : "7aa51dbf-5b63-40db-9724-dad3c4828b58",
"backup_strategy" : {
"start_time" : "16:00-17:00",
"keep_days" : 7
},
"pay_mode" : 0,
"maintenance_window" : "02:00-06:00",
"groups" : [ {
"id" : "0b0ff12541794e1084f6827e424be2d1gr07",
"status" : "creating",
"volume" : {
"size" : 100,
"used" : 0.003
},
"nodes" : [ {
"id" : "233eaac9c6f245c0bb9c2d21eea12d1bno06",
"name" : "nosql-efa7_priam_node_2",
"status" : "normal",
"subnet_id" : "f1df08c5-71d1-406a-aff0-de435a51007b",
"private_ip" : "192.168.0.174",
"spec_code" : "geminidb.cassandra.xlarge.4",
"availability_zone" : "bbb"
}, {
"id" : "d57d76d6320a4a7b86db82c317550c4ano02",
"name" : "nosql-efa7_priam_node_1",
"status" : "normal",
"subnet_id" : "f1df08c5-71d1-406a-aff0-de435a51007b",
"private_ip" : "192.168.0.39",
"spec_code" : "geminidb.cassandra.xlarge.4",
"availability_zone" : "bbb"
}, {
"id" : "f46b0a1cf4d9400e9fd7af17f8742d37no02",
"name" : "nosql-efa7_prima_node_3",
"status" : "normal",
"role" : "Secondary",
"subnet_id" : "f1df08c5-71d1-406a-aff0-de435a51007b",
"private_ip" : "192.168.0.176",
"spec_code" : "geminidb.cassandra.xlarge.4",
"availability_zone" : "bbb"
} ]
} ],
"enterprise_project_id" : "0",
"time_zone" : "",
"actions" : [ "CREATE" ]
} ],
"total_count" : 2
}</pre>
</div>
<div class="section" id="nosql_05_0016__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="nosql_05_0016__listapiversion_p201216122353">For details, see <a href="nosql_status_code.html">Status Codes</a>.</p>
</div>
<div class="section" id="nosql_05_0016__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="nosql_05_0016__listapiversion_p1265915205719">For details, see <a href="nosql_error_code.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000002.html">Instances</a></div>
</div>
</div>
View Git Blame Copy Permalink