vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/dds/api-ref/dds_api_0023.html
wangdengke2 215f33763e dds_api 
Reviewed-by: Boka, Ladislav <ladislav.boka@t-systems.com>
Co-authored-by: wangdengke2 <wangdengke2@huawei.com>
Co-committed-by: wangdengke2 <wangdengke2@huawei.com>
2024-01-11 12:41:47 +00:00

878 lines
67 KiB
HTML
Raw Permalink Blame History

<a name="dds_api_0023"></a><a name="dds_api_0023"></a>
<h1 class="topictitle1">Querying Instances and Details</h1>
<div id="body1467019492675"><div class="section" id="dds_api_0023__section6603527917262"><h4 class="sectiontitle">Function</h4><p id="dds_api_0023__p4725737717262">This API is used to query instances and details based on specified conditions.</p>
</div>
<div class="section" id="dds_api_0023__section2266321117262"><h4 class="sectiontitle">URI</h4><ul id="dds_api_0023__ul2378084117262"><li id="dds_api_0023__li1270098217262">URI format<p id="dds_api_0023__p1057222612414"><a name="dds_api_0023__li1270098217262"></a><a name="li1270098217262"></a>GET https://{Endpoint}/v3/{project_id}/instances?id={id}&amp;name={name}&amp;mode={mode}&amp;datastore_type={datastore_type}&amp;vpc_id={vpc_id}&amp;subnet_id={subnet_id}&amp;offset={offset}&amp;limit={limit}&amp;tags={key}={value},{key}={value}</p>
</li><li id="dds_api_0023__li2214663417262">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0023__table126251026172611" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0023__row1567132719261"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="dds_api_0023__p1167122711267">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="dds_api_0023__p9671727172610">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="dds_api_0023__p14434135218914">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="dds_api_0023__p2775334615440">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dds_api_0023__row16678272266"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dds_api_0023__p146718273268">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dds_api_0023__p1167202762618">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dds_api_0023__p746045218919">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dds_api_0023__p567827152614">Specifies the project ID of a tenant in a region.</p>
</td>
</tr>
<tr id="dds_api_0023__row36702720266"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dds_api_0023__p86772719262">id</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dds_api_0023__p17692270260">No</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dds_api_0023__p3470652997">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dds_api_0023__p156917276261">Specifies the instance ID, which can be obtained by calling the API for querying instances and details. If you do not have an instance, you can call the API used for creating an instance.</p>
</td>
</tr>
<tr id="dds_api_0023__row1869102722612"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dds_api_0023__p1869927112614">name</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dds_api_0023__p96952719266">No</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dds_api_0023__p83091759796">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dds_api_0023__p1269227192619">Specifies the DB instance name.</p>
<p id="dds_api_0023__p1069142722615">If you use asterisk (*) at the beginning of the name, fuzzy search results are returned. Otherwise, the exact results are returned.</p>
<div class="note" id="dds_api_0023__note28771940133312"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="dds_api_0023__p158802040153320">The asterisk (*) is a reserved character in the system and cannot be used alone.</p>
</div></div>
</td>
</tr>
<tr id="dds_api_0023__row8691527142613"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dds_api_0023__p1269162762611">mode</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dds_api_0023__p1969162711264">No</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dds_api_0023__p1131710596914">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dds_api_0023__p13346172812125">Specifies the instance type.</p>
<ul id="dds_api_0023__ul985874012144"><li id="dds_api_0023__li085854018141"><strong id="dds_api_0023__b1759118594118">Sharding</strong> indicates the cluster instance.</li><li id="dds_api_0023__li2858154091414"><strong id="dds_api_0023__b920512312214">ReplicaSet</strong> indicate the replica set instance.</li><li id="dds_api_0023__li685824091410"><strong id="dds_api_0023__b17851833521">Single</strong> indicates the single node instance.</li></ul>
</td>
</tr>
<tr id="dds_api_0023__row36972732618"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dds_api_0023__p169827152616">datastore_type</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dds_api_0023__p1069127122616">No</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dds_api_0023__p1032616597916">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dds_api_0023__p87911162456">Specifies the database type. The value is <strong id="dds_api_0023__b16426152795417">DDS-Community</strong>.</p>
</td>
</tr>
<tr id="dds_api_0023__row36942716264"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dds_api_0023__p10691627152613">vpc_id</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dds_api_0023__p16697276266">No</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dds_api_0023__p201521856105">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dds_api_0023__p1593595153419">Specifies the VPC ID. To obtain this parameter value, use either of the following methods:</p>
<ul id="dds_api_0023__ul250415512347"><li id="dds_api_0023__dds_api_0020_li67651171359">Method 1: Log in to VPC console and view the VPC ID on the VPC details page.</li><li id="dds_api_0023__dds_api_0020_li948317405377">Method 2: See the "Querying VPCs" section in the <em id="dds_api_0023__dds_api_0020_i1202182675711">Virtual Private Cloud API Reference</em>.</li></ul>
</td>
</tr>
<tr id="dds_api_0023__row186918275261"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dds_api_0023__p16992710268">subnet_id</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dds_api_0023__p269142782612">No</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dds_api_0023__p171621557103">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dds_api_0023__p512371711393">Specifies the network ID of the subnet. To obtain this parameter value, use either of the following methods:</p>
<ul id="dds_api_0023__ul9152102763919"><li id="dds_api_0023__dds_api_0020_li121534277395">Method 1: Log in to VPC console and click the target subnet on the <strong id="dds_api_0023__dds_api_0020_b8564164510571">Subnets</strong> page. You can view the network ID on the displayed page.</li><li id="dds_api_0023__dds_api_0020_li14903124220396">Method 2: See the "Querying Subnets" section in the <em id="dds_api_0023__dds_api_0020_i733265018584">Virtual Private Cloud API Reference</em>.</li></ul>
</td>
</tr>
<tr id="dds_api_0023__row6691627162611"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dds_api_0023__p196902716268">offset</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dds_api_0023__p2691227122610">No</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dds_api_0023__p161771450106">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dds_api_0023__p68771249161712">Specifies the index position. The query starts from the next instance creation time indexed by this parameter under a specified project. If offset is set to N, the resource query starts from the N+1 piece of data.</p>
<p id="dds_api_0023__p164514316252">The value must be greater than or equal to <strong id="dds_api_0023__b17830103613368">0</strong>. If this parameter is not transferred, offset is set to <strong id="dds_api_0023__b14603291356">0</strong> by default, indicating that the query starts from the latest created DB instance.</p>
</td>
</tr>
<tr id="dds_api_0023__row15691927142620"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dds_api_0023__p1269827152619">limit</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dds_api_0023__p14697274268">No</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dds_api_0023__p1189155111018">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dds_api_0023__p16281630205219">Specifies the maximum allowed number of DB instances.</p>
<p id="dds_api_0023__p15258114142818">The value ranges from 1 to 100. If this parameter is not transferred, the first 100 DB instances are queried by default.</p>
</td>
</tr>
<tr id="dds_api_0023__row108241945115411"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dds_api_0023__p758219527546">tags</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dds_api_0023__p2582115212545">No</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dds_api_0023__p11582155217545">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dds_api_0023__p87413184555">Query based on the instance tag key and value.</p>
<p id="dds_api_0023__p1565110231551">{<em id="dds_api_0023__i6928113122810">key</em>} indicates the tag key, and {<em id="dds_api_0023__i1344211716281">value</em>} indicates the tag value. A maximum of 20 key-value pairs are supported. The key cannot be empty or duplicate, but the value can be empty.</p>
<p id="dds_api_0023__p195821852165416">To query instances with multiple tag keys and values, separate key-value pairs with commas (,).</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="dds_api_0023__section807511017262"><h4 class="sectiontitle">Requests</h4><ul id="dds_api_0023__ul168611546145716"><li id="dds_api_0023__li3861446145717">Example request<ul id="dds_api_0023__ul8496320185917"><li id="dds_api_0023__li7496132065912">Querying all instances and details<p id="dds_api_0023__p1070311397011"><a name="dds_api_0023__li7496132065912"></a><a name="li7496132065912"></a>GET https://dds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances</p>
</li><li id="dds_api_0023__li10132636105916">Querying instances and details based on search criteria<p id="dds_api_0023__p108447371511"><a name="dds_api_0023__li10132636105916"></a><a name="li10132636105916"></a>GET https://dds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances?offset=0&amp;limit=10&amp;id=ed7cc6166ec24360a5ed5c5c9c2ed726in02&amp;name=hy&amp;mode=ReplicaSet&amp;datastore_type=DDS-Community&amp;vpc_id=19e5d45d-70fd-4a91-87e9-b27e71c9891f&amp;subnet_id=bd51fb45-2dcb-4296-8783-8623bfe89bb7&amp;tags=key1=value1,key2=value2</p>
</li></ul>
</li></ul>
</div>
<div class="section" id="dds_api_0023__section4828447917262"><h4 class="sectiontitle">Responses</h4><ul id="dds_api_0023__ul1872869017262"><li id="dds_api_0023__li3434049017262">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0023__table54571314103317" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0023__row3459121463318"><th align="left" class="cellrowborder" valign="top" width="23%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="dds_api_0023__p91816414334">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="27%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="dds_api_0023__p123216414335">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="dds_api_0023__p114801652119">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dds_api_0023__row16459161403314"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dds_api_0023__p12459414153315">instances</p>
</td>
<td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dds_api_0023__p1573120282446">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dds_api_0023__p9409561007">Indicates the DB instance information.</p>
<p id="dds_api_0023__p10459614163315">For more information, see <a href="#dds_api_0023__table4062895917262">Table 3</a>.</p>
</td>
</tr>
<tr id="dds_api_0023__row1729824910274"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dds_api_0023__p1553519588278">total_count</p>
</td>
<td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dds_api_0023__p153595819277">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dds_api_0023__p14535165814272">Indicates the total number of queried records.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dds_api_0023__table4062895917262"></a><a name="table4062895917262"></a><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0023__table4062895917262" frame="border" border="1" rules="all"><caption><b>Table 3 </b>instances field data structure description</caption><thead align="left"><tr id="dds_api_0023__row2045312717262"><th align="left" class="cellrowborder" valign="top" width="22%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="dds_api_0023__p4609059717262">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="27%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="dds_api_0023__p4235091617262">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="51%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="dds_api_0023__p1597516542118">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dds_api_0023__row3366877217262"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_0023__p4281598817262">id</p>
</td>
<td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_api_0023__p4554301317262">String</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_api_0023__p6510543817262">Indicates the DB instance ID.</p>
</td>
</tr>
<tr id="dds_api_0023__row1586864310283"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_0023__p1658895710287">name</p>
</td>
<td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_api_0023__p1658815722818">String</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_api_0023__p1658813578282">Indicates the DB instance name.</p>
</td>
</tr>
<tr id="dds_api_0023__row939815420395"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_0023__p118118010403">remark</p>
</td>
<td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_api_0023__p148114019402">String</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_api_0023__p88110184012">Instance remarks</p>
</td>
</tr>
<tr id="dds_api_0023__row4973938517262"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_0023__p235838917262">status</p>
</td>
<td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_api_0023__p5681181717262">String</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_api_0023__p2682840893927">Indicates the DB instance status.</p>
<p id="dds_api_0023__p3835449417262">Valid value:</p>
<ul id="dds_api_0023__ul19906938143616"><li id="dds_api_0023__li139069386368"><strong id="dds_api_0023__b842352706165621">normal</strong>: indicates that the instance is running properly.</li><li id="dds_api_0023__li11906183843611"><strong id="dds_api_0023__b842352706165427">abnormal</strong>: indicates that the instance is abnormal.</li><li id="dds_api_0023__li1090663818362"><strong id="dds_api_0023__b1574116135617">creating</strong>: indicates that the instance is being created.</li><li id="dds_api_0023__li13445155135619"><strong id="dds_api_0023__b6591143216610">data_disk_full</strong>: The storage space is full.</li><li id="dds_api_0023__li29062389367"><strong id="dds_api_0023__b1045718506561">createfail</strong>: indicates that the instance failed to be created.</li><li id="dds_api_0023__li16872174915512"><strong id="dds_api_0023__b1796311319577">enlargefail</strong>: indicates that nodes failed to be added to the instance.</li></ul>
<div class="note" id="dds_api_0023__note117817106812"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="dds_api_0023__p1827991972911">Actions that are being executed on an instance, for example, rebooting, which are essentially different from the instance status. For details, see the actions field in this table.</p>
</div></div>
</td>
</tr>
<tr id="dds_api_0023__row1542344713010"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_0023__p7306854153018">port</p>
</td>
<td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_api_0023__p530665414307">String</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_api_0023__p18306155453011">Indicates the database port number. The port range is 2100 to 9500.</p>
</td>
</tr>
<tr id="dds_api_0023__row547219133119"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_0023__p12349101213314">mode</p>
</td>
<td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_api_0023__p1349191216316">String</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_api_0023__p41801225203113">Indicates the instance type, which is the same as the request parameter.</p>
</td>
</tr>
<tr id="dds_api_0023__row161256327317"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_0023__p12846184013119">region</p>
</td>
<td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_api_0023__p11846194063118">String</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_api_0023__p208461540163116">Indicates the region where the DB instance is deployed.</p>
</td>
</tr>
<tr id="dds_api_0023__row143345492318"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_0023__p1916717590310">datastore</p>
</td>
<td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_api_0023__p175443254512">Object</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_api_0023__p67431559125914">Indicates the database information.</p>
<p id="dds_api_0023__p17167195923116">For more information, see <a href="#dds_api_0023__table5636104310403">Table 4</a>.</p>
</td>
</tr>
<tr id="dds_api_0023__row373410289323"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_0023__p1585623418326">engine</p>
</td>
<td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_api_0023__p7856123410326">String</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_api_0023__p2856934113215">Indicates the storage engine. The value is <strong id="dds_api_0023__b4533143018420">wiredTiger</strong>.</p>
</td>
</tr>
<tr id="dds_api_0023__row1199640717262"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_0023__p3218490217262">created</p>
</td>
<td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_api_0023__p5684029417262">String</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_api_0023__p64320678">Indicates the DB instance creation time.</p>
</td>
</tr>
<tr id="dds_api_0023__row10346151318330"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_0023__p2305123816371">updated</p>
</td>
<td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_api_0023__p1531123818378">String</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_api_0023__p831613813378">Indicates the time when a DB instance is updated.</p>
</td>
</tr>
<tr id="dds_api_0023__row19202155803713"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_0023__p18811780381">db_user_name</p>
</td>
<td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_api_0023__p13881188103818">String</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_api_0023__p138819883816">Indicates the default username. The value is <strong id="dds_api_0023__b55161546547">rwuser</strong>.</p>
</td>
</tr>
<tr id="dds_api_0023__row521631217262"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_0023__p16168720183816">ssl</p>
</td>
<td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_api_0023__p11168162012385">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_api_0023__p1486912373620">Indicates that SSL is enabled or not.</p>
<ul id="dds_api_0023__ul1390275817429"><li id="dds_api_0023__li390215874211"><strong id="dds_api_0023__b842352706203930">1</strong>: indicate that SSL is enabled.</li><li id="dds_api_0023__li1590245834216"><strong id="dds_api_0023__b79641341135815">0</strong>: indicate that SSL is disabled.</li></ul>
</td>
</tr>
<tr id="dds_api_0023__row6076080317262"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_0023__p6101242203816">vpc_id</p>
</td>
<td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_api_0023__p17101134219381">String</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_api_0023__p21019429383">Indicates the VPC ID.</p>
</td>
</tr>
<tr id="dds_api_0023__row6085477618055"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_0023__p010104233819">subnet_id</p>
</td>
<td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_api_0023__p5101142163813">String</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_api_0023__p01011942123813">Indicates the network ID of the subnet.</p>
</td>
</tr>
<tr id="dds_api_0023__row2423602017262"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_0023__p1101242163812">security_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_api_0023__p110134218384">String</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_api_0023__p10101342103816">Indicates the security group ID.</p>
</td>
</tr>
<tr id="dds_api_0023__row3836683017262"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_0023__p169221846193912">backup_strategy</p>
</td>
<td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_api_0023__p615761254510">Object</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_api_0023__p457435535918">Indicates the backup policy.</p>
<p id="dds_api_0023__p992212464390">For more information, see <a href="#dds_api_0023__table50876711173859">Table 5</a>.</p>
</td>
</tr>
<tr id="dds_api_0023__row5158348917262"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_0023__p9180186194016">pay_mode</p>
</td>
<td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_api_0023__p31801262406">String</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_api_0023__p135518404115"></p>
<p id="dds_api_0023__p1976456472">The value is set to <strong id="dds_api_0023__b1925773417301">"0"</strong>.</p>
</td>
</tr>
<tr id="dds_api_0023__row26042558155946"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_0023__p31813615407">maintenance_window</p>
</td>
<td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_api_0023__p0181106124014">String</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_api_0023__p18181116184018">Indicates the maintenance time window.</p>
</td>
</tr>
<tr id="dds_api_0023__row58201947133019"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_0023__p17820747153013">groups</p>
</td>
<td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_api_0023__p18968617194620">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_api_0023__p952118522597">Indicates group information.</p>
<p id="dds_api_0023__p158202479305">For more information, see <a href="#dds_api_0023__table0581104824211">Table 6</a>.</p>
</td>
</tr>
<tr id="dds_api_0023__row6543147717262"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_0023__p17181186164013">disk_encryption_id</p>
</td>
<td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_api_0023__p318115674014">String</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_api_0023__p1218176164019">The disk encryption key ID. This parameter is returned only when the instance disk is encrypted.</p>
</td>
</tr>
<tr id="dds_api_0023__row4178740217262"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_0023__p1618136184020">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_api_0023__p12181161407">String</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_api_0023__p518119624011">Indicates the enterprise project ID.</p>
<p id="dds_api_0023__p197572296233">If the value is <strong id="dds_api_0023__b842352706111949">0</strong>, the resource belongs to the default enterprise project.</p>
</td>
</tr>
<tr id="dds_api_0023__row2350798811137"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_0023__p418111674018">time_zone</p>
</td>
<td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_api_0023__p1318126154014">String</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_api_0023__p1427217032614">Indicates the time zone.</p>
</td>
</tr>
<tr id="dds_api_0023__row20543634133116"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_0023__p1654373473114">actions</p>
</td>
<td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_api_0023__p1788575916475">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_api_0023__p1724104765910">Action that is being executed on an instance.</p>
<p id="dds_api_0023__p16629413187">Valid value:</p>
<ul id="dds_api_0023__ul726620041017"><li id="dds_api_0023__li158476213326"><strong id="dds_api_0023__b1781223613610">RESTARTING</strong>: The instance is being restarted.</li><li id="dds_api_0023__li274592716108">RESTORE: restoring.</li><li id="dds_api_0023__li19266170181014">RESIZE_FLAVOR: The specifications are being changed.</li><li id="dds_api_0023__li14253123692214"><strong id="dds_api_0023__b18149984712">RESTORE_TO_NEW_INSTANCE</strong>: The instance is being restored.</li><li id="dds_api_0023__li5721105692910"><strong id="dds_api_0023__b688217161278">MODIFY_VPC_PEER</strong>: Cross-subnet access is being configured.</li><li id="dds_api_0023__li133427148115">CREATE: creating</li><li id="dds_api_0023__li1454011211213">FROZEN: The account is frozen.</li><li id="dds_api_0023__li12951623161216">RESIZE_VOLUME: The storage is being scaled up.</li><li id="dds_api_0023__li2203157151216">RESTORE_CHECK: The restoration is being checked.</li><li id="dds_api_0023__li1111513416139">RESTORE_FAILED_HANGUP: The restoration failed.</li><li id="dds_api_0023__li16853131312139">CLOSE_AUDIT_LOG: Disabling audit log.</li><li id="dds_api_0023__li1094417409133">OPEN_AUDIT_LOG: Enabling audit log.</li><li id="dds_api_0023__li1953955201415">CREATE_IP_SHARD: The shard IP address is being enabled.</li><li id="dds_api_0023__li8579175161415">CREATE_IP_CONFIG: The config IP address is being enabled.</li><li id="dds_api_0023__li48717251511">GROWING: The node is being scaled up.</li><li id="dds_api_0023__li1594319315181"><strong id="dds_api_0023__b145924674">SET_CONFIGURATION</strong>: Parameters are being modified.</li><li id="dds_api_0023__li1667485914156">RESTORE_TABLE: The database is being backed up.</li><li id="dds_api_0023__li1550513146156"><strong id="dds_api_0023__b123412438718">MODIFY_SECURITYGROUP</strong>: A security group is being changed.</li><li id="dds_api_0023__li1244351316173">BIND_EIP: The EIP is being changed.</li><li id="dds_api_0023__li8886525171511">UNBIND_EIP: The EIP is being unbound.</li><li id="dds_api_0023__li898111417158">SWITCH_SSL: The SSL is being switched.</li><li id="dds_api_0023__li1585112661615">SWITCH_PRIMARY: A primary/standby switchover is being performed.</li><li id="dds_api_0023__li1367217171163"><strong id="dds_api_0023__b1360558978">CHANGE_DBUSER_PASSWORD</strong>: The password is being changed.</li><li id="dds_api_0023__li7249740121615"><strong id="dds_api_0023__b1596195484">MODIFY_PORT</strong>: The port is being changed.</li><li id="dds_api_0023__li182598545162">MODIFY_IP: The private IP address is being changed.</li><li id="dds_api_0023__li324916161713">DELETE_INSTANCE: The instance is being deleted.</li><li id="dds_api_0023__li1923520421176">REBOOT: The system is restarting.</li><li id="dds_api_0023__li18704317182">BACKUP: The backup is in progress.</li><li id="dds_api_0023__li1870149171713">MIGRATE_AZ: The AZ is being changed.</li><li id="dds_api_0023__li17597203381210"><strong id="dds_api_0023__b151081110084">RESTORING</strong>: The backup is in progress.</li><li id="dds_api_0023__li15932059181012"><strong id="dds_api_0023__b694110191185">PWD_RESETING</strong>: The password is being reset.</li><li id="dds_api_0023__li69065911136"><strong id="dds_api_0023__b105420327817">UPGRADE_DATABASE</strong>: The patch is being upgraded.</li><li id="dds_api_0023__li14117729171312"><strong id="dds_api_0023__b5267114113815">DATA_MIGRATION</strong>: Data is being migrated.</li><li id="dds_api_0023__li3482346111318"><strong id="dds_api_0023__b1866134819820">SHARD_GROWING</strong>: The shard is being scaled out.</li><li id="dds_api_0023__li12274151781418"><strong id="dds_api_0023__b1315965517812">APPLY_CONFIGURATION</strong>: A parameter group is being changed.</li><li id="dds_api_0023__li111761929131418"><strong id="dds_api_0023__b656881290">RESET_PASSWORD</strong>: The password is being reset.</li><li id="dds_api_0023__li643114717140"><strong id="dds_api_0023__b131010138914">GROWING_REVERT</strong>: Nodes are being deleted.</li><li id="dds_api_0023__li9314162141513"><strong id="dds_api_0023__b1047442316917">SHARD_GROWING_REVERT</strong>: Shards are being deleted.</li><li id="dds_api_0023__li18778104217154"><strong id="dds_api_0023__b1337195614910">LOG_PLAINTEXT_SWITCH</strong>: The slow query log configuration is being modified.</li><li id="dds_api_0023__li051725511515"><strong id="dds_api_0023__b198076451018">CREATE_DATABASE_USER</strong>: The database user is being created.</li><li id="dds_api_0023__li166431080164"><strong id="dds_api_0023__b297413112101">CREATE_DATABASE_ROLE</strong>: The database role is being created.</li><li id="dds_api_0023__li952312236165"><strong id="dds_api_0023__b6176201720107">MODIFY_NAME</strong>: The name is being changed.</li><li id="dds_api_0023__li1872103501612"><strong id="dds_api_0023__b7322291015">MODIFY_PRIVATE_DNS</strong>: The private zone is being modified.</li><li id="dds_api_0023__li545625041618"><strong id="dds_api_0023__b247103518108">MODIFY_OP_LOG_SIZE</strong>: The oplog size is being changed.</li><li id="dds_api_0023__li11409154614123"><strong id="dds_api_0023__b1767524118107">ADD_READONLY_NODES</strong>: Read replicas are being scaled up.</li></ul>
</td>
</tr>
<tr id="dds_api_0023__row1134543955711"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_0023__p115311242135719">tags</p>
</td>
<td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_api_0023__p9531104211575">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_api_0023__p060639209">Tag list</p>
<p id="dds_api_0023__p453134211571">For details, see <a href="#dds_api_0023__table155101048155817">Table 9</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dds_api_0023__table5636104310403"></a><a name="table5636104310403"></a><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0023__table5636104310403" frame="border" border="1" rules="all"><caption><b>Table 4 </b>datastore field data structure description</caption><thead align="left"><tr id="dds_api_0023__row1165216437409"><th align="left" class="cellrowborder" valign="top" width="22%" id="mcps1.3.4.2.1.3.2.4.1.1"><p id="dds_api_0023__p12657343144015">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="27%" id="mcps1.3.4.2.1.3.2.4.1.2"><p id="dds_api_0023__p16621743124010">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="51%" id="mcps1.3.4.2.1.3.2.4.1.3"><p id="dds_api_0023__p62502217220">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dds_api_0023__row1267084317404"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="dds_api_0023__p1667834315404">type</p>
</td>
<td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="dds_api_0023__p1568254314012">String</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="dds_api_0023__p2029419174111">Indicates the DB engine.</p>
</td>
</tr>
<tr id="dds_api_0023__row868810436406"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="dds_api_0023__p969244314404">version</p>
</td>
<td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="dds_api_0023__p1769664320400">String</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="dds_api_0023__p1129418914416">Indicates the database version.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dds_api_0023__table50876711173859"></a><a name="table50876711173859"></a><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0023__table50876711173859" frame="border" border="1" rules="all"><caption><b>Table 5 </b>backup_strategy field data structure description</caption><thead align="left"><tr id="dds_api_0023__row26941115173859"><th align="left" class="cellrowborder" valign="top" width="21.782178217821784%" id="mcps1.3.4.2.1.4.2.4.1.1"><p id="dds_api_0023__p44284799173859">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="26.732673267326735%" id="mcps1.3.4.2.1.4.2.4.1.2"><p id="dds_api_0023__p30298928173859">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="51.48514851485149%" id="mcps1.3.4.2.1.4.2.4.1.3"><p id="dds_api_0023__p01931951822">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dds_api_0023__row9102564173859"><td class="cellrowborder" valign="top" width="21.782178217821784%" headers="mcps1.3.4.2.1.4.2.4.1.1 "><p id="dds_api_0023__p1835143820417">start_time</p>
</td>
<td class="cellrowborder" valign="top" width="26.732673267326735%" headers="mcps1.3.4.2.1.4.2.4.1.2 "><p id="dds_api_0023__p98352388418">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.48514851485149%" headers="mcps1.3.4.2.1.4.2.4.1.3 "><p id="dds_api_0023__p883563844112">Indicates the backup time window. Automated backups will be triggered during the backup time window. The current time is the UTC time.</p>
</td>
</tr>
<tr id="dds_api_0023__row7902174173859"><td class="cellrowborder" valign="top" width="21.782178217821784%" headers="mcps1.3.4.2.1.4.2.4.1.1 "><p id="dds_api_0023__p783518382416">keep_days</p>
</td>
<td class="cellrowborder" valign="top" width="26.732673267326735%" headers="mcps1.3.4.2.1.4.2.4.1.2 "><p id="dds_api_0023__p16835163817415">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="51.48514851485149%" headers="mcps1.3.4.2.1.4.2.4.1.3 "><p id="dds_api_0023__p6835143816415">Indicates the number of days to retain the generated backup files. The value range is from 0 to 732.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dds_api_0023__table0581104824211"></a><a name="table0581104824211"></a><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0023__table0581104824211" frame="border" border="1" rules="all"><caption><b>Table 6 </b>groups field data structure description</caption><thead align="left"><tr id="dds_api_0023__row1159824894215"><th align="left" class="cellrowborder" valign="top" width="21%" id="mcps1.3.4.2.1.5.2.4.1.1"><p id="dds_api_0023__p560414811427">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="26%" id="mcps1.3.4.2.1.5.2.4.1.2"><p id="dds_api_0023__p1609114834210">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53%" id="mcps1.3.4.2.1.5.2.4.1.3"><p id="dds_api_0023__p38731481622">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dds_api_0023__row15255328225"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.5.2.4.1.1 "><p id="dds_api_0023__p85262032112214">type</p>
</td>
<td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.4.2.1.5.2.4.1.2 "><p id="dds_api_0023__p352643217225">String</p>
</td>
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.4.2.1.5.2.4.1.3 "><p id="dds_api_0023__p1081219472322">Indicates the node type.</p>
<p id="dds_api_0023__p102012214343">Valid value:</p>
<ul id="dds_api_0023__ul64965214345"><li id="dds_api_0023__li104985283416">shard</li><li id="dds_api_0023__li19497521346">config</li><li id="dds_api_0023__li94985218346">mongos</li><li id="dds_api_0023__li1249145293416">replica</li><li id="dds_api_0023__li650552113416">single</li></ul>
</td>
</tr>
<tr id="dds_api_0023__row1170116144310"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.5.2.4.1.1 "><p id="dds_api_0023__p94661721134320">volume</p>
</td>
<td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.4.2.1.5.2.4.1.2 "><p id="dds_api_0023__p65461844134916">Object</p>
</td>
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.4.2.1.5.2.4.1.3 "><p id="dds_api_0023__p66811129104611">Indicates the volume information. For more information, see <a href="#dds_api_0023__table1149918231246">Table 7</a>. This parameter is valid only when the node type is shard, config, replica, or single.</p>
</td>
</tr>
<tr id="dds_api_0023__row86761748134216"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.5.2.4.1.1 "><p id="dds_api_0023__p1446652144315">nodes</p>
</td>
<td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.4.2.1.5.2.4.1.2 "><p id="dds_api_0023__p68087345011">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.4.2.1.5.2.4.1.3 "><p id="dds_api_0023__p1246642104310">Indicates node information. For more information, see <a href="#dds_api_0023__table3426155424213">Table 8</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dds_api_0023__table1149918231246"></a><a name="table1149918231246"></a><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0023__table1149918231246" frame="border" border="1" rules="all"><caption><b>Table 7 </b>volume field data structure description</caption><thead align="left"><tr id="dds_api_0023__row25301823182412"><th align="left" class="cellrowborder" valign="top" width="21.21212121212121%" id="mcps1.3.4.2.1.6.2.4.1.1"><p id="dds_api_0023__p3537102382413">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25.252525252525253%" id="mcps1.3.4.2.1.6.2.4.1.2"><p id="dds_api_0023__p1454202332412">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.535353535353536%" id="mcps1.3.4.2.1.6.2.4.1.3"><p id="dds_api_0023__p1789113926">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dds_api_0023__row8581132319246"><td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.4.2.1.6.2.4.1.1 "><p id="dds_api_0023__p1958916239247">size</p>
</td>
<td class="cellrowborder" valign="top" width="25.252525252525253%" headers="mcps1.3.4.2.1.6.2.4.1.2 "><p id="dds_api_0023__p1594523132414">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.535353535353536%" headers="mcps1.3.4.2.1.6.2.4.1.3 "><p id="dds_api_0023__p13604122313246">Indicates the disk size. Unit: GB</p>
</td>
</tr>
<tr id="dds_api_0023__row1692220263912"><td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.4.2.1.6.2.4.1.1 "><p id="dds_api_0023__p118283923919">used</p>
</td>
<td class="cellrowborder" valign="top" width="25.252525252525253%" headers="mcps1.3.4.2.1.6.2.4.1.2 "><p id="dds_api_0023__p082820953918">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.535353535353536%" headers="mcps1.3.4.2.1.6.2.4.1.3 "><p id="dds_api_0023__p8828195392">Indicates the disk usage. Unit: GB</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dds_api_0023__table3426155424213"></a><a name="table3426155424213"></a><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0023__table3426155424213" frame="border" border="1" rules="all"><caption><b>Table 8 </b>nodes field data structure description</caption><thead align="left"><tr id="dds_api_0023__row104391354174216"><th align="left" class="cellrowborder" valign="top" width="22%" id="mcps1.3.4.2.1.7.2.4.1.1"><p id="dds_api_0023__p94421654184220">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.2.1.7.2.4.1.2"><p id="dds_api_0023__p94461854124211">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53%" id="mcps1.3.4.2.1.7.2.4.1.3"><p id="dds_api_0023__p376812197219">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dds_api_0023__row739024810443"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.7.2.4.1.1 "><p id="dds_api_0023__p439094844410">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.7.2.4.1.2 "><p id="dds_api_0023__p1139074834418">String</p>
</td>
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.4.2.1.7.2.4.1.3 "><p id="dds_api_0023__p10390204854416">Indicates the node ID.</p>
</td>
</tr>
<tr id="dds_api_0023__row1545510547425"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.7.2.4.1.1 "><p id="dds_api_0023__p388312397433">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.7.2.4.1.2 "><p id="dds_api_0023__p17883139124313">String</p>
</td>
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.4.2.1.7.2.4.1.3 "><p id="dds_api_0023__p14883839134318">Indicates the node name.</p>
</td>
</tr>
<tr id="dds_api_0023__row4180183094418"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.7.2.4.1.1 "><p id="dds_api_0023__p18583183954410">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.7.2.4.1.2 "><p id="dds_api_0023__p1159113954419">String</p>
</td>
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.4.2.1.7.2.4.1.3 "><p id="dds_api_0023__p19588833363">Indicates the node status.</p>
<p id="dds_api_0023__p152001396193">Valid value:</p>
<ul id="dds_api_0023__ul17874983224"><li id="dds_api_0023__li687415811221"><strong id="dds_api_0023__b36781024192117">normal</strong>: The instance is running properly.</li><li id="dds_api_0023__li148741810227"><strong id="dds_api_0023__b203431127172113">abnormal</strong>: The instance is abnormal.</li><li id="dds_api_0023__li587414812225"><strong id="dds_api_0023__b1611716306212">backup</strong>: The instance is being backed up.</li><li id="dds_api_0023__li14875981222"><strong id="dds_api_0023__b2702132192117">frozen</strong>: The instance has been frozen.</li><li id="dds_api_0023__li58751872216"><strong id="dds_api_0023__b159089347215">unfrozen</strong>: The instance is being unfrozen.</li><li id="dds_api_0023__li1187518862212"><strong id="dds_api_0023__b1492315375215">restore_table</strong>: Database- and table-level backup and restoration are being performed for the DB instance.</li><li id="dds_api_0023__li1187516802215"><strong id="dds_api_0023__b16558124013217">reboot</strong>: The instance is being restarted.</li><li id="dds_api_0023__li178751686226"><strong id="dds_api_0023__b1213354411217">upgrade_database</strong>: The instance version is being upgraded.</li><li id="dds_api_0023__li287516872217"><strong id="dds_api_0023__b141821847102119">resize_flavor</strong>: The instance class is being changed.</li><li id="dds_api_0023__li168759842216"><strong id="dds_api_0023__b139551449182111">resize_volume</strong>: The instance storage is being scaled up.</li><li id="dds_api_0023__li887514812219"><strong id="dds_api_0023__b1011685352117">restore</strong>: The instance is being restored.</li><li id="dds_api_0023__li887511819222"><strong id="dds_api_0023__b14821145582113">bind_eip</strong>: An EIP is being bound to the instance.</li></ul>
</td>
</tr>
<tr id="dds_api_0023__row247211545421"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.7.2.4.1.1 "><p id="dds_api_0023__p148831139144319">role</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.7.2.4.1.2 "><p id="dds_api_0023__p19883133914314">String</p>
</td>
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.4.2.1.7.2.4.1.3 "><p id="dds_api_0023__p1188323934310">Indicates the node role.</p>
<div class="p" id="dds_api_0023__p627518910410">Valid value:<ul id="dds_api_0023__ul22751399418"><li id="dds_api_0023__li172753916415"><strong id="dds_api_0023__b1767497386">master</strong>: This value is returned for the mongos node.</li><li id="dds_api_0023__li10275159748"><strong id="dds_api_0023__b1084412522552">Primary</strong>: This value is returned for the primary shard and config nodes, the primary node of a replica set, and a single node.</li><li id="dds_api_0023__li172751394410"><strong id="dds_api_0023__b1264182415568">Secondary</strong>: This value is returned for the secondary shard and config nodes, and the secondary node of a replica set.</li><li id="dds_api_0023__li122751891840"><strong id="dds_api_0023__b510015284567">Hidden</strong>: This value is returned for the hidden shard and config nodes, and the hidden node of a replica set.</li><li id="dds_api_0023__li92753914418"><strong id="dds_api_0023__b626145515">unknown</strong>. This value is returned when the node is abnormal.</li></ul>
</div>
</td>
</tr>
<tr id="dds_api_0023__row1250385474215"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.7.2.4.1.1 "><p id="dds_api_0023__p18834391436">private_ip</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.7.2.4.1.2 "><p id="dds_api_0023__p788343916437">String</p>
</td>
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.4.2.1.7.2.4.1.3 "><p id="dds_api_0023__p20883113984310">Indicates the private IP address of a node. By default, this parameter is valid only for mongos nodes, replica set instances, and single node instances. The value exists only after ECSs are created successfully. Otherwise, the value is <strong id="dds_api_0023__b3308449163517">""</strong>.</p>
<div class="caution" id="dds_api_0023__note9297183721214"><span class="cautiontitle"> CAUTION: </span><div class="cautionbody"><p id="dds_api_0023__p10965823163">After the shard or config IP address is enabled, private IP addresses are assigned to the primary and secondary shard or config nodes of the cluster instance.</p>
</div></div>
</td>
</tr>
<tr id="dds_api_0023__row529663511457"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.7.2.4.1.1 "><p id="dds_api_0023__p1129643517459">public_ip</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.7.2.4.1.2 "><p id="dds_api_0023__p229603514454">String</p>
</td>
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.4.2.1.7.2.4.1.3 "><p id="dds_api_0023__p8296143594510">Indicates the EIP that has been bound. This parameter is valid only for mongos nodes of cluster instances, primary nodes and secondary nodes of replica set instances, and single node instances.</p>
</td>
</tr>
<tr id="dds_api_0023__row155181554114214"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.7.2.4.1.1 "><p id="dds_api_0023__p398277124510">spec_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.7.2.4.1.2 "><p id="dds_api_0023__p148837395436">String</p>
</td>
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.4.2.1.7.2.4.1.3 "><p id="dds_api_0023__p12589718155110">Indicates the resource specification code. For details about the instance specifications, see the value of the <strong id="dds_api_0023__b385636151116">flavors.spec_code</strong> parameter in <a href="dds_instance_specification.html">Querying Database Specifications</a>.</p>
</td>
</tr>
<tr id="dds_api_0023__row20724925103610"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.7.2.4.1.1 "><p id="dds_api_0023__p572532514362">availability_zone</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.7.2.4.1.2 "><p id="dds_api_0023__p19725112563616">String</p>
</td>
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.4.2.1.7.2.4.1.3 "><p id="dds_api_0023__p1472532514361">Indicates the AZ.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dds_api_0023__table155101048155817"></a><a name="table155101048155817"></a><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0023__table155101048155817" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Description of the tag field</caption><thead align="left"><tr id="dds_api_0023__row3510648165815"><th align="left" class="cellrowborder" valign="top" width="23.369999999999997%" id="mcps1.3.4.2.1.8.2.4.1.1"><p id="dds_api_0023__p351017486580">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.84%" id="mcps1.3.4.2.1.8.2.4.1.2"><p id="dds_api_0023__p9510348165819">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.790000000000006%" id="mcps1.3.4.2.1.8.2.4.1.3"><p id="dds_api_0023__p8510184817582">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dds_api_0023__row1451054825820"><td class="cellrowborder" valign="top" width="23.369999999999997%" headers="mcps1.3.4.2.1.8.2.4.1.1 "><p id="dds_api_0023__p13278213302">key</p>
</td>
<td class="cellrowborder" valign="top" width="22.84%" headers="mcps1.3.4.2.1.8.2.4.1.2 "><p id="dds_api_0023__p8278141319014">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.790000000000006%" headers="mcps1.3.4.2.1.8.2.4.1.3 "><p id="dds_api_0023__p427816131607">Tag key</p>
</td>
</tr>
<tr id="dds_api_0023__row051174845819"><td class="cellrowborder" valign="top" width="23.369999999999997%" headers="mcps1.3.4.2.1.8.2.4.1.1 "><p id="dds_api_0023__p17278161318013">value</p>
</td>
<td class="cellrowborder" valign="top" width="22.84%" headers="mcps1.3.4.2.1.8.2.4.1.2 "><p id="dds_api_0023__p162788131803">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.790000000000006%" headers="mcps1.3.4.2.1.8.2.4.1.3 "><p id="dds_api_0023__p327821318018">Tag value</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="note" id="dds_api_0023__note3482053511312"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="dds_api_0023__p4494936511312">The values of <strong id="dds_api_0023__b0502111216114">region</strong> and <strong id="dds_api_0023__b169621637173816">availability_zone</strong> are used as examples.</p>
</div></div>
</li></ul>
</div>
<ul id="dds_api_0023__ul2705380172618"><li id="dds_api_0023__li24348422172618">Response example<div class="p" id="dds_api_0023__p20293121613511"><a name="dds_api_0023__li24348422172618"></a><a name="li24348422172618"></a>Query all instances and details.<pre class="codeblock" id="dds_api_0023__codeblock1436514373445">{
"instances": [
{
"id": "8436a91546294036b75931e879882200in02",
"name": "dds-efa6",
"status": "normal",
"port": "8635",
"mode": "ReplicaSet",
"region": "aaa",
"datastore": {
"type": "DDS-Community",
"version": "4.0"
},
"engine": "wiredTiger",
"created": "2019-01-17T07:05:52",
"updated": "2019-01-17T07:05:47",
"db_user_name": "rwuser",
"ssl": 1,
"vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
"subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
"security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
"backup_strategy": {
"start_time": "16:00-17:00",
"keep_days": 7
},
"pay_mode": "0",
"maintenance_window": "02:00-06:00",
"groups": [
{
"type": "replica",
"volume": {
"size": "10",
"used": "0.33"
},
"nodes": [
{
"id": "233eaac9c6f245c0bb9c2d21eea12d1bno02",
"name": "dds-efa6_replica_node_2",
"status": "normal",
"role": "Primary",
"private_ip": "192.168.0.174",
"public_ip": "",
"spec_code": "dds.mongodb.s2.medium.4.repset",
"availability_zone": "bbb"
},
{
"id": "d57d76d6320a4a7b86db82c317550c4ano02",
"name": "dds-efa6_replica_node_1",
"status": "normal",
"role": "Hidden",
"private_ip": "192.168.0.39",
"public_ip": "",
"spec_code": "dds.mongodb.s2.medium.4.repset",
"availability_zone": "bbb"
},
{
"id": "f46b0a1cf4d9400e9fd7af17f8742d37no02",
"name": "dds-efa6_replica_node_3",
"status": "normal",
"role": "Secondary",
"private_ip": "192.168.0.176",
"public_ip": "",
"spec_code": "dds.mongodb.s2.medium.4.repset",
"availability_zone": "bbb"
}
]
}
],
"time_zone": "",
"actions": [
"CREATE"
]
},
{
"id": "d77905385f114217b75ae7d6ab9a7588in02",
"name": "dds-5699",
"status": "normal",
"port": "8635",
"mode": "Single",
"region": "aaa",
"datastore": {
"type": "DDS-Community",
"version": "4.0"
},
"engine": "wiredTiger",
"created": "2019-01-17T07:04:39",
"updated": "2019-01-17T07:04:33",
"db_user_name": "rwuser",
"ssl": 1,
"vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
"subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
"security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
"backup_strategy": {
"start_time": "17:00-18:00",
"keep_days": 7
},
"pay_mode": "0",
"maintenance_window": "02:00-06:00",
"groups": [
{
"type": "single",
"volume": {
"size": "10",
"used": "0.33"
},
"nodes": [
{
"id": "bd4dccbd53ae48d5bd3046bebf715079no02",
"name": "dds-5699_single_node_1",
"status": "normal",
"role": "Primary",
"private_ip": "192.168.0.9",
"public_ip": "",
"spec_code": "dds.mongodb.s2.medium.4.single",
"availability_zone": "bbb"
}
]
}
],
"time_zone": "",
"actions": [
"CREATE"
]
},
{
"id": "9136fd2a9fcd405ea4674276ce36dae8in02",
"name": "dds-32f4",
"status": "normal",
"port": "8635",
"mode": "Sharding",
"region": "aaa",
"datastore": {
"type": "DDS-Community",
"version": "4.0"
},
"engine": "wiredTiger",
"created": "2019-01-17T07:04:37",
"updated": "2019-01-17T07:04:31",
"db_user_name": "rwuser",
"ssl": 1,
"vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
"subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
"security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
"backup_strategy": {
"start_time": "19:00-20:00",
"keep_days": 7
},
"pay_mode": "0",
"maintenance_window": "02:00-06:00",
"groups": [
{
"type": "mongos",
"nodes": [
{
"id": "a742c13a284949adad177672e8a0f01cno02",
"name": "dds-32f4_mongos_node_1",
"status": "normal",
"role": "master",
"private_ip": "192.168.0.56",
"public_ip": "",
"spec_code": "dds.mongodb.s2.medium.4.mongos",
"availability_zone": "bbb"
},
{
"id": "d4f66666b1d64ab28719da0526341c7eno02",
"name": "dds-32f4_mongos_node_2",
"status": "normal",
"role": "master",
"private_ip": "192.168.0.185",
"public_ip": "",
"spec_code": "dds.mongodb.s2.medium.4.mongos",
"availability_zone": "bbb"
}
]
},
{
"type": "shard",
"id": "d1b92d2cbd544e85ac7ce6a7f33ba205gr02",
"name": "shard_2",
"status": "normal",
"volume": {
"size": "10",
"used": "0.33"
},
"nodes": [
{
"id": "0e9abaebe5974b63a5b221de6ee34cfeno02",
"name": "dds-32f4_shard_2_node_3",
"status": "normal",
"role": "Primary",
"spec_code": "dds.mongodb.s2.medium.4.shard",
"availability_zone": "bbb"
},
{
"id": "1d7f4c5476c04cc187f920925c2b601fno02",
"name": "dds-32f4_shard_2_node_2",
"status": "normal",
"role": "Hidden",
"spec_code": "dds.mongodb.s2.medium.4.shard",
"availability_zone": "bbb"
},
{
"id": "3dd2cce03da54fc08f10651cbfea778dno02",
"name": "dds-32f4_shard_2_node_1",
"status": "normal",
"role": "Secondary",
"spec_code": "dds.mongodb.s2.medium.4.shard",
"availability_zone": "bbb"
}
]
},
{
"type": "shard",
"id": "06439baa35c146d3a8965af59d370908gr02",
"name": "shard_1",
"status": "normal",
"volume": {
"size": "10",
"used": "0.33"
},
"nodes": [
{
"id": "0f6744d7e29f42ff80fc1a36cc145042no02",
"name": "dds-32f4_shard_1_node_1",
"status": "normal",
"role": "Primary",
"spec_code": "dds.mongodb.s2.medium.4.shard",
"availability_zone": "bbb"
},
{
"id": "3abcb399113b4512bd5a906da54e8753no02",
"name": "dds-32f4_shard_1_node_3",
"status": "normal",
"role": "Hidden",
"spec_code": "dds.mongodb.s2.medium.4.shard",
"availability_zone": "bbb"
},
{
"id": "c149f70563494501b5706cad225a8ebdno02",
"name": "dds-32f4_shard_1_node_2",
"status": "normal",
"role": "Secondary",
"spec_code": "dds.mongodb.s2.medium.4.shard",
"availability_zone": "bbb"
}
]
},
{
"type": "config",
"id": "84e7c96b82aa4fedb3b00f98edd71ba4gr02",
"name": "config",
"status": "normal",
"volume": {
"size": "20",
"used": "0.33"
},
"nodes": [
{
"id": "7422f7331b714ac39aa647a1ec968d33no02",
"name": "dds-32f4_config_node_2",
"status": "normal",
"role": "Primary",
"spec_code": "dds.mongodb.s2.large.2.config",
"availability_zone": "bbb"
},
{
"id": "9e3b343151044eda91ddb8a42ae5cbefno02",
"name": "dds-32f4_config_node_3",
"status": "normal",
"role": "Hidden",
"spec_code": "dds.mongodb.s2.large.2.config",
"availability_zone": "bbb"
},
{
"id": "c0053ca460ac4889841ffb14a886ec54no02",
"name": "dds-32f4_config_node_1",
"status": "normal",
"role": "Secondary",
"spec_code": "dds.mongodb.s2.large.2.config",
"availability_zone": "bbb"
}
]
}
],
"time_zone": "",
"actions": [
"CREATE"
]
}
],
"total_count": 2
}</pre>
</div>
</li></ul>
<div class="section" id="dds_api_0023__section5382712154838"><h4 class="sectiontitle">Status Code</h4><p id="dds_api_0023__dds_api_0018_p16131712193312">Status Code:200.</p>
<p id="dds_api_0023__dds_api_0018_p480617135329">For more information, see <a href="dds_status_code.html">Status Code</a>.</p>
</div>
<div class="section" id="dds_api_0023__section6522193710339"><h4 class="sectiontitle">Error Code</h4><p id="dds_api_0023__dds_api_0018_p20466124120334">For more information, see <a href="dds_error_code.html">Error Code</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dds_instance_mgmt.html">DB Instance Management</a></div>
</div>
</div>
View Git Blame Copy Permalink