forked from docs/doc-exports
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>
789 lines
62 KiB
HTML
789 lines
62 KiB
HTML
<a name="rds_01_0004"></a><a name="rds_01_0004"></a>
|
|
|
|
<h1 class="topictitle1">Querying Details About DB Instances</h1>
|
|
<div id="body1535613843473"><div class="section" id="rds_01_0004__section44230431101549"><h4 class="sectiontitle">Function</h4><p id="rds_01_0004__p1350220403353">This API is used to query DB instances according to search criteria.</p>
|
|
<ul id="rds_01_0004__ul12259155218373"><li id="rds_01_0004__en-us_topic_0240111818_li836513175363">Before calling an API, you need to understand the API in <a href="rds_03_0001.html">Authentication</a>.</li><li id="rds_01_0004__en-us_topic_0240111818_li1991981933613">Before calling this API, obtain the required <a href="https://docs.otc.t-systems.com/en-us/endpoint/index.html" target="_blank" rel="noopener noreferrer">region and endpoint</a>.</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_01_0004__section31729879101549"><h4 class="sectiontitle">URI</h4><ul id="rds_01_0004__ul19983374101549"><li id="rds_01_0004__li45632644101549">URI format<p id="rds_01_0004__p8040618101549"><a name="rds_01_0004__li45632644101549"></a><a name="li45632644101549"></a>GET https://{<em id="rds_01_0004__i356415616159">Endpoint</em>}/v3/{project_id}/instances?id={id}&name={name}&type={type}&datastore_type={datastore_type}&vpc_id={vpc_id}&subnet_id={subnet_id}&offset={offset}&limit={limit}</p>
|
|
</li><li id="rds_01_0004__li47310355101549">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_01_0004__table23140016101549" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="rds_01_0004__row27795795101549"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="rds_01_0004__p36866898101549"><strong id="rds_01_0004__b93591420113513">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="rds_01_0004__p156174610411"><strong id="rds_01_0004__b16291622193519">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25.14%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="rds_01_0004__p33428750101549"><strong id="rds_01_0004__b17801142220351">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="44.86%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="rds_01_0004__p23374190101549"><strong id="rds_01_0004__b1867715230358">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_01_0004__row14261210101549"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="rds_01_0004__p104922035165518">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="rds_01_0004__p1956194615414">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.14%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="rds_01_0004__p18047737101549">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.86%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="rds_01_0004__p52580603101549">Specifies the project ID of a tenant in a region.</p>
|
|
<p id="rds_01_0004__p16476914175718">For details about how to obtain the project ID, see <a href="rds_03_0002.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0004__row197844933113"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="rds_01_0004__p84691445594">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="rds_01_0004__p8572046164115">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.14%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="rds_01_0004__p346994410599">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.86%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="rds_01_0004__p84691144145915">Specifies the DB instance ID.</p>
|
|
<p id="rds_01_0004__p0469164495913">The asterisk (*) is reserved for the system. If the instance ID starts with *, it indicates that fuzzy match is performed based on the value following * Otherwise, the exact match is performed based on the instance ID. The value cannot contain only asterisks (*).</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0004__row2489615125917"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="rds_01_0004__p16469194410599">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="rds_01_0004__p857164618412">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.14%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="rds_01_0004__p6469124415911">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.86%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="rds_01_0004__p946944412596">Specifies the DB instance name.</p>
|
|
<p id="rds_01_0004__p2469164416591">The asterisk (*) is reserved for the system. If the instance name starts with *, it indicates that fuzzy match is performed based on the value following * Otherwise, the exact match is performed based on the instance name. The value cannot contain only asterisks (*).</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0004__row1525110198591"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="rds_01_0004__p1773813251016">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="rds_01_0004__p15734616412">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.14%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="rds_01_0004__p12738925418">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.86%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="rds_01_0004__p573892515118">Specifies the instance type based query. The value is <strong id="rds_01_0004__b7198194835318">Single</strong>, <strong id="rds_01_0004__b261715012533">Ha</strong>, or <strong id="rds_01_0004__b99511153125320">Replica</strong>, which correspond to single instance, primary/standby instances, and read replica, respectively.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0004__row4676255803"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="rds_01_0004__p373852511110">datastore_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="rds_01_0004__p75754610414">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.14%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="rds_01_0004__p373812511115">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.86%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="rds_01_0004__p1318733012217">Specifies the database type. Its value can be any of the following and is case-sensitive:</p>
|
|
<ul id="rds_01_0004__ul924933143511"><li id="rds_01_0004__li1195974113511">MySQL</li><li id="rds_01_0004__li2014417783511">PostgreSQL</li><li id="rds_01_0004__li192495323520">SQLServer</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0004__row391114581019"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="rds_01_0004__p873811251313">vpc_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="rds_01_0004__p75794618416">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.14%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="rds_01_0004__p147381257113">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.86%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="rds_01_0004__p87381125112">Specifies the VPC ID.</p>
|
|
<ul id="rds_01_0004__ul475921618452"><li id="rds_01_0004__en-us_topic_0224329974_li67651171359">Method 1: Log in to VPC console and view the VPC ID in the VPC details.</li><li id="rds_01_0004__en-us_topic_0224329974_li948317405377">Method 2: See the "Querying VPCs" section in the <em id="rds_01_0004__en-us_topic_0224329974_i842352697165629">Virtual Private Cloud API Reference</em>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0004__row57790155118"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="rds_01_0004__p173811251019">subnet_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="rds_01_0004__p1757194617418">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.14%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="rds_01_0004__p073882514117">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.86%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="rds_01_0004__p7738172511118">Specifies the network ID of the subnet.</p>
|
|
<ul id="rds_01_0004__ul375971611456"><li id="rds_01_0004__en-us_topic_0224329974_li121534277395">Method 1: Log in to VPC console and click the target subnet on the <strong id="rds_01_0004__en-us_topic_0224329974_b4101174416409">Subnets</strong> page. You can view the network ID on the displayed page.</li><li id="rds_01_0004__li1626657149">Method 2: See the "Querying Subnets" section under "APIs" or the "Querying Networks" section under "OpenStack Neutron APIs" in <em id="rds_01_0004__i142661571444">Virtual Private Cloud API Reference</em>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0004__row378505943118"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="rds_01_0004__p18469644135918">offset</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="rds_01_0004__p20571146174113">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.14%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="rds_01_0004__p64691544165913">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.86%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="rds_01_0004__p184691344165912">Specifies the index position. If <strong id="rds_01_0004__b70205942519474">offset</strong> is set to <em id="rds_01_0004__i84235269720751">N</em>, the resource query starts from the N+1 piece of data. The value is <strong id="rds_01_0004__b84235270620630">0</strong> by default, indicating that the query starts from the first piece of data. The value must be a positive number.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0004__row31182243218"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="rds_01_0004__p646954415917">limit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="rds_01_0004__p125714615419">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.14%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="rds_01_0004__p7469444115910">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.86%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="rds_01_0004__p19469194465917">Specifies the number of records to be queried. The default value is <strong id="rds_01_0004__b78578273159">100</strong>. The value cannot be a negative number. The minimum value is <strong id="rds_01_0004__b99981031141518">1</strong> and the maximum value is <strong id="rds_01_0004__b9972173720152">100</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="rds_01_0004__p3935181110318"></p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_01_0004__section28070818101549"><h4 class="sectiontitle">Request</h4><ul id="rds_01_0004__ul1183180183717"><li id="rds_01_0004__li1283110163719">Request parameters<p id="rds_01_0004__p848415163614"><a name="rds_01_0004__li1283110163719"></a><a name="li1283110163719"></a>None</p>
|
|
</li></ul>
|
|
<ul id="rds_01_0004__ul3281857164212"><li id="rds_01_0004__li54691335131412">Example<ul id="rds_01_0004__ul1989215471417"><li id="rds_01_0004__li72991448101415">Querying all DB instances<p id="rds_01_0004__p1454414211213"><a name="rds_01_0004__li72991448101415"></a><a name="li72991448101415"></a>GET https://rds.eu-de.otc.t-systems.com/v3/97b026aa9cc4417888c14c84a1ad9860/instances</p>
|
|
</li><li id="rds_01_0004__li1893317503146">Querying DB instances based on search criteria<p id="rds_01_0004__p153651639058"><a name="rds_01_0004__li1893317503146"></a><a name="li1893317503146"></a>GET https://rds.eu-de.otc.t-systems.com/v3/97b026aa9cc4417888c14c84a1ad9860/instances?id=ed7cc6166ec24360a5ed5c5c9c2ed726in01&name=hy&type=Ha&datastore_type=MySQL&vpc_id=19e5d45d-70fd-4a91-87e9-b27e71c9891f&subnet_id=bd51fb45-2dcb-4296-8783-8623bfe89bb7&offset=0&limit=10&tags=rds001=001,rds002=002</p>
|
|
</li></ul>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_01_0004__section62531952101549"><h4 class="sectiontitle">Response</h4><ul id="rds_01_0004__ul31923327101549"><li id="rds_01_0004__li18874490101549">Normal response
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_01_0004__table1344412393258" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="rds_01_0004__row849512397255"><th align="left" class="cellrowborder" valign="top" width="32.653265326532654%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="rds_01_0004__p1349533912516"><strong id="rds_01_0004__b6925212132317">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.673367336733676%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="rds_01_0004__p174959399251"><strong id="rds_01_0004__b16675874245">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.673367336733676%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="rds_01_0004__p174951639112515"><strong id="rds_01_0004__b16524190243">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_01_0004__row17495183914254"><td class="cellrowborder" valign="top" width="32.653265326532654%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="rds_01_0004__p249563917251">instances</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.673367336733676%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="rds_01_0004__p15495133902512">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.673367336733676%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="rds_01_0004__p4496103920258">Indicates the DB instance information.</p>
|
|
<p id="rds_01_0004__p193231246205415">For details, see <a href="#rds_01_0004__table2058713718267">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0004__row1449612393259"><td class="cellrowborder" valign="top" width="32.653265326532654%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="rds_01_0004__p1249612391257">total_count</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.673367336733676%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="rds_01_0004__p749613911252">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.673367336733676%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="rds_01_0004__p1549693920256">Indicates the total number of resources.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="rds_01_0004__table2058713718267"></a><a name="table2058713718267"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_01_0004__table2058713718267" frame="border" border="1" rules="all"><caption><b>Table 3 </b>instances field data structure description</caption><thead align="left"><tr id="rds_01_0004__row1012214832618"><th align="left" class="cellrowborder" valign="top" width="23.23%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="rds_01_0004__p312219812612"><strong id="rds_01_0004__b2522113910257">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25.25%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="rds_01_0004__p91221985265"><strong id="rds_01_0004__b145294404251">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="51.519999999999996%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="rds_01_0004__p111226816261"><strong id="rds_01_0004__b54721741152510">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_01_0004__row12122489261"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_01_0004__p51221889266">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_01_0004__p1612213892617">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.519999999999996%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_01_0004__p412220818265">Indicates the DB instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0004__row512218162619"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_01_0004__p7122118182612">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_01_0004__p21225815262">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.519999999999996%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_01_0004__p2122198142610">Indicates the created DB instance name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0004__row11222822616"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_01_0004__p4123198202614">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_01_0004__p1912318818265">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.519999999999996%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_01_0004__p121231486267">Indicates the DB instance status.</p>
|
|
<p id="rds_01_0004__p14123381266">Value:</p>
|
|
<p id="rds_01_0004__p121235818262">If the value is <strong id="rds_01_0004__b84235270616547_1">BUILD</strong>, the instance is being created.</p>
|
|
<p id="rds_01_0004__p1712312817262">If the value is <strong id="rds_01_0004__b842352706165415">ACTIVE</strong>, the instance is normal.</p>
|
|
<p id="rds_01_0004__p101231892614">If the value is <strong id="rds_01_0004__b842352706165427">FAILED</strong>, the instance is abnormal.</p>
|
|
<p id="rds_01_0004__p16123485263">If the value is <strong id="rds_01_0004__b84235270616547_3">MODIFYING</strong>, the instance is being scaled up.</p>
|
|
<p id="rds_01_0004__p111231284264">If the value is <strong id="rds_01_0004__b8630202172718">REBOOTING</strong>, the instance is being rebooted.</p>
|
|
<p id="rds_01_0004__p41231185269">If the value is <strong id="rds_01_0004__b84235270616547_7">RESTORING</strong>, the instance is being restored.</p>
|
|
<p id="rds_01_0004__p91231389269">If the value is <strong id="rds_01_0004__b5168101082716">MODIFYING INSTANCE TYPE</strong>, the instance is changing from primary to standby.</p>
|
|
<p id="rds_01_0004__p112378152610">If the value is <strong id="rds_01_0004__b1148214486276">SWITCHOVER</strong>, the primary/standby switchover is being performed.</p>
|
|
<p id="rds_01_0004__p171233820263">If the value is <strong id="rds_01_0004__b65135702810">MIGRATING</strong>, the instance is being migrated.</p>
|
|
<p id="rds_01_0004__p612478102610">If the value is <strong id="rds_01_0004__b753162915291">BACKING UP</strong>, the instance is being backed up.</p>
|
|
<p id="rds_01_0004__p1412416819260">If the value is <strong id="rds_01_0004__b16596103714309">MODIFYING DATABASE PORT</strong>, the database port is being changed.</p>
|
|
<p id="rds_01_0004__p3334111141212">If the value is <strong id="rds_01_0004__b1383414695314">SHUTDOWN</strong>, the DB instance is stopped.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0004__row127071835102214"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_01_0004__p3511124416558">alias</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_01_0004__p15121344125518">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.519999999999996%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_01_0004__p135121144105513">Indicates the DB instance alias.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0004__row20124108152614"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_01_0004__p131247815269">private_ips</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_01_0004__p6124686265">List<String></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.519999999999996%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_01_0004__p812417819261">Indicates the private IP address list. It is a blank string until an ECS is created.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0004__row5124128112611"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_01_0004__p111248842616">public_ips</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_01_0004__p1212418810269">List<String></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.519999999999996%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_01_0004__p7124128142615">Indicates the public IP address list.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0004__row312488192611"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_01_0004__p512416818269">port</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_01_0004__p6124386267">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.519999999999996%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_01_0004__p201241815264">Indicates the database port number.</p>
|
|
<ul id="rds_01_0004__ul164621729141114"><li id="rds_01_0004__en-us_topic_0224329974_li1643823618291">The MySQL database port ranges from 1024 to 65535 (excluding 12017 and 33071, which are occupied by the RDS system and cannot be used).</li><li id="rds_01_0004__en-us_topic_0224329974_li10438636192916">The PostgreSQL database port ranges from 2100 to 9500.</li><li id="rds_01_0004__en-us_topic_0224329974_li2438203662918">The Microsoft SQL Server database port is 1433 or ranges from 2100 to 9500 (excluding 5355 and 5985). </li></ul>
|
|
<p id="rds_01_0004__p1172615390340">If this parameter is not set, the default value is as follows:</p>
|
|
<ul id="rds_01_0004__ul13855195423417"><li id="rds_01_0004__en-us_topic_0224329974_li25818392140">For MySQL, the default value is <strong id="rds_01_0004__en-us_topic_0224329974_b1829614472613">3306</strong>.</li><li id="rds_01_0004__en-us_topic_0224329974_li93271730121413">For PostgreSQL, the default value is <strong id="rds_01_0004__en-us_topic_0224329974_b13817121574">5432</strong>.</li><li id="rds_01_0004__en-us_topic_0224329974_li12965162714143">For Microsoft SQL Server, the default value is <strong id="rds_01_0004__en-us_topic_0224329974_b1633152143014">1433</strong>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0004__row712411820262"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_01_0004__p101241481266">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_01_0004__p31241786269">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.519999999999996%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_01_0004__p12124198192616">The value is <strong id="rds_01_0004__b11419161415322">Single</strong>, <strong id="rds_01_0004__b1742021473220">Ha</strong>, or <strong id="rds_01_0004__b942051416325">Replica</strong>, which correspond to single instance, primary/standby instances, and read replica, respectively.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0004__row112413820261"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_01_0004__p191242814263">ha</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_01_0004__p16124148172612">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.519999999999996%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_01_0004__p1612513852611">Indicates the primary/standby DB instance information. Returned only when you obtain a primary/standby DB instance list.</p>
|
|
<p id="rds_01_0004__p769251117558">For details, see <a href="#rds_01_0004__table7736377269">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0004__row31251489265"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_01_0004__p4125583264">region</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_01_0004__p4125780262">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.519999999999996%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_01_0004__p21253816269">Indicates the region where the DB instance is deployed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0004__row312513892610"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_01_0004__p121253811264">datastore</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_01_0004__p10125688266">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.519999999999996%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_01_0004__p112510816261">Indicates the database information.</p>
|
|
<p id="rds_01_0004__p1167093118552">For details, see <a href="#rds_01_0004__table187591675262">Table 5</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0004__row1812568112610"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_01_0004__p1012518822614">created</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_01_0004__p14125178152611">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.519999999999996%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_01_0004__p1512538142614">Indicates the creation time in the "yyyy-mm-ddThh:mm:ssZ" format.</p>
|
|
<p id="rds_01_0004__p13125168192618"><strong id="rds_01_0004__b842352706151812">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="rds_01_0004__b842352706153833">Z</strong> indicates the time zone offset. </p>
|
|
<p id="rds_01_0004__p112518202611">The value is empty when the DB instance is being created. After the DB instance is created, the value is not empty.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0004__row181263892618"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_01_0004__p4126128202612">updated</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_01_0004__p18126380262">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.519999999999996%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_01_0004__p20126481268">Indicates the update time. The format is the same as that of the <strong id="rds_01_0004__b842352706111518">created</strong> field.</p>
|
|
<p id="rds_01_0004__p91260812610">The value is empty when the DB instance is being created. After the DB instance is created, the value is not empty.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0004__row1512615882612"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_01_0004__p812613816267">db_user_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_01_0004__p21261862611">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.519999999999996%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_01_0004__p21263832619">Indicates the default username.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0004__row131261785260"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_01_0004__p141261383269">vpc_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_01_0004__p5126186261">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.519999999999996%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_01_0004__p8126198102610">Indicates the VPC ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0004__row1712617817268"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_01_0004__p912611812618">subnet_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_01_0004__p412610862610">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.519999999999996%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_01_0004__p1512628132610">Indicates the network ID of the subnet.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0004__row71261889261"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_01_0004__p5126158132618">security_group_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_01_0004__p1412648162614">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.519999999999996%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_01_0004__p312698162616">Indicates the security group ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0004__row1513941712313"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_01_0004__p613312316410">cpu</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_01_0004__p2013363154115">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.519999999999996%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_01_0004__p21331339412">Indicates the number of CPUs. For example, the value <strong id="rds_01_0004__b1311053793611">1</strong> indicates 1 vCPU.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0004__row9265181442315"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_01_0004__p1934416478416">mem</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_01_0004__p1344174714112">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.519999999999996%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_01_0004__p16344124754117">Indicates the memory size in GB.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0004__row1712688102610"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_01_0004__p6126178152619">flavor_ref</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_01_0004__p712778112619">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.519999999999996%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_01_0004__p19127185266">Indicates the specification code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0004__row10127989269"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_01_0004__p91273811266">volume</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_01_0004__p19127583260">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.519999999999996%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_01_0004__p15127108132618">Indicates the volume information.</p>
|
|
<p id="rds_01_0004__p146713272134">For details, see <a href="#rds_01_0004__table14771167122611">Table 6</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0004__row181274882618"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_01_0004__p212715818262">switch_strategy</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_01_0004__p71271687262">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.519999999999996%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_01_0004__p14127148202616">Indicates the database switchover policy. The value can be <strong id="rds_01_0004__b842352706111711">reliability</strong> or <strong id="rds_01_0004__b842352706111714">availability</strong>, indicating the reliability first and availability first, respectively.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0004__row13127118172614"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_01_0004__p13127178112618">backup_strategy</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_01_0004__p1112713817269">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.519999999999996%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_01_0004__p812798122620">Indicates the backup policy.</p>
|
|
<p id="rds_01_0004__p11861938121316">For details, see <a href="#rds_01_0004__table578797132615">Table 7</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0004__row41275872611"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_01_0004__p212717819265">maintenance_window</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_01_0004__p10128148162614">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.519999999999996%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_01_0004__p17128168152618">Indicates the start time of the maintenance time window in the UTC format.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0004__row712828162618"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_01_0004__p1812858152614">nodes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_01_0004__p195351922184915">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.519999999999996%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_01_0004__p1512810892618">Indicates the primary/standby DB instance information.</p>
|
|
<p id="rds_01_0004__p118919506137">For details, see <a href="#rds_01_0004__table1179987152611">Table 8</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0004__row212815832613"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_01_0004__p012888122618">related_instance</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_01_0004__p18380920114911">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.519999999999996%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_01_0004__p161289862617">Indicates the list of associated DB instances.</p>
|
|
<p id="rds_01_0004__p33188091418">For details, see <a href="#rds_01_0004__table15816167142613">Table 9</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0004__row3128118202611"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_01_0004__p1212817822619">disk_encryption_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_01_0004__p101284862612">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.519999999999996%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_01_0004__p11128168122612">Indicates the disk encryption key ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0004__row3128682261"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_01_0004__p4128485260">enterprise_project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_01_0004__p15128148182610">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.519999999999996%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_01_0004__p1012815812618">Indicates the enterprise project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0004__row10128384263"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_01_0004__p14128582264">time_zone</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_01_0004__p171288842614">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.519999999999996%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_01_0004__p1012858132612">Indicates the time zone.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0004__row31991820101518"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_01_0004__p12016301915">charge_info</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_01_0004__p24228398437">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.519999999999996%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_01_0004__p180153019913">Indicates the billing information, which is pay-per-use.</p>
|
|
<p id="rds_01_0004__p195191056102519">For details, see <a href="#rds_01_0004__table992615211258">Table 10</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0004__row11705111118118"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_01_0004__p47061211101119">tags</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_01_0004__p1181162512111">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.519999999999996%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_01_0004__p1870691111114">Indicates the tag list. If there is no tag in the list, an empty array is returned.</p>
|
|
<p id="rds_01_0004__p105311212191">For details, see <a href="#rds_01_0004__table10618123761215">Table 11</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0004__row6350212172415"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_01_0004__p185151217123710">associated_with_ddm</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_01_0004__p45155174379">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.519999999999996%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_01_0004__p15515417133718">Indicates whether a DDM instance has been associated.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="rds_01_0004__table7736377269"></a><a name="table7736377269"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_01_0004__table7736377269" frame="border" border="1" rules="all"><caption><b>Table 4 </b>ha field data structure description</caption><thead align="left"><tr id="rds_01_0004__row01299822617"><th align="left" class="cellrowborder" valign="top" width="23.23%" id="mcps1.3.4.2.1.3.2.4.1.1"><p id="rds_01_0004__p5130208112619"><strong id="rds_01_0004__b1278276876">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="22.220000000000002%" id="mcps1.3.4.2.1.3.2.4.1.2"><p id="rds_01_0004__p6130118162616"><strong id="rds_01_0004__b1528075703">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="54.55%" id="mcps1.3.4.2.1.3.2.4.1.3"><p id="rds_01_0004__p1813038172617"><strong id="rds_01_0004__b1679499161">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_01_0004__row131308832618"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="rds_01_0004__p1413038202617">replication_mode</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="rds_01_0004__p151302812612">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.55%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="rds_01_0004__p12130789263">Indicates the replication mode for the standby DB instance.</p>
|
|
<p id="rds_01_0004__p613098162616">The value cannot be empty.</p>
|
|
<ul id="rds_01_0004__ul30551132181655"><li id="rds_01_0004__li6524738181655">For MySQL, the value is <strong id="rds_01_0004__b15652641192">async</strong> or <strong id="rds_01_0004__b66521841299">semisync</strong>.</li><li id="rds_01_0004__li58722643181655">For PostgreSQL, the value is <strong id="rds_01_0004__b3672443913">async</strong> or <strong id="rds_01_0004__b3672941790">sync</strong>.</li><li id="rds_01_0004__li58741746181655">For Microsoft SQL Server, the value is <strong id="rds_01_0004__b1668664192">sync</strong>.</li></ul>
|
|
<div class="note" id="rds_01_0004__note58913671181655"><span class="notetitle"> NOTE: </span><div class="notebody"><ul id="rds_01_0004__ul60460995181655"><li id="rds_01_0004__li7278047181655"><strong id="rds_01_0004__b177021949918">async</strong> indicates the asynchronous replication mode.</li><li id="rds_01_0004__li65502428181655"><strong id="rds_01_0004__b117105410916">semisync</strong> indicates the semi-synchronous replication mode.</li><li id="rds_01_0004__li52650948181655"><strong id="rds_01_0004__b147333419911">sync</strong> indicates the synchronous replication mode.</li></ul>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="rds_01_0004__table187591675262"></a><a name="table187591675262"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_01_0004__table187591675262" frame="border" border="1" rules="all"><caption><b>Table 5 </b>datastore field data structure description</caption><thead align="left"><tr id="rds_01_0004__row131330815263"><th align="left" class="cellrowborder" valign="top" width="23.23%" id="mcps1.3.4.2.1.4.2.4.1.1"><p id="rds_01_0004__p613316812264"><strong id="rds_01_0004__b496687195">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="22.220000000000002%" id="mcps1.3.4.2.1.4.2.4.1.2"><p id="rds_01_0004__p3133188122610"><strong id="rds_01_0004__b552035273">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="54.55%" id="mcps1.3.4.2.1.4.2.4.1.3"><p id="rds_01_0004__p21331385269"><strong id="rds_01_0004__b1869307043">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_01_0004__row613358122613"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.4.2.4.1.1 "><p id="rds_01_0004__p12134178132620">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.4.2.1.4.2.4.1.2 "><p id="rds_01_0004__p1713415882612">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.55%" headers="mcps1.3.4.2.1.4.2.4.1.3 "><p id="rds_01_0004__p1713419813260">Indicates the DB engine.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0004__row16134281267"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.4.2.4.1.1 "><p id="rds_01_0004__p11134386261">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.4.2.1.4.2.4.1.2 "><p id="rds_01_0004__p15134148102620">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.55%" headers="mcps1.3.4.2.1.4.2.4.1.3 "><p id="rds_01_0004__p181347842615">Indicates the database version.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0004__row799011813317"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.4.2.4.1.1 "><p id="rds_01_0004__p13457522114814">complete_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.4.2.1.4.2.4.1.2 "><p id="rds_01_0004__p11457182212486">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.55%" headers="mcps1.3.4.2.1.4.2.4.1.3 "><p id="rds_01_0004__p18457822154819">Indicates the complete version number. This parameter is returned only when the DB engine is PostgreSQL.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="rds_01_0004__table14771167122611"></a><a name="table14771167122611"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_01_0004__table14771167122611" frame="border" border="1" rules="all"><caption><b>Table 6 </b>volume field data structure description</caption><thead align="left"><tr id="rds_01_0004__row1713628182616"><th align="left" class="cellrowborder" valign="top" width="23.23%" id="mcps1.3.4.2.1.5.2.4.1.1"><p id="rds_01_0004__p913708102613"><strong id="rds_01_0004__b93749741">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="22.220000000000002%" id="mcps1.3.4.2.1.5.2.4.1.2"><p id="rds_01_0004__p1113768112615"><strong id="rds_01_0004__b1405944312">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="54.55%" id="mcps1.3.4.2.1.5.2.4.1.3"><p id="rds_01_0004__p71376812616"><strong id="rds_01_0004__b649116548">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_01_0004__row161373852620"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.5.2.4.1.1 "><p id="rds_01_0004__p13137148152619">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.4.2.1.5.2.4.1.2 "><p id="rds_01_0004__p41371185261">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.55%" headers="mcps1.3.4.2.1.5.2.4.1.3 "><p id="rds_01_0004__p4137389266">Indicates the volume type.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0004__row61371486268"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.5.2.4.1.1 "><p id="rds_01_0004__p013716812613">size</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.4.2.1.5.2.4.1.2 "><p id="rds_01_0004__p5137108142610">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.55%" headers="mcps1.3.4.2.1.5.2.4.1.3 "><p id="rds_01_0004__p1813820832618">Indicates the volume size.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="rds_01_0004__table578797132615"></a><a name="table578797132615"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_01_0004__table578797132615" frame="border" border="1" rules="all"><caption><b>Table 7 </b>backup_strategy field data structure description</caption><thead align="left"><tr id="rds_01_0004__row171405802610"><th align="left" class="cellrowborder" valign="top" width="23.23%" id="mcps1.3.4.2.1.6.2.4.1.1"><p id="rds_01_0004__p61401783265"><strong id="rds_01_0004__b118179231">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="22.220000000000002%" id="mcps1.3.4.2.1.6.2.4.1.2"><p id="rds_01_0004__p4140287264"><strong id="rds_01_0004__b717084053">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="54.55%" id="mcps1.3.4.2.1.6.2.4.1.3"><p id="rds_01_0004__p101401384269"><strong id="rds_01_0004__b1919243190">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_01_0004__row111402862612"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.6.2.4.1.1 "><p id="rds_01_0004__p91403822614">start_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.4.2.1.6.2.4.1.2 "><p id="rds_01_0004__p1414018813267">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.55%" headers="mcps1.3.4.2.1.6.2.4.1.3 "><p id="rds_01_0004__p161401381268">Indicates the backup time window. Automated backups will be triggered during the backup time window.</p>
|
|
<p id="rds_01_0004__p1914115872619">The time is in the UTC format.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0004__row91412081260"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.6.2.4.1.1 "><p id="rds_01_0004__p141411814267">keep_days</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.4.2.1.6.2.4.1.2 "><p id="rds_01_0004__p14141188192618">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.55%" headers="mcps1.3.4.2.1.6.2.4.1.3 "><p id="rds_01_0004__p3141138182619">Indicates the number of days to retain the generated backup files.</p>
|
|
<p id="rds_01_0004__p1914188122614">The value range is from 0 to 732. If the value is <strong id="rds_01_0004__b84235270611238">0</strong>, the automated backup policy is not configured or has been disabled. 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="rds_01_0004__table1179987152611"></a><a name="table1179987152611"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_01_0004__table1179987152611" frame="border" border="1" rules="all"><caption><b>Table 8 </b>nodes field data structure description</caption><thead align="left"><tr id="rds_01_0004__row1214388172616"><th align="left" class="cellrowborder" valign="top" width="23.23%" id="mcps1.3.4.2.1.7.2.4.1.1"><p id="rds_01_0004__p7143208102615">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="22.220000000000002%" id="mcps1.3.4.2.1.7.2.4.1.2"><p id="rds_01_0004__p514314814266">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="54.55%" id="mcps1.3.4.2.1.7.2.4.1.3"><p id="rds_01_0004__p9143198142613">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_01_0004__row141432083267"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.7.2.4.1.1 "><p id="rds_01_0004__p1714313815266">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.4.2.1.7.2.4.1.2 "><p id="rds_01_0004__p10143185266">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.55%" headers="mcps1.3.4.2.1.7.2.4.1.3 "><p id="rds_01_0004__p914316812265">Indicates the node ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0004__row214388192612"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.7.2.4.1.1 "><p id="rds_01_0004__p10143198142611">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.4.2.1.7.2.4.1.2 "><p id="rds_01_0004__p1114338112612">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.55%" headers="mcps1.3.4.2.1.7.2.4.1.3 "><p id="rds_01_0004__p414313872615">Indicates the node name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0004__row1314318819263"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.7.2.4.1.1 "><p id="rds_01_0004__p17143118122616">role</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.4.2.1.7.2.4.1.2 "><p id="rds_01_0004__p18145138112614">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.55%" headers="mcps1.3.4.2.1.7.2.4.1.3 "><p id="rds_01_0004__p814516872618">Indicates the node type. The value can be <strong id="rds_01_0004__b842352706113246">master</strong>, <strong id="rds_01_0004__b842352706113249">slave</strong>, or <strong id="rds_01_0004__b842352706113253">readreplica</strong>, indicating the primary node, standby node, and read replica node, respectively.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0004__row161456872616"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.7.2.4.1.1 "><p id="rds_01_0004__p214578162611">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.4.2.1.7.2.4.1.2 "><p id="rds_01_0004__p51451283263">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.55%" headers="mcps1.3.4.2.1.7.2.4.1.3 "><p id="rds_01_0004__p114515814267">Indicates the node status.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0004__row9145168102610"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.7.2.4.1.1 "><p id="rds_01_0004__p171451087262">availability_zone</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.4.2.1.7.2.4.1.2 "><p id="rds_01_0004__p714518818267">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.55%" headers="mcps1.3.4.2.1.7.2.4.1.3 "><p id="rds_01_0004__p131459819268">Indicates the AZ.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="rds_01_0004__table15816167142613"></a><a name="table15816167142613"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_01_0004__table15816167142613" frame="border" border="1" rules="all"><caption><b>Table 9 </b>related_instance field data structure description</caption><thead align="left"><tr id="rds_01_0004__row4147148102612"><th align="left" class="cellrowborder" valign="top" width="23.23%" id="mcps1.3.4.2.1.8.2.4.1.1"><p id="rds_01_0004__p514720872619"><strong id="rds_01_0004__b576045617">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="22.220000000000002%" id="mcps1.3.4.2.1.8.2.4.1.2"><p id="rds_01_0004__p51471382264"><strong id="rds_01_0004__b1665235674">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="54.55%" id="mcps1.3.4.2.1.8.2.4.1.3"><p id="rds_01_0004__p614718817265"><strong id="rds_01_0004__b1977839152">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_01_0004__row13147886260"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.8.2.4.1.1 "><p id="rds_01_0004__p81470811265">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.4.2.1.8.2.4.1.2 "><p id="rds_01_0004__p1114718832613">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.55%" headers="mcps1.3.4.2.1.8.2.4.1.3 "><p id="rds_01_0004__p814816816263">Indicates the associated DB instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0004__row14148685268"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.8.2.4.1.1 "><p id="rds_01_0004__p01483872612">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.4.2.1.8.2.4.1.2 "><p id="rds_01_0004__p10148784263">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.55%" headers="mcps1.3.4.2.1.8.2.4.1.3 "><p id="rds_01_0004__p75017462385">Indicates the associated DB instance type.</p>
|
|
<ul id="rds_01_0004__ul436512209393"><li id="rds_01_0004__li1636592018397"><strong id="rds_01_0004__b978194910446">replica_of</strong>: indicates the primary DB instance.</li><li id="rds_01_0004__li655419516394"><strong id="rds_01_0004__b72493481257">replica</strong>: indicates read replicas.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="rds_01_0004__table992615211258"></a><a name="table992615211258"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_01_0004__table992615211258" frame="border" border="1" rules="all"><caption><b>Table 10 </b>chargeInfo field data structure description</caption><thead align="left"><tr id="rds_01_0004__row139830521259"><th align="left" class="cellrowborder" valign="top" width="15.384615384615385%" id="mcps1.3.4.2.1.9.2.5.1.1"><p id="rds_01_0004__p18997135202515"><strong id="rds_01_0004__b1075094211457">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.2.1.9.2.5.1.2"><p id="rds_01_0004__p4995352514"><strong id="rds_01_0004__b9727181864620">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.346153846153847%" id="mcps1.3.4.2.1.9.2.5.1.3"><p id="rds_01_0004__p7219531251"><strong id="rds_01_0004__b16481220164610">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="43.269230769230774%" id="mcps1.3.4.2.1.9.2.5.1.4"><p id="rds_01_0004__p143485310253"><strong id="rds_01_0004__b22212221466">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_01_0004__row44865311257"><td class="cellrowborder" valign="top" width="15.384615384615385%" headers="mcps1.3.4.2.1.9.2.5.1.1 "><p id="rds_01_0004__p147051450112610">charge_mode</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.9.2.5.1.2 "><p id="rds_01_0004__p170519503263">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.346153846153847%" headers="mcps1.3.4.2.1.9.2.5.1.3 "><p id="rds_01_0004__p3705750182610">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.269230769230774%" headers="mcps1.3.4.2.1.9.2.5.1.4 "><p id="rds_01_0004__p13419304384">Indicates the billing mode.</p>
|
|
<p id="rds_01_0004__p134812510201">The value <strong id="rds_01_0004__b950011618311">postPaid</strong> indicates the pay-per-use billing mode.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="rds_01_0004__table10618123761215"></a><a name="table10618123761215"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_01_0004__table10618123761215" frame="border" border="1" rules="all"><caption><b>Table 11 </b>tags field data structure description</caption><thead align="left"><tr id="rds_01_0004__row196191937181212"><th align="left" class="cellrowborder" valign="top" width="23.23%" id="mcps1.3.4.2.1.10.2.4.1.1"><p id="rds_01_0004__p6619153714128"><strong id="rds_01_0004__b369110112015">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="22.220000000000002%" id="mcps1.3.4.2.1.10.2.4.1.2"><p id="rds_01_0004__p1161917378127"><strong id="rds_01_0004__b189733321">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="54.55%" id="mcps1.3.4.2.1.10.2.4.1.3"><p id="rds_01_0004__p9619113715125"><strong id="rds_01_0004__b589517112219">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_01_0004__row1661913720127"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.10.2.4.1.1 "><p id="rds_01_0004__p16191337161216">key</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.4.2.1.10.2.4.1.2 "><p id="rds_01_0004__p11619103714124">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.55%" headers="mcps1.3.4.2.1.10.2.4.1.3 "><p id="rds_01_0004__p12619737191211">Indicates the tag key.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_01_0004__row2619143721212"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.10.2.4.1.1 "><p id="rds_01_0004__p862043713126">value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.4.2.1.10.2.4.1.2 "><p id="rds_01_0004__p51955512132">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.55%" headers="mcps1.3.4.2.1.10.2.4.1.3 "><p id="rds_01_0004__p19620163721215">Indicates the tag value.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="rds_01_0004__li27619632">Example normal response<div class="p" id="rds_01_0004__p12928361362"><a name="rds_01_0004__li27619632"></a><a name="li27619632"></a>Query DB instances based on specified conditions.<pre class="codeblock" id="rds_01_0004__codeblock169517278441">{
|
|
"instances": [{
|
|
"id": "ed7cc6166ec24360a5ed5c5c9c2ed726in01",
|
|
"status": "ACTIVE",
|
|
"name": "mysql-0820-022709-01",
|
|
"port": 3306,
|
|
"type": "Single",
|
|
"region": "eu-de",
|
|
"datastore": {
|
|
"type": "MySQL",
|
|
"version": "5.7"
|
|
},
|
|
"created": "2018-08-20T02:33:49+0800",
|
|
"updated": "2018-08-20T02:33:50+0800",
|
|
"volume": {
|
|
"type": "ULTRAHIGH",
|
|
"size": 100
|
|
},
|
|
"nodes": [{
|
|
"id": "06f1c2ad57604ae89e153e4d27f4e4b8no01",
|
|
"name": "mysql-0820-022709-01_node0",
|
|
"role": "master",
|
|
"status": "ACTIVE",
|
|
"availability_zone": "eu-de-01"
|
|
}],
|
|
"private_ips": ["192.168.0.142"],
|
|
"public_ips": ["10.154.219.187", "10.154.219.186"],
|
|
"db_user_name": "root",
|
|
"vpc_id": "b21630c1-e7d3-450d-907d-39ef5f445ae7",
|
|
"subnet_id": "45557a98-9e17-4600-8aec-999150bc4eef",
|
|
"security_group_id": "38815c5c-482b-450a-80b6-0a301f2afd97",
|
|
"flavor_ref": "rds.mysql.n1.large",
|
|
"switch_strategy": "",
|
|
"backup_strategy": {
|
|
"start_time": "19:00-20:00",
|
|
"keep_days": 7
|
|
},
|
|
"maintenance_window": "02:00-06:00",
|
|
"related_instance": [],
|
|
"disk_encryption_id": "",
|
|
"time_zone": ""
|
|
}],
|
|
"total_count": 1
|
|
}</pre>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="rds_01_0004__ul1858535041611"><li id="rds_01_0004__li658575014165">Query all DB instances.<pre class="codeblock" id="rds_01_0004__codeblock1158075051613">{
|
|
"instances": [{
|
|
"id": "ed7cc6166ec24360a5ed5c5c9c2ed726in01",
|
|
"status": "ACTIVE",
|
|
"name": "mysql-0820-022709-01",
|
|
"port": 3306,
|
|
"type": "Single",
|
|
"region": "eu-de",
|
|
"datastore": {
|
|
"type": "MySQL",
|
|
"version": "5.7"
|
|
},
|
|
"created": "2018-08-20T02:33:49+0800",
|
|
"updated": "2018-08-20T02:33:50+0800",
|
|
"volume": {
|
|
"type": "ULTRAHIGH",
|
|
"size": 100
|
|
},
|
|
"nodes": [{
|
|
"id": "06f1c2ad57604ae89e153e4d27f4e4b8no01",
|
|
"name": "mysql-0820-022709-01_node0",
|
|
"role": "master",
|
|
"status": "ACTIVE",
|
|
"availability_zone": "eu-de-01"
|
|
}],
|
|
"private_ips": ["192.168.0.142"],
|
|
"public_ips": ["10.154.219.187", "10.154.219.186"],
|
|
"db_user_name": "root",
|
|
"vpc_id": "b21630c1-e7d3-450d-907d-39ef5f445ae7",
|
|
"subnet_id": "45557a98-9e17-4600-8aec-999150bc4eef",
|
|
"security_group_id": "38815c5c-482b-450a-80b6-0a301f2afd97",
|
|
"flavor_ref": "rds.mysql.n1.large",
|
|
"switch_strategy": "",
|
|
"backup_strategy": {
|
|
"start_time": "19:00-20:00",
|
|
"keep_days": 7
|
|
},
|
|
"maintenance_window": "02:00-06:00",
|
|
"related_instance": [],
|
|
"disk_encryption_id": "",
|
|
"time_zone": ""
|
|
}, {
|
|
"id": "ed7cc6166ec24360a5ed5c5c9c2ed726in02",
|
|
"status": "ACTIVE",
|
|
"name": "mysql-0820-022709-02",
|
|
"port": 3306,
|
|
"type": "Single",
|
|
"region": "eu-de",
|
|
"datastore": {
|
|
"type": "MySQL",
|
|
"version": "5.6"
|
|
},
|
|
"created": "2019-08-20T02:33:49+0800",
|
|
"updated": "2019-08-20T02:33:50+0800",
|
|
"volume": {
|
|
"type": "ULTRAHIGH",
|
|
"size": 100
|
|
},
|
|
"nodes": [{
|
|
"id": "06f1c2ad57604ae89e153e4d27f4e4b8no01",
|
|
"name": "mysql-0820-022709-01_node0",
|
|
"role": "master",
|
|
"status": "ACTIVE",
|
|
"availability_zone": "eu-de-01"
|
|
}],
|
|
"private_ips": ["192.168.0.142"],
|
|
"public_ips": ["10.154.219.187", "10.154.219.186"],
|
|
"db_user_name": "root",
|
|
"vpc_id": "b21630c1-e7d3-450d-907d-39ef5f445ae7",
|
|
"subnet_id": "45557a98-9e17-4600-8aec-999150bc4eef",
|
|
"security_group_id": "38815c5c-482b-450a-80b6-0a301f2afd97",
|
|
"flavor_ref": "rds.mysql.n1.large",
|
|
"switch_strategy": "",
|
|
"backup_strategy": {
|
|
"start_time": "19:00-20:00",
|
|
"keep_days": 7
|
|
},
|
|
"maintenance_window": "02:00-06:00",
|
|
"related_instance": [],
|
|
"disk_encryption_id": "",
|
|
"time_zone": ""
|
|
}],
|
|
"total_count": 2
|
|
}</pre>
|
|
</li><li id="rds_01_0004__li15857509162">Abnormal Response<p id="rds_01_0004__p45851250181612"><a name="rds_01_0004__li15857509162"></a><a name="li15857509162"></a>For details, see <a href="en-us_topic_0032488197.html">Abnormal Request Results</a>.</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_01_0004__section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="rds_01_0004__en-us_topic_0032347778_ul7858132212142"><li id="rds_01_0004__en-us_topic_0032347778_li58581622171411">Normal<p id="rds_01_0004__en-us_topic_0032347778_p1040982941020"><a name="rds_01_0004__en-us_topic_0032347778_li58581622171411"></a><a name="en-us_topic_0032347778_li58581622171411"></a>200</p>
|
|
</li><li id="rds_01_0004__en-us_topic_0032347778_li11583183218149">Abnormal<p id="rds_01_0004__en-us_topic_0032347778_p0723374409"><a name="rds_01_0004__en-us_topic_0032347778_li11583183218149"></a><a name="en-us_topic_0032347778_li11583183218149"></a>For details, see <a href="en-us_topic_0032488240.html">Status Codes</a>.</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_01_0004__section1183074220016"><h4 class="sectiontitle">Error Code</h4><p id="rds_01_0004__en-us_topic_0032347778_p19357163913406">For details, see <a href="en-us_topic_0032488241.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0056887470.html">DB Instance Management</a></div>
|
|
</div>
|
|
</div>
|
|
|