vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/rds/api-ref/en-us_topic_0032348280.html
Wang , Deng Ke 5208dcae7b RDS API 20221104 version 
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Wang , Deng Ke <wangdengke2@huawei.com>
Co-committed-by: Wang , Deng Ke <wangdengke2@huawei.com>
2022-11-10 09:55:48 +00:00

501 lines
39 KiB
HTML
Raw Blame History

<a name="en-us_topic_0032348280"></a><a name="en-us_topic_0032348280"></a>
<h1 class="topictitle1">Obtaining a DB Instance List</h1>
<div id="body1467019492675"><div class="section" id="en-us_topic_0032348280__section6603527917262"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0032348280__p4725737717262">This API is used to obtain a DB instance list.</p>
</div>
<div class="section" id="en-us_topic_0032348280__section2266321117262"><h4 class="sectiontitle">URI</h4><ul id="en-us_topic_0032348280__ul2378084117262"><li id="en-us_topic_0032348280__li1270098217262">URI format<p id="en-us_topic_0032348280__p4719997917262"><a name="en-us_topic_0032348280__li1270098217262"></a><a name="li1270098217262"></a>PATH: /rds/v1/{project_id}/instances</p>
<p id="en-us_topic_0032348280__p12761997154544">Method: GET</p>
</li><li id="en-us_topic_0032348280__li2214663417262">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0032348280__table6510197817262" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="en-us_topic_0032348280__row1990636917262"><th align="left" class="cellrowborder" valign="top" width="21.27%" id="mcps1.3.2.2.2.1.2.4.1.1"><p id="en-us_topic_0032348280__p180318617262"><strong id="en-us_topic_0032348280__b842352706102328">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="27.93%" id="mcps1.3.2.2.2.1.2.4.1.2"><p id="en-us_topic_0032348280__p1184034317262"><strong id="en-us_topic_0032348280__b842352706102346">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50.8%" id="mcps1.3.2.2.2.1.2.4.1.3"><p id="en-us_topic_0032348280__p1954370417262"><strong id="en-us_topic_0032348280__b842352706163417">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0032348280__row3953622317262"><td class="cellrowborder" valign="top" width="21.27%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="en-us_topic_0032348280__p4831745717262">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="27.93%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="en-us_topic_0032348280__p2139996017262">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="50.8%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="en-us_topic_0032348280__p56722555163647">Specifies the project ID of a tenant in a region.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="en-us_topic_0032348280__section807511017262"><h4 class="sectiontitle">Request</h4><p id="en-us_topic_0032348280__p5010418417262">None</p>
</div>
<div class="section" id="en-us_topic_0032348280__section4828447917262"><h4 class="sectiontitle">Normal Response</h4><ul id="en-us_topic_0032348280__ul1872869017262"><li id="en-us_topic_0032348280__li3434049017262">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0032348280__table54571314103317" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="en-us_topic_0032348280__row3459121463318"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="en-us_topic_0032348280__p91816414334"><strong id="en-us_topic_0032348280__b530410137">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="en-us_topic_0032348280__p123216414335"><strong id="en-us_topic_0032348280__b842352706164541">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="en-us_topic_0032348280__p440144113310"><strong id="en-us_topic_0032348280__b1787690539">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0032348280__row16459161403314"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="en-us_topic_0032348280__p12459414153315">instances</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="en-us_topic_0032348280__p945941483315">List data structure. For details, see <a href="#en-us_topic_0032348280__table4062895917262">Table 3</a>.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="en-us_topic_0032348280__p10459614163315">Indicates the DB instance information.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="en-us_topic_0032348280__table4062895917262"></a><a name="table4062895917262"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0032348280__table4062895917262" frame="border" border="1" rules="all"><caption><b>Table 3 </b>instances field data structure description</caption><thead align="left"><tr id="en-us_topic_0032348280__row2045312717262"><th align="left" class="cellrowborder" valign="top" width="22.11%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="en-us_topic_0032348280__p4609059717262"><strong id="en-us_topic_0032348280__b84235270691445">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="27.76%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="en-us_topic_0032348280__p4235091617262"><strong id="en-us_topic_0032348280__b229398771">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50.129999999999995%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="en-us_topic_0032348280__p787220417262"><strong id="en-us_topic_0032348280__b1692183722">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0032348280__row3366877217262"><td class="cellrowborder" valign="top" width="22.11%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0032348280__p4281598817262">id</p>
</td>
<td class="cellrowborder" valign="top" width="27.76%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0032348280__p4554301317262">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.129999999999995%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0032348280__p7417132564016">Indicates the primary node ID of the DB instance.</p>
<div class="note" id="en-us_topic_0032348280__note18250133224019"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="en-us_topic_0032348280__p142501332164011">This field is not the DB instance ID. You are advised to use API v3 and the DB instance ID to perform related operations.</p>
</div></div>
</td>
</tr>
<tr id="en-us_topic_0032348280__row4973938517262"><td class="cellrowborder" valign="top" width="22.11%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0032348280__p235838917262">status</p>
</td>
<td class="cellrowborder" valign="top" width="27.76%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0032348280__p5681181717262">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.129999999999995%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0032348280__p2682840893927">Indicates the DB instance status.</p>
<div class="p" id="en-us_topic_0032348280__p3835449417262">Value:<ul id="en-us_topic_0032348280__ul3066104695748"><li id="en-us_topic_0032348280__li1772543895748">If the value is <strong id="en-us_topic_0032348280__b84235270616547">BUILD</strong>, the instance is being created.</li><li id="en-us_topic_0032348280__li6405079395748">If the value is <strong id="en-us_topic_0032348280__b842352706165415">ACTIVE</strong>, the instance is normal.</li><li id="en-us_topic_0032348280__li1394818495748">If the value is <strong id="en-us_topic_0032348280__b842352706165427">FAILED</strong>, the instance is abnormal.</li><li id="en-us_topic_0032348280__li6638702395748">If the value is <strong id="en-us_topic_0032348280__b1064442472">MODIFYING</strong>, the instance is being scaled up.</li><li id="en-us_topic_0032348280__li5726501795748">If the value is <strong id="en-us_topic_0032348280__b1932177384">REBOOTING</strong>, the instance is being rebooted.</li><li id="en-us_topic_0032348280__li2770932595748">If the value is <strong id="en-us_topic_0032348280__b1202485224">RESTORING</strong>, the instance is being restored.</li></ul>
</div>
</td>
</tr>
<tr id="en-us_topic_0032348280__row964613217262"><td class="cellrowborder" valign="top" width="22.11%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0032348280__p4313926117262">name</p>
</td>
<td class="cellrowborder" valign="top" width="27.76%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0032348280__p461925817262">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.129999999999995%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0032348280__p3861563617262">Indicates the created DB instance name.</p>
</td>
</tr>
<tr id="en-us_topic_0032348280__row1199640717262"><td class="cellrowborder" valign="top" width="22.11%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0032348280__p3218490217262">created</p>
</td>
<td class="cellrowborder" valign="top" width="27.76%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0032348280__p5684029417262">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.129999999999995%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0032348280__p64320678">Indicates the creation time in the "yyyy-mm-ddThh:mm:ssZ" format.</p>
<p id="en-us_topic_0032348280__p6642150175824"><strong id="en-us_topic_0032348280__b842352706151812">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="en-us_topic_0032348280__b842352706153833">Z</strong> indicates the time zone offset. </p>
<div class="note" id="en-us_topic_0032348280__note5126817175844"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="en-us_topic_0032348280__p46141354175844">The value is empty when the DB instance is being created. After the DB instance is created, the value is not empty.</p>
</div></div>
</td>
</tr>
<tr id="en-us_topic_0032348280__row521631217262"><td class="cellrowborder" valign="top" width="22.11%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0032348280__p1986808917262">hostname</p>
</td>
<td class="cellrowborder" valign="top" width="27.76%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0032348280__p6581137117262">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.129999999999995%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0032348280__p2912082117262">Indicates the DB instance connection address. It is a blank string until an ECS is created.</p>
</td>
</tr>
<tr id="en-us_topic_0032348280__row6076080317262"><td class="cellrowborder" valign="top" width="22.11%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0032348280__p2267802117262">type</p>
</td>
<td class="cellrowborder" valign="top" width="27.76%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0032348280__p2498043617262">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.129999999999995%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0032348280__p1014943117262">Indicates the DB instance type, which can be <strong id="en-us_topic_0032348280__b84235270617352">master</strong>, <strong id="en-us_topic_0032348280__b99726394894912">slave</strong>, or <strong id="en-us_topic_0032348280__b84235270617355">readreplica</strong>.</p>
</td>
</tr>
<tr id="en-us_topic_0032348280__row6085477618055"><td class="cellrowborder" valign="top" width="22.11%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0032348280__p1502529718057">region</p>
</td>
<td class="cellrowborder" valign="top" width="27.76%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0032348280__p908955818057">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.129999999999995%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0032348280__p6516558318057">Indicates the region where the DB instance is deployed.</p>
</td>
</tr>
<tr id="en-us_topic_0032348280__row2423602017262"><td class="cellrowborder" valign="top" width="22.11%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0032348280__p1696059317262">updated</p>
</td>
<td class="cellrowborder" valign="top" width="27.76%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0032348280__p3163077417262">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.129999999999995%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0032348280__p53428882">Indicates the updated time, which is the same as <strong id="en-us_topic_0032348280__b842352706164129">created</strong> in the format.</p>
<div class="note" id="en-us_topic_0032348280__note542057061864"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="en-us_topic_0032348280__p180893121864">The value is empty when the DB instance is being created. After the DB instance is created, the value is not empty.</p>
</div></div>
</td>
</tr>
<tr id="en-us_topic_0032348280__row4049438517262"><td class="cellrowborder" valign="top" width="22.11%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0032348280__p5881973017262">availabilityZone</p>
</td>
<td class="cellrowborder" valign="top" width="27.76%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0032348280__p6677772117262">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.129999999999995%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0032348280__p4028628317262">Indicates the AZ ID.</p>
</td>
</tr>
<tr id="en-us_topic_0032348280__row2703223317262"><td class="cellrowborder" valign="top" width="22.11%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0032348280__p714310104515">vpc</p>
</td>
<td class="cellrowborder" valign="top" width="27.76%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0032348280__p38963172104515">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.129999999999995%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0032348280__p65300105104515">Indicates the VPC ID.</p>
</td>
</tr>
<tr id="en-us_topic_0032348280__row32278200104511"><td class="cellrowborder" valign="top" width="22.11%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0032348280__p41014036104516">nics</p>
</td>
<td class="cellrowborder" valign="top" width="27.76%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0032348280__p33802645104516">Dictionary data structure. For details, see <a href="#en-us_topic_0032348280__table37920950175250">Table 4</a>.</p>
</td>
<td class="cellrowborder" valign="top" width="50.129999999999995%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0032348280__p53659763104516">Indicates the nics information.</p>
</td>
</tr>
<tr id="en-us_topic_0032348280__row4722801917262"><td class="cellrowborder" valign="top" width="22.11%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0032348280__p26431617262">securityGroup</p>
</td>
<td class="cellrowborder" valign="top" width="27.76%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0032348280__p2140963417262">Dictionary data structure. For details, see <a href="#en-us_topic_0032348280__table3309421917534">Table 5</a>.</p>
</td>
<td class="cellrowborder" valign="top" width="50.129999999999995%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0032348280__p5645876417262">Indicates the security group information.</p>
</td>
</tr>
<tr id="en-us_topic_0032348280__row3836683017262"><td class="cellrowborder" valign="top" width="22.11%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0032348280__p2070553017262">flavor</p>
</td>
<td class="cellrowborder" valign="top" width="27.76%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0032348280__p6653523017262">Dictionary data structure. For details, see <a href="#en-us_topic_0032348280__table6373831917584">Table 6</a>.</p>
</td>
<td class="cellrowborder" valign="top" width="50.129999999999995%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0032348280__p2064457917262">Indicates the specification information.</p>
</td>
</tr>
<tr id="en-us_topic_0032348280__row5158348917262"><td class="cellrowborder" valign="top" width="22.11%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0032348280__p1751311417262">volume</p>
</td>
<td class="cellrowborder" valign="top" width="27.76%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0032348280__p927613517262">Dictionary data structure. For details, see <a href="#en-us_topic_0032348280__table35005463173456">Table 7</a>.</p>
</td>
<td class="cellrowborder" valign="top" width="50.129999999999995%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0032348280__p1316948917262">Indicates the volume information.</p>
</td>
</tr>
<tr id="en-us_topic_0032348280__row26042558155946"><td class="cellrowborder" valign="top" width="22.11%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0032348280__p29072469155946">dataStoreInfo</p>
</td>
<td class="cellrowborder" valign="top" width="27.76%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0032348280__p6059817155946">Dictionary data structure. For details, see <a href="#en-us_topic_0032348280__table16797672173620">Table 8</a>.</p>
</td>
<td class="cellrowborder" valign="top" width="50.129999999999995%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0032348280__p21083169155946">Indicates the database information.</p>
</td>
</tr>
<tr id="en-us_topic_0032348280__row3104228817747"><td class="cellrowborder" valign="top" width="22.11%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0032348280__p156965461780">dbPort</p>
</td>
<td class="cellrowborder" valign="top" width="27.76%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0032348280__p634606801780">Int</p>
</td>
<td class="cellrowborder" valign="top" width="50.129999999999995%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0032348280__p400414551780">Indicates the database port number.</p>
</td>
</tr>
<tr id="en-us_topic_0032348280__row6543147717262"><td class="cellrowborder" valign="top" width="22.11%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0032348280__p6545824517262">backupStrategy</p>
</td>
<td class="cellrowborder" valign="top" width="27.76%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0032348280__p51760117262">Dictionary data structure. For details, see <a href="#en-us_topic_0032348280__table50876711173859">Table 9</a>.</p>
</td>
<td class="cellrowborder" valign="top" width="50.129999999999995%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0032348280__p4192574617262">Indicates the advanced backup policy.</p>
</td>
</tr>
<tr id="en-us_topic_0032348280__row4178740217262"><td class="cellrowborder" valign="top" width="22.11%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0032348280__p18816388111317">slaveId</p>
</td>
<td class="cellrowborder" valign="top" width="27.76%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0032348280__p47732488111317">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.129999999999995%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0032348280__p41126320111317">Returned only when you create primary/standby DB instances.</p>
</td>
</tr>
<tr id="en-us_topic_0032348280__row2350798811137"><td class="cellrowborder" valign="top" width="22.11%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0032348280__p27149812111313">ha</p>
</td>
<td class="cellrowborder" valign="top" width="27.76%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0032348280__p51651186111313">Dictionary data structure. For details, see <a href="#en-us_topic_0032348280__table497888411810">Table 10</a>.</p>
</td>
<td class="cellrowborder" valign="top" width="50.129999999999995%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0032348280__p391079579319">Indicates the primary/standby DB instance information. Returned only when you obtain a primary/standby DB instance list.</p>
</td>
</tr>
<tr id="en-us_topic_0032348280__row525514017262"><td class="cellrowborder" valign="top" width="22.11%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0032348280__p2301320417262">replicaOf</p>
</td>
<td class="cellrowborder" valign="top" width="27.76%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0032348280__p5213021617262">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.129999999999995%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0032348280__p6179796117262">Returned only when you obtain the read replica information.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="en-us_topic_0032348280__table37920950175250"></a><a name="table37920950175250"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0032348280__table37920950175250" frame="border" border="1" rules="all"><caption><b>Table 4 </b>nics field data structure description</caption><thead align="left"><tr id="en-us_topic_0032348280__row23321270175250"><th align="left" class="cellrowborder" valign="top" width="21.95%" id="mcps1.3.4.2.1.3.2.4.1.1"><p id="en-us_topic_0032348280__p9974708175250"><strong id="en-us_topic_0032348280__b64780299">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="27.96%" id="mcps1.3.4.2.1.3.2.4.1.2"><p id="en-us_topic_0032348280__p2645023175250"><strong id="en-us_topic_0032348280__b2016037747">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50.09%" id="mcps1.3.4.2.1.3.2.4.1.3"><p id="en-us_topic_0032348280__p12920286175250"><strong id="en-us_topic_0032348280__b1912224743">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0032348280__row39910234175250"><td class="cellrowborder" valign="top" width="21.95%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="en-us_topic_0032348280__p11503482175250">subnetId</p>
</td>
<td class="cellrowborder" valign="top" width="27.96%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="en-us_topic_0032348280__p59366822175250">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.09%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="en-us_topic_0032348280__p43983303175250">Indicates the network ID of the subnet.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="en-us_topic_0032348280__table3309421917534"></a><a name="table3309421917534"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0032348280__table3309421917534" frame="border" border="1" rules="all"><caption><b>Table 5 </b>securityGroup field data structure description</caption><thead align="left"><tr id="en-us_topic_0032348280__row238163517534"><th align="left" class="cellrowborder" valign="top" width="22.23222322232223%" id="mcps1.3.4.2.1.4.2.4.1.1"><p id="en-us_topic_0032348280__p5869477217534"><strong id="en-us_topic_0032348280__b743078136">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="27.962796279627966%" id="mcps1.3.4.2.1.4.2.4.1.2"><p id="en-us_topic_0032348280__p5665613017534"><strong id="en-us_topic_0032348280__b1378226222">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.80498049804981%" id="mcps1.3.4.2.1.4.2.4.1.3"><p id="en-us_topic_0032348280__p2574382817534"><strong id="en-us_topic_0032348280__b1192193370">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0032348280__row487534717534"><td class="cellrowborder" valign="top" width="22.23222322232223%" headers="mcps1.3.4.2.1.4.2.4.1.1 "><p id="en-us_topic_0032348280__p5935882217534">id</p>
</td>
<td class="cellrowborder" valign="top" width="27.962796279627966%" headers="mcps1.3.4.2.1.4.2.4.1.2 "><p id="en-us_topic_0032348280__p4333528617534">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.80498049804981%" headers="mcps1.3.4.2.1.4.2.4.1.3 "><p id="en-us_topic_0032348280__p2049725817534">Indicates the security group ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="en-us_topic_0032348280__table6373831917584"></a><a name="table6373831917584"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0032348280__table6373831917584" frame="border" border="1" rules="all"><caption><b>Table 6 </b>flavor field data structure description</caption><thead align="left"><tr id="en-us_topic_0032348280__row2420947817584"><th align="left" class="cellrowborder" valign="top" width="22.38%" id="mcps1.3.4.2.1.5.2.4.1.1"><p id="en-us_topic_0032348280__p1481073317584"><strong id="en-us_topic_0032348280__b1502281678">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="27.68%" id="mcps1.3.4.2.1.5.2.4.1.2"><p id="en-us_topic_0032348280__p5881868717584"><strong id="en-us_topic_0032348280__b264259810">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.94%" id="mcps1.3.4.2.1.5.2.4.1.3"><p id="en-us_topic_0032348280__p6669322217584"><strong id="en-us_topic_0032348280__b1533742120">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0032348280__row3344193017584"><td class="cellrowborder" valign="top" width="22.38%" headers="mcps1.3.4.2.1.5.2.4.1.1 "><p id="en-us_topic_0032348280__p2444181017584">id</p>
</td>
<td class="cellrowborder" valign="top" width="27.68%" headers="mcps1.3.4.2.1.5.2.4.1.2 "><p id="en-us_topic_0032348280__p3362960717584">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.94%" headers="mcps1.3.4.2.1.5.2.4.1.3 "><p id="en-us_topic_0032348280__p3964363217584">Indicates the specification ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="en-us_topic_0032348280__table35005463173456"></a><a name="table35005463173456"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0032348280__table35005463173456" frame="border" border="1" rules="all"><caption><b>Table 7 </b>volume field data structure description</caption><thead align="left"><tr id="en-us_topic_0032348280__row9318556173456"><th align="left" class="cellrowborder" valign="top" width="22.24%" id="mcps1.3.4.2.1.6.2.4.1.1"><p id="en-us_topic_0032348280__p15232744173456"><strong id="en-us_topic_0032348280__b823678472">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="27.82%" id="mcps1.3.4.2.1.6.2.4.1.2"><p id="en-us_topic_0032348280__p25892781173456"><strong id="en-us_topic_0032348280__b594127791">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.94%" id="mcps1.3.4.2.1.6.2.4.1.3"><p id="en-us_topic_0032348280__p16940539173456"><strong id="en-us_topic_0032348280__b1394703569">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0032348280__row18247124173456"><td class="cellrowborder" valign="top" width="22.24%" headers="mcps1.3.4.2.1.6.2.4.1.1 "><p id="en-us_topic_0032348280__p1622081173456">type</p>
</td>
<td class="cellrowborder" valign="top" width="27.82%" headers="mcps1.3.4.2.1.6.2.4.1.2 "><p id="en-us_topic_0032348280__p64279755173456">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.94%" headers="mcps1.3.4.2.1.6.2.4.1.3 "><p id="en-us_topic_0032348280__p39277657173456">Indicates the volume type.</p>
</td>
</tr>
<tr id="en-us_topic_0032348280__row17954597173456"><td class="cellrowborder" valign="top" width="22.24%" headers="mcps1.3.4.2.1.6.2.4.1.1 "><p id="en-us_topic_0032348280__p45036277173456">size</p>
</td>
<td class="cellrowborder" valign="top" width="27.82%" headers="mcps1.3.4.2.1.6.2.4.1.2 "><p id="en-us_topic_0032348280__p24059838173456">Int</p>
</td>
<td class="cellrowborder" valign="top" width="49.94%" headers="mcps1.3.4.2.1.6.2.4.1.3 "><p id="en-us_topic_0032348280__p2689831173456">Indicates the volume size.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="en-us_topic_0032348280__table16797672173620"></a><a name="table16797672173620"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0032348280__table16797672173620" frame="border" border="1" rules="all"><caption><b>Table 8 </b>dataStoreInfo field data structure description</caption><thead align="left"><tr id="en-us_topic_0032348280__row16288138173620"><th align="left" class="cellrowborder" valign="top" width="22.37%" id="mcps1.3.4.2.1.7.2.4.1.1"><p id="en-us_topic_0032348280__p62892653173620"><strong id="en-us_topic_0032348280__b360903052">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="27.310000000000002%" id="mcps1.3.4.2.1.7.2.4.1.2"><p id="en-us_topic_0032348280__p61140119173620"><strong id="en-us_topic_0032348280__b1770949673">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50.32%" id="mcps1.3.4.2.1.7.2.4.1.3"><p id="en-us_topic_0032348280__p53402626173620"><strong id="en-us_topic_0032348280__b293424311">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0032348280__row10861591173620"><td class="cellrowborder" valign="top" width="22.37%" headers="mcps1.3.4.2.1.7.2.4.1.1 "><p id="en-us_topic_0032348280__p7373702173620">type</p>
</td>
<td class="cellrowborder" valign="top" width="27.310000000000002%" headers="mcps1.3.4.2.1.7.2.4.1.2 "><p id="en-us_topic_0032348280__p60398985173620">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.32%" headers="mcps1.3.4.2.1.7.2.4.1.3 "><p id="en-us_topic_0032348280__p60479625173620">Indicates the DB engine.</p>
</td>
</tr>
<tr id="en-us_topic_0032348280__row7445715173620"><td class="cellrowborder" valign="top" width="22.37%" headers="mcps1.3.4.2.1.7.2.4.1.1 "><p id="en-us_topic_0032348280__p66232024173620">version</p>
</td>
<td class="cellrowborder" valign="top" width="27.310000000000002%" headers="mcps1.3.4.2.1.7.2.4.1.2 "><p id="en-us_topic_0032348280__p63193742173620">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.32%" headers="mcps1.3.4.2.1.7.2.4.1.3 "><p id="en-us_topic_0032348280__p18419484173620">Indicates the database version.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="en-us_topic_0032348280__table50876711173859"></a><a name="table50876711173859"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0032348280__table50876711173859" frame="border" border="1" rules="all"><caption><b>Table 9 </b>backupStrategy field data structure description</caption><thead align="left"><tr id="en-us_topic_0032348280__row26941115173859"><th align="left" class="cellrowborder" valign="top" width="22.220000000000002%" id="mcps1.3.4.2.1.8.2.4.1.1"><p id="en-us_topic_0032348280__p44284799173859"><strong id="en-us_topic_0032348280__b2026700682">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="27.589999999999996%" id="mcps1.3.4.2.1.8.2.4.1.2"><p id="en-us_topic_0032348280__p30298928173859"><strong id="en-us_topic_0032348280__b999848861">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50.19%" id="mcps1.3.4.2.1.8.2.4.1.3"><p id="en-us_topic_0032348280__p38294098173859"><strong id="en-us_topic_0032348280__b2126548616">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0032348280__row9102564173859"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.4.2.1.8.2.4.1.1 "><p id="en-us_topic_0032348280__p66219122173859">startTime</p>
</td>
<td class="cellrowborder" valign="top" width="27.589999999999996%" headers="mcps1.3.4.2.1.8.2.4.1.2 "><p id="en-us_topic_0032348280__p62148676173859">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.19%" headers="mcps1.3.4.2.1.8.2.4.1.3 "><p id="en-us_topic_0032348280__p55315500174811">Indicates the backup start time that has been set. The backup task will be triggered within one hour after the backup start time.</p>
<p id="en-us_topic_0032348280__p1583127716151">The time is in the UTC format.</p>
</td>
</tr>
<tr id="en-us_topic_0032348280__row7902174173859"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.4.2.1.8.2.4.1.1 "><p id="en-us_topic_0032348280__p36096395173859">keepDays</p>
</td>
<td class="cellrowborder" valign="top" width="27.589999999999996%" headers="mcps1.3.4.2.1.8.2.4.1.2 "><p id="en-us_topic_0032348280__p38126872173859">Int</p>
</td>
<td class="cellrowborder" valign="top" width="50.19%" headers="mcps1.3.4.2.1.8.2.4.1.3 "><p id="en-us_topic_0032348280__p59681602174811">Indicates the number of days to retain the generated backup files.</p>
<p id="en-us_topic_0032348280__p263511174811">The value range is from 0 to 732. If this parameter is <strong id="en-us_topic_0032348280__b842352706112422">0</strong>, the automated backup policy is not set. To extend the retention period, contact customer service. Automated backups can be retained for up to 2562 days.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="en-us_topic_0032348280__table497888411810"></a><a name="table497888411810"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0032348280__table497888411810" frame="border" border="1" rules="all"><caption><b>Table 10 </b>ha field data structure description</caption><thead align="left"><tr id="en-us_topic_0032348280__row145013461810"><th align="left" class="cellrowborder" valign="top" width="22.52%" id="mcps1.3.4.2.1.9.2.4.1.1"><p id="en-us_topic_0032348280__p337583601810"><strong id="en-us_topic_0032348280__b1431977547">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="27.400000000000002%" id="mcps1.3.4.2.1.9.2.4.1.2"><p id="en-us_topic_0032348280__p500726761810"><strong id="en-us_topic_0032348280__b977653462">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50.080000000000005%" id="mcps1.3.4.2.1.9.2.4.1.3"><p id="en-us_topic_0032348280__p293549231810"><strong id="en-us_topic_0032348280__b1793121218">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0032348280__row289385831810"><td class="cellrowborder" valign="top" width="22.52%" headers="mcps1.3.4.2.1.9.2.4.1.1 "><p id="en-us_topic_0032348280__p623239201810">replicationMode</p>
</td>
<td class="cellrowborder" valign="top" width="27.400000000000002%" headers="mcps1.3.4.2.1.9.2.4.1.2 "><p id="en-us_topic_0032348280__p150727651810">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.080000000000005%" headers="mcps1.3.4.2.1.9.2.4.1.3 "><p id="en-us_topic_0032348280__p129344711810">Indicates the replication mode for the standby DB instance.</p>
<p id="en-us_topic_0032348280__p3394570181655">The value cannot be empty.</p>
<ul id="en-us_topic_0032348280__ul30551132181655"><li id="en-us_topic_0032348280__li6524738181655">For MySQL, the value is <strong id="en-us_topic_0032348280__b842352706165650">async</strong> or <strong id="en-us_topic_0032348280__b842352706165654">semisync</strong>.</li><li id="en-us_topic_0032348280__li58722643181655">For PostgreSQL, the value is <strong id="en-us_topic_0032348280__b424906094">async</strong> or <strong id="en-us_topic_0032348280__b389714787">sync</strong>.</li><li id="en-us_topic_0032348280__li58741746181655">For Microsoft SQL Server, the value is <strong id="en-us_topic_0032348280__b1084866521183314">sync</strong>.</li></ul>
<div class="note" id="en-us_topic_0032348280__note58913671181655"><span class="notetitle"> NOTE: </span><div class="notebody"><ul id="en-us_topic_0032348280__ul60460995181655"><li id="en-us_topic_0032348280__li7278047181655"><strong id="en-us_topic_0032348280__b842352706105954">async</strong> indicates the asynchronous replication mode.</li><li id="en-us_topic_0032348280__li65502428181655"><strong id="en-us_topic_0032348280__b842352706164020">semisync</strong> indicates the semi-synchronous replication mode.</li><li id="en-us_topic_0032348280__li52650948181655"><strong id="en-us_topic_0032348280__b13384211081105">sync</strong> indicates the synchronous replication mode.</li></ul>
</div></div>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<ul id="en-us_topic_0032348280__ul2705380172618"><li id="en-us_topic_0032348280__li24348422172618">Response example<p id="en-us_topic_0032348280__p17809214172618"><a name="en-us_topic_0032348280__li24348422172618"></a><a name="li24348422172618"></a>Single DB instance:</p>
<pre class="codeblock" id="en-us_topic_0032348280__codeblock26803758171359">{
"instances": [
{
"id": "252f11f1-2912-4c06-be55-1999bde659c5",
"status": "BUILD",
"name": "trove-instance-rep3",
"created": "2016-06-18T21:21:50+0200",
"hostname": "192.168.0.132",
"type": "master",
"region": "eu-de",
"updated": "2016-06-18T21:21:50+0200",
"availabilityZone": "eu-de-01",
"vpc": "490a4a08-ef4b-44c5-94be-3051ef9e4fce",
"nics": {
"subnetId": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f"
},
"securityGroup": {
"id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5"
},
"flavor": {
"id": "bf07a6d4-844a-4023-a776-fc5c5fb71fb4"
},
"volume": {
"type": "ULTRAHIGH",
"size": 100
},
"dataStoreInfo": {
"type": "MySQL",
"version": "5.7"
},
"dbPort": 3306,
"backupStrategy": {
"startTime": "01:00:00",
"keepDays": 3
}
}
]
}</pre>
<p id="en-us_topic_0032348280__p24488012172618">Primary/standby DB instances:</p>
<pre class="codeblock" id="en-us_topic_0032348280__codeblock55195618171440">{
"instances": [
{
"id": "252f11f1-2912-4c06-be55-1999bde659c5",
"status": "BUILD",
"name": "trove-instance-rep3",
"created": "2016-06-18T21:21:50+0200",
"hostname": "192.168.0.132",
"type": "master",
"region": "eu-de",
"updated": "2016-06-18T21:21:50+0200",
"availabilityZone": "eu-de-01",
"vpc": "490a4a08-ef4b-44c5-94be-3051ef9e4fce",
"nics": {
"subnetId": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f"
},
"securityGroup": {
"id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5"
},
"flavor": {
"id": "bf07a6d4-844a-4023-a776-fc5c5fb71fb4"
},
"volume": {
"type": "ULTRAHIGH",
"size": 100
},
"dataStoreInfo": {
"type": "MySQL",
"version": "5.7"
},
"dbPort": 3306,
"backupStrategy": {
"startTime": "01:00:00",
"keepDays": 3
},
"slaveId": "9405d8b8-a87d-4531-bd3a-e504c8434281",
"ha": {
"replicationMode": "async"
}
}
]
}</pre>
<p id="en-us_topic_0032348280__p44381989172618">Read replica:</p>
<pre class="codeblock" id="en-us_topic_0032348280__codeblock9872359171559">{
"instances": [
{
"id": "252f11f1-2912-4c06-be55-1999bde659c5",
"status": "BUILD",
"name": "trove-instance-rep3",
"created": "2016-06-18T21:21:50+0200",
"hostname": "192.168.0.132",
"type": "readreplica",
"region": "eu-de",
"updated": "2016-06-18T21:21:50+0200",
"availabilityZone": "eu-de-01",
"vpc": "490a4a08-ef4b-44c5-94be-3051ef9e4fce",
"nics": {
"subnetId": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f"
},
"securityGroup": {
"id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5"
},
"flavor": {
"id": "bf07a6d4-844a-4023-a776-fc5c5fb71fb4"
},
"volume": {
"type": "ULTRAHIGH",
"size": 100
},
"dataStoreInfo": {
"type": "MySQL",
"version": "5.7"
},
"dbPort": 3306,
"replicaOf": "252f11f1-2912-4c06-be55-1999bde659c5"
}
]
}</pre>
</li></ul>
<div class="section" id="en-us_topic_0032348280__section55968780172618"><h4 class="sectiontitle">Abnormal Response</h4><p id="en-us_topic_0032348280__p37177336172618">For details, see <a href="en-us_topic_0032488197.html">Abnormal Request Results</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="rds_06_0016.html">DB Instance Management</a></div>
</div>
</div>
View Git Blame Copy Permalink