vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/opengauss/api-ref/opengauss_api_0018.html
Wang , Deng Ke a96a12ecf1 openGauss API 20221109 version 
Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: Wang , Deng Ke <wangdengke2@huawei.com>
Co-committed-by: Wang , Deng Ke <wangdengke2@huawei.com>
2022-11-14 16:40:26 +00:00

1310 lines
83 KiB
HTML
Raw Blame History

<a name="opengauss_api_0018"></a><a name="opengauss_api_0018"></a>
<h1 class="topictitle1">Querying Details About DB Instances</h1>
<div id="body8662426"><div class="section" id="opengauss_api_0018__sadca2a9e8ed6463683bede0b5f8ab790"><h4 class="sectiontitle">Function</h4><p id="opengauss_api_0018__a39d0693a793c46a589b3deb6a64a2567">This API is used to query DB instances according to search criteria.</p>
<ul id="opengauss_api_0018__u8171a2efb00044b785b89e3ad83a7025"><li id="opengauss_api_0018__en-us_topic_0256709922_li41227910453">Before calling an API, you need to understand the API in <a href="opengauss_api_0012.html">Using APIs</a>.</li><li id="opengauss_api_0018__lb5b27d5b1c7e4fb6aa975d2581fcbcf8">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="opengauss_api_0018__sbf071c44e46b404e9d7fb41d81958d79"><h4 class="sectiontitle">URI</h4><ul id="opengauss_api_0018__u9db7bb33859a42c2be9e424d364eaae9"><li id="opengauss_api_0018__l2f95e0fed4b14bafb77eac21d11b1160">URI format<p id="opengauss_api_0018__a09d9d614478246b6954229c58d2ae471"><a name="opengauss_api_0018__l2f95e0fed4b14bafb77eac21d11b1160"></a><a name="l2f95e0fed4b14bafb77eac21d11b1160"></a>GET https://{<em id="opengauss_api_0018__a1e43346df0ec495a8184551b098f4628">Endpoint</em>}/opengauss/v3/{project_id}/instances?id={id}&amp;name={name}&amp;type={type}&amp;datastore_type={datastore_type}&amp;vpc_id={vpc_id}&amp;subnet_id={subnet_id}&amp;offset={offset}&amp;limit={limit}</p>
</li><li id="opengauss_api_0018__l40923531594b4b0fabfd54367ea9b007">Example<ul id="opengauss_api_0018__u5d7fffd4cb694486bcc799545c86cc89"><li id="opengauss_api_0018__lb0710710d3d949dfbb166c5f4cc1e060">Querying all DB instances<p id="opengauss_api_0018__ac08926e383e3472b8202d1c08f70028d"><a name="opengauss_api_0018__lb0710710d3d949dfbb166c5f4cc1e060"></a><a name="lb0710710d3d949dfbb166c5f4cc1e060"></a>https://gaussdb.eu-de.otc.t-systems.com/opengauss/v3/97b026aa9cc4417888c14c84a1ad9860/instances</p>
</li><li id="opengauss_api_0018__l70b32c6b26474a0692d9277b7e60bf96">Querying DB instances based on search criteria<p id="opengauss_api_0018__p1264794521818"><a name="opengauss_api_0018__l70b32c6b26474a0692d9277b7e60bf96"></a><a name="l70b32c6b26474a0692d9277b7e60bf96"></a>https://gaussdb.eu-de.otc.t-systems.com/v3/97b026aa9cc4417888c14c84a1ad9860/instances?id=ed7cc6166ec24360a5ed5c5c9c2ed726in01&amp;name=hy&amp;type=Enterprise&amp;datastore_type=GaussDB(openGauss)&amp;vpc_id=19e5d45d-70fd-4a91-87e9-b27e71c9891f&amp;subnet_id=bd51fb45-2dcb-4296-8783-8623bfe89bb7&amp;offset=0&amp;limit=10</p>
</li></ul>
</li><li id="opengauss_api_0018__l75791224343542c198c17166e0c6ff42">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="opengauss_api_0018__t47cf9617165941ddaf3b7ceaaa380226" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="opengauss_api_0018__ra5933dedf3694cfda74a510deaceb271"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.2.2.3.1.2.5.1.1"><p id="opengauss_api_0018__ad7f1350f5a724043ab354f7efc1e5173"><strong id="opengauss_api_0018__ace2277e828ab4021aa587456e8bb8e48">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13%" id="mcps1.3.2.2.3.1.2.5.1.2"><p id="opengauss_api_0018__en-us_topic_0128427215_p156174610411"><strong id="opengauss_api_0018__a24b8de9f521843fba5c5c307fea46894">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11%" id="mcps1.3.2.2.3.1.2.5.1.3"><p id="opengauss_api_0018__a305cd33db3d64e299b31f284ccf7dc73"><strong id="opengauss_api_0018__aa72f78cbb99d4617a9bcce375c168674">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="59%" id="mcps1.3.2.2.3.1.2.5.1.4"><p id="opengauss_api_0018__a1a21124096224308bc4192282c9ac3d5"><strong id="opengauss_api_0018__a9fd8111bb7864d1599e5edc1b412334e">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="opengauss_api_0018__r5590b803b00d422abd02c2ca6c605595"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.3.1.2.5.1.1 "><p id="opengauss_api_0018__a7eed22a34dd94a1ebcb4d0ac678133b9">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.2.3.1.2.5.1.2 "><p id="opengauss_api_0018__a415ddf1919b34654b1cc1918c814ea0c">String</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.2.2.3.1.2.5.1.3 "><p id="opengauss_api_0018__a80eac6644d0849268d3e61fd240fa87e">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.2.2.3.1.2.5.1.4 "><p id="opengauss_api_0018__aafea6166c84d408ea61735bf8f10cdb1">Specifies the project ID of a tenant in a region.</p>
<p id="opengauss_api_0018__p8544202712219">For details about how to obtain the project ID, see <a href="opengauss_api_0034.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
<tr id="opengauss_api_0018__re626579a7db54dddb659728f747776aa"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.3.1.2.5.1.1 "><p id="opengauss_api_0018__en-us_topic_0128427215_p84691445594">id</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.2.3.1.2.5.1.2 "><p id="opengauss_api_0018__a8da98157923f4e3e8666f9c07c15c74f">String</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.2.2.3.1.2.5.1.3 "><p id="opengauss_api_0018__en-us_topic_0128427215_p346994410599">No</p>
</td>
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.2.2.3.1.2.5.1.4 "><p id="opengauss_api_0018__a3caeecca64cb4df3b043b5c84ea76896">Specifies the DB instance ID.</p>
<p id="opengauss_api_0018__a22a1ba00b530413e951a0f3b758c64e4">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="opengauss_api_0018__r1b566f741b95474d9e6d27c468995496"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.3.1.2.5.1.1 "><p id="opengauss_api_0018__a8dbd7c3415bf4aa6b928a98c8afb78c0">name</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.2.3.1.2.5.1.2 "><p id="opengauss_api_0018__en-us_topic_0128427215_p857164618412">String</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.2.2.3.1.2.5.1.3 "><p id="opengauss_api_0018__a101ac25bbeb940fda353fb42e75dcc2d">No</p>
</td>
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.2.2.3.1.2.5.1.4 "><p id="opengauss_api_0018__en-us_topic_0128427215_p946944412596">Specifies the DB instance name.</p>
<p id="opengauss_api_0018__a26877642dcd74a11b20dc6072096bb53">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="opengauss_api_0018__r887db28db66f4eabbe73704706824134"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.3.1.2.5.1.1 "><p id="opengauss_api_0018__a086df1711b704b238aeabe875204690b">type</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.2.3.1.2.5.1.2 "><p id="opengauss_api_0018__en-us_topic_0128427215_p15734616412">String</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.2.2.3.1.2.5.1.3 "><p id="opengauss_api_0018__en-us_topic_0128427215_p12738925418">No</p>
</td>
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.2.2.3.1.2.5.1.4 "><p id="opengauss_api_0018__en-us_topic_0128427215_p573892515118">Specifies the instance type-based query. Currently, the value is only <strong id="opengauss_api_0018__b164565018278">Enterprise</strong> (case-sensitive), indicating the distributed instance (Enterprise Edition).</p>
</td>
</tr>
<tr id="opengauss_api_0018__en-us_topic_0128427215_row4676255803"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.3.1.2.5.1.1 "><p id="opengauss_api_0018__en-us_topic_0128427215_p373852511110">datastore_type</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.2.3.1.2.5.1.2 "><p id="opengauss_api_0018__en-us_topic_0128427215_p75754610414">String</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.2.2.3.1.2.5.1.3 "><p id="opengauss_api_0018__en-us_topic_0128427215_p373812511115">No</p>
</td>
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.2.2.3.1.2.5.1.4 "><p id="opengauss_api_0018__a5375de2d0dac42519ce475f6b33cf758">Specifies the database type. Its value is case-sensitive.</p>
<ul id="opengauss_api_0018__ua1f0acb899624d45bb7dbf98a29b3e2d"><li id="opengauss_api_0018__l0f970d011eb74587b08f4a8ffec69390"><span id="opengauss_api_0018__text1489015019283">GaussDB(openGauss)</span></li></ul>
</td>
</tr>
<tr id="opengauss_api_0018__ra32bf9999e3c45e48621f2d447c9cf2d"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.3.1.2.5.1.1 "><p id="opengauss_api_0018__en-us_topic_0128427215_p873811251313">vpc_id</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.2.3.1.2.5.1.2 "><p id="opengauss_api_0018__en-us_topic_0128427215_p75794618416">String</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.2.2.3.1.2.5.1.3 "><p id="opengauss_api_0018__en-us_topic_0128427215_p147381257113">No</p>
</td>
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.2.2.3.1.2.5.1.4 "><p id="opengauss_api_0018__en-us_topic_0128427215_p87381125112">Specifies the VPC ID.</p>
<ul id="opengauss_api_0018__uf458bea827ba4ad7954be8eb0f66a2dc"><li id="opengauss_api_0018__en-us_topic_0128427213_li67651171359">Method 1: Log in to VPC console and view the VPC ID in the VPC details.</li><li id="opengauss_api_0018__l417f0d1dbb4a45fb84fd3b0bfbd29bb9">Method 2: See the "Querying VPCs" section in the <em id="opengauss_api_0018__a350b6b3e50834ca59a976d04dd9bdfa3">Virtual Private Cloud API Reference</em>.</li></ul>
</td>
</tr>
<tr id="opengauss_api_0018__r2c0d2ab429de40a88c5c43f4dbf1ad7d"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.3.1.2.5.1.1 "><p id="opengauss_api_0018__en-us_topic_0128427215_p173811251019">subnet_id</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.2.3.1.2.5.1.2 "><p id="opengauss_api_0018__adfd8c80213b945d3bd96d487a37181d6">String</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.2.2.3.1.2.5.1.3 "><p id="opengauss_api_0018__en-us_topic_0128427215_p073882514117">No</p>
</td>
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.2.2.3.1.2.5.1.4 "><p id="opengauss_api_0018__a602a39b527ff43ffa5b6deb10ed5daec">Specifies the network ID of the subnet.</p>
<ul id="opengauss_api_0018__u973cda82672448d291ac79f0a8141378"><li id="opengauss_api_0018__lb4ab350e67a044f6ad2bc62fa56bec35">Method 1: Log in to VPC console and click the target subnet on the <strong id="opengauss_api_0018__af15c6c16b00a4870aeede6c80dd4c87a">Subnets</strong> page. You can view the network ID on the displayed page.</li><li id="opengauss_api_0018__lf4850353145c4ac59055529258440d28">Method 2: See the "Querying Subnets" section in the <em id="opengauss_api_0018__en-us_topic_0128427213_i102188587418">Virtual Private Cloud API Reference</em>.</li><li id="opengauss_api_0018__lae5e3d1a19b7459db11d71d2b4c501fe">Method 2: See the "Querying Subnets" section under "APIs" or the "Querying Networks" section under "OpenStack Neutron APIs" in the <em id="opengauss_api_0018__en-us_topic_0128427213_i770154090">Virtual Private Cloud API Reference</em>.</li></ul>
</td>
</tr>
<tr id="opengauss_api_0018__rc9a9d23984c54f58b23f3010abd82f76"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.3.1.2.5.1.1 "><p id="opengauss_api_0018__a3c79dc265c614f38ac49df61d80ca6ac">offset</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.2.3.1.2.5.1.2 "><p id="opengauss_api_0018__a2d38adf127ba4b56b24bce33c8dfecfe">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.2.2.3.1.2.5.1.3 "><p id="opengauss_api_0018__acd53a1a19a664f24a62b88cdd3cdbbfc">No</p>
</td>
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.2.2.3.1.2.5.1.4 "><p id="opengauss_api_0018__a80356467ef814fa3ad586012a1633769">Specifies the index position. If <strong id="opengauss_api_0018__af0edb904a0ab44a3ba5dfb377cf78797">offset</strong> is set to <em id="opengauss_api_0018__a074afe63236d42e7a7096d6f218ef641">N</em>, the resource query starts from the N+1 piece of data. The value is <strong id="opengauss_api_0018__a7c74c04ddf8042599172046f76d5beee">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="opengauss_api_0018__rb51c374166c744bebe3ecb5e49581a70"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.3.1.2.5.1.1 "><p id="opengauss_api_0018__en-us_topic_0128427215_p646954415917">limit</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.2.3.1.2.5.1.2 "><p id="opengauss_api_0018__en-us_topic_0128427215_p125714615419">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.2.2.3.1.2.5.1.3 "><p id="opengauss_api_0018__a91573b233229464d854e75fbde405772">No</p>
</td>
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.2.2.3.1.2.5.1.4 "><p id="opengauss_api_0018__a72b99aa054af4bd5a2c4c849a4c611d6">Specifies the number of records to be queried. The default value is <strong id="opengauss_api_0018__en-us_topic_0128427215_b78578273159">100</strong>. The value cannot be a negative number. The minimum value is <strong id="opengauss_api_0018__a7ed2b5fc40fc49f797304cb170c0030c">1</strong> and the maximum value is <strong id="opengauss_api_0018__ae528f52fd4004109b01072ee0cb11699">100</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="opengauss_api_0018__s3a07833db5724ea9980e627362cc7d62"><h4 class="sectiontitle">Request</h4><p id="opengauss_api_0018__aaa3b20a8747b47d4bef00c7e06c1a932">None</p>
</div>
<div class="section" id="opengauss_api_0018__s6e4ac44abe3346eea8d26fcbd4013f17"><h4 class="sectiontitle">Response</h4><ul id="opengauss_api_0018__u10310c433d6146fd8f2e089494098cfe"><li id="opengauss_api_0018__l5af7331634ec45738cafc69ef3367ca1">Normal response
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="opengauss_api_0018__teda7931fa9ec449e91d2c641e431b941" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="opengauss_api_0018__rd58d9f1632de463380c5012641f7db06"><th align="left" class="cellrowborder" valign="top" width="32.653265326532654%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="opengauss_api_0018__a0bc7a4e834444004badbe199b7b85e80"><strong id="opengauss_api_0018__acdb0d78c01c144e881508da9c5f7c9d1">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="opengauss_api_0018__en-us_topic_0128427215_p174959399251"><strong id="opengauss_api_0018__en-us_topic_0128427215_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="opengauss_api_0018__aecb8fcbd266448438eb1142b262be27b"><strong id="opengauss_api_0018__en-us_topic_0128427215_b16524190243">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="opengauss_api_0018__r56b79963ad9143e5b034b89fdec8c2d4"><td class="cellrowborder" valign="top" width="32.653265326532654%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="opengauss_api_0018__en-us_topic_0128427215_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="opengauss_api_0018__af4b5e95fd6e545f8880eb96cd66e85cb">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="opengauss_api_0018__a0e0258187b894ccc9249e5a2a81915d4">Indicates the DB instance information.</p>
<p id="opengauss_api_0018__a95a4a4223c484a1d8c869e7a8927f3ad">For details, see <a href="#opengauss_api_0018__t984b923f71e04780a25930b4b0dc75bd">Table 3</a>.</p>
</td>
</tr>
<tr id="opengauss_api_0018__rd70bc21f6a3e4b0b98e95491a658a0eb"><td class="cellrowborder" valign="top" width="32.653265326532654%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="opengauss_api_0018__aca42631891cf48ab828c29f061dcf69c">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="opengauss_api_0018__en-us_topic_0128427215_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="opengauss_api_0018__afbc5f0efc67a466dbdb63cb6a5593542">Indicates the total number of records.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="opengauss_api_0018__t984b923f71e04780a25930b4b0dc75bd"></a><a name="t984b923f71e04780a25930b4b0dc75bd"></a><table cellpadding="4" cellspacing="0" summary="" id="opengauss_api_0018__t984b923f71e04780a25930b4b0dc75bd" frame="border" border="1" rules="all"><caption><b>Table 3 </b>instances field data structure description</caption><thead align="left"><tr id="opengauss_api_0018__r0ffe6257ca164a5f97e88340b52a51e0"><th align="left" class="cellrowborder" valign="top" width="23.23%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="opengauss_api_0018__en-us_topic_0128427215_p312219812612"><strong id="opengauss_api_0018__a9ca0b03643d64f7598877f141dbddb25">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="opengauss_api_0018__en-us_topic_0128427215_p91221985265"><strong id="opengauss_api_0018__en-us_topic_0128427215_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="opengauss_api_0018__en-us_topic_0128427215_p111226816261"><strong id="opengauss_api_0018__a128c0199efde4060b0fe141d1c68e43e">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="opengauss_api_0018__r10e9bbe5749e4ac094d1a4a89f146f25"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="opengauss_api_0018__en-us_topic_0128427215_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="opengauss_api_0018__aa9252e0f9e564d82ba4c237abea0ca1a">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.519999999999996%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="opengauss_api_0018__en-us_topic_0128427215_p412220818265">Indicates the DB instance ID.</p>
</td>
</tr>
<tr id="opengauss_api_0018__rab2015cd7987479d9fbe6c6d4553e65b"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="opengauss_api_0018__a8bdd9e34fe01450d95e01bfa96876353">name</p>
</td>
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="opengauss_api_0018__en-us_topic_0128427215_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="opengauss_api_0018__af6c424d4a76f4d299e7995decb114cd1">Indicates the created DB instance name.</p>
</td>
</tr>
<tr id="opengauss_api_0018__r0c423e1725b64558aa6798a5e44510c7"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="opengauss_api_0018__aec9bbce5d751472fb67f362fa6e5731e">status</p>
</td>
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="opengauss_api_0018__ab5c51752bd4a47679bf88835e7eea145">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.519999999999996%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="opengauss_api_0018__en-us_topic_0128427215_p121231486267">Indicates the DB instance status.</p>
<p id="opengauss_api_0018__en-us_topic_0128427215_p14123381266">Value:</p>
<p id="opengauss_api_0018__en-us_topic_0128427215_p121235818262">If the value is <strong id="opengauss_api_0018__a31fb7fd11dd04b188b9978038a39224c">BUILD</strong>, the DB instance is being created.</p>
<p id="opengauss_api_0018__a9d3d8ccf89c2405884b40f96d315e7b0">If the value is <strong id="opengauss_api_0018__a5207c8a8b4e34beab0f40367048b161f">ACTIVE</strong>, the DB instance is normal.</p>
<p id="opengauss_api_0018__en-us_topic_0128427215_p101231892614">If the value is <strong id="opengauss_api_0018__a4034290017784e05ab36fad8b349cac9">FAILED</strong>, the DB instance is abnormal.</p>
<p id="opengauss_api_0018__p76937191611">If the value is <strong id="opengauss_api_0018__b853692551214">EXPANDING</strong>, CNs or shards are being added to the DB instance.</p>
<p id="opengauss_api_0018__en-us_topic_0128427215_p111231284264">If the value is <strong id="opengauss_api_0018__a982fcb8ae62b404a99a8280776a7635c">REBOOTING</strong>, the DB instance is being rebooted.</p>
<p id="opengauss_api_0018__en-us_topic_0128427215_p612478102610">If the value is <strong id="opengauss_api_0018__en-us_topic_0128427215_b753162915291">BACKING UP</strong>, the DB instance is being backed up.</p>
</td>
</tr>
<tr id="opengauss_api_0018__ra5ce6fc8005445c5ab7f04d6626bdc16"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="opengauss_api_0018__en-us_topic_0128427215_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="opengauss_api_0018__en-us_topic_0128427215_p6124686265">List&lt;String&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="51.519999999999996%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="opengauss_api_0018__en-us_topic_0128427215_p812417819261">Indicates the private IP address list. It is a blank string until an ECS is created.</p>
</td>
</tr>
<tr id="opengauss_api_0018__rbfb3b550d3d4477db5079c8fcc9591df"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="opengauss_api_0018__en-us_topic_0128427215_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="opengauss_api_0018__a62dadf2cb4d44c6cabee09a6e3ffa06b">List&lt;String&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="51.519999999999996%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="opengauss_api_0018__ac6b87f0bae784eda95910be531a485fd">Indicates the public IP address list.</p>
</td>
</tr>
<tr id="opengauss_api_0018__rd0726a9449bb4e3da6b9415d9246a8dc"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="opengauss_api_0018__en-us_topic_0128427215_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="opengauss_api_0018__en-us_topic_0128427215_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="opengauss_api_0018__en-us_topic_0128427215_p201241815264">Indicates the database port number.</p>
<ul id="opengauss_api_0018__u1915a8fc47fc4291901615a5566af786"><li id="opengauss_api_0018__en-us_topic_0128427213_li82903363473">The <span id="opengauss_api_0018__t6a76ef54b2f542b39df0d9b899c5ac16">GaussDB(openGauss)</span> database port ranges from 1024 to 39998 (excluding the following which are occupied by the system and cannot be used: 2378, 2379, 2380, 4999, 5000, 5999, 6000, 6001, 8097, 8098, 20049, 20050, 21731, and 21732).</li></ul>
<p id="opengauss_api_0018__a420a37a8802a4846bf2102b99a94ca58">If this parameter is not specified,</p>
<ul id="opengauss_api_0018__ue6fd515246474abba235b6cc40e20d10"><li id="opengauss_api_0018__en-us_topic_0128427213_li93264964719">the default value of <span id="opengauss_api_0018__t39f2f0c81f3947a5bb955b8437c290b0">GaussDB(openGauss)</span> is <strong id="opengauss_api_0018__b3201822418">8000</strong>.</li></ul>
</td>
</tr>
<tr id="opengauss_api_0018__rfef4300f329a4e3abcc5f902144da9a9"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="opengauss_api_0018__en-us_topic_0128427215_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="opengauss_api_0018__en-us_topic_0128427215_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="opengauss_api_0018__a37a9fb3c688b4120a511ae64eff85d91">Indicates the instance type. The value is <strong id="opengauss_api_0018__b134661433154020">Enterprise</strong>, indicating the distributed instance (Enterprise Edition).</p>
</td>
</tr>
<tr id="opengauss_api_0018__re9f8e9aa739042cb98a8680ac722eec7"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="opengauss_api_0018__en-us_topic_0128427215_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="opengauss_api_0018__a503c4e44abd14ba882c64f3c4c9812dc">Object</p>
</td>
<td class="cellrowborder" valign="top" width="51.519999999999996%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="opengauss_api_0018__a184a5e189c1f4c0aaaa392c65dc90623">Returned when a distributed instance is obtained.</p>
<p id="opengauss_api_0018__en-us_topic_0128427215_p769251117558">For details, see <a href="#opengauss_api_0018__t281024fe14ef4fdb8157c38431571dcf">Table 4</a>.</p>
</td>
</tr>
<tr id="opengauss_api_0018__rcfcb175a63694cc6bdff34e7b2c19a2a"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="opengauss_api_0018__en-us_topic_0128427215_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="opengauss_api_0018__en-us_topic_0128427215_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="opengauss_api_0018__en-us_topic_0128427215_p21253816269">Indicates the region where the DB instance is deployed.</p>
</td>
</tr>
<tr id="opengauss_api_0018__r96c34ac8222b4c85927877ffa6875b89"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="opengauss_api_0018__en-us_topic_0128427215_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="opengauss_api_0018__en-us_topic_0128427215_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="opengauss_api_0018__en-us_topic_0128427215_p112510816261">Indicates the database information.</p>
<p id="opengauss_api_0018__ad9cc4a8b5c5b4a4d8fb6e66bb2f132c2">For details, see <a href="#opengauss_api_0018__t35d4ec11774e49df8e0fd1027c0115de">Table 5</a>.</p>
</td>
</tr>
<tr id="opengauss_api_0018__rbe8d0d0328004d63b30cd495d5275f6c"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="opengauss_api_0018__a9db99d7a733f4aefac5b20d7b7111d36">created</p>
</td>
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="opengauss_api_0018__a29795156d7cb4944a5572de7587e1dbb">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.519999999999996%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="opengauss_api_0018__a77a31bb884f6424e93d9f465f5bff1dc">Indicates the creation time in the "yyyy-mm-ddThh:mm:ssZ" format.</p>
<p id="opengauss_api_0018__a94445bc2086240c1b757305b28d0480e"><strong id="opengauss_api_0018__a5a8197202ca742b28972a43939aa6a7b">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="opengauss_api_0018__a15e1d04310a545b19a8097dcf998e5d4">Z</strong> indicates the time zone offset. For example, if the time zone offset is one hour, the value of <strong id="opengauss_api_0018__b169443577586">Z</strong> is <strong id="opengauss_api_0018__af0641649524743ba925d4341ae103cbb">+0100</strong>.</p>
<p id="opengauss_api_0018__en-us_topic_0128427215_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="opengauss_api_0018__rc19de31f127543eb9d686263e2b5c53f"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="opengauss_api_0018__a73585a5bcc90446f84715aefb8137514">updated</p>
</td>
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="opengauss_api_0018__en-us_topic_0128427215_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="opengauss_api_0018__en-us_topic_0128427215_p20126481268">Indicates the update time. The format is the same as that of the <strong id="opengauss_api_0018__a49870c4745cd4ea9a356403c76d87b38">created</strong> field.</p>
<p id="opengauss_api_0018__en-us_topic_0128427215_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="opengauss_api_0018__raaafb99bae7e4d0a96abfd87efe3cfa5"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="opengauss_api_0018__en-us_topic_0128427215_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="opengauss_api_0018__en-us_topic_0128427215_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="opengauss_api_0018__en-us_topic_0128427215_p21263832619">Indicates the default username.</p>
</td>
</tr>
<tr id="opengauss_api_0018__r250e7f9a4613461c8979cae5f0fd115d"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="opengauss_api_0018__en-us_topic_0128427215_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="opengauss_api_0018__en-us_topic_0128427215_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="opengauss_api_0018__a576815fb3fbd4b29a0a477de7cb3e513">Indicates the VPC ID.</p>
</td>
</tr>
<tr id="opengauss_api_0018__r46c96d40ffd643c4b431b462e8892ade"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="opengauss_api_0018__en-us_topic_0128427215_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="opengauss_api_0018__en-us_topic_0128427215_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="opengauss_api_0018__a9904dc8508cc49b5a8a8af92d23806bb">Indicates the network ID of the subnet.</p>
</td>
</tr>
<tr id="opengauss_api_0018__r91ec2592873a480abba2a034b05c3d32"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="opengauss_api_0018__a061234f32b8149c9ac5069449d60fbcd">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="opengauss_api_0018__abdaaa5c8dec94d9797ad23dc3d720a1f">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.519999999999996%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="opengauss_api_0018__en-us_topic_0128427215_p312698162616">Indicates the security group ID.</p>
</td>
</tr>
<tr id="opengauss_api_0018__r434477823e17464aa12af7d3ab4a2a69"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="opengauss_api_0018__a357d73406d264cb99f6f2f72ed674325">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="opengauss_api_0018__en-us_topic_0128427215_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="opengauss_api_0018__en-us_topic_0128427215_p19127185266">Indicates the specification code. For details on how to obtain the <span id="opengauss_api_0018__text1595635662410">GaussDB(openGauss)</span> specification code, see <a href="opengauss_api_0037.html#opengauss_api_0037__ted9b9d433c8a4c52884e199e17f94479">Table 1</a>.</p>
</td>
</tr>
<tr id="opengauss_api_0018__r943afb348b1046b2b644107dfab6bf16"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="opengauss_api_0018__en-us_topic_0128427215_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="opengauss_api_0018__en-us_topic_0128427215_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="opengauss_api_0018__adcbc4a8852254e98ac27e6ab228a6873">Indicates the volume information.</p>
<p id="opengauss_api_0018__en-us_topic_0128427215_p146713272134">For details, see <a href="#opengauss_api_0018__t3908aa1ee1944fe982a54300c17c270e">Table 6</a>.</p>
</td>
</tr>
<tr id="opengauss_api_0018__r5e36a8a9f29c44beb47a2e563d8e0428"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="opengauss_api_0018__en-us_topic_0128427215_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="opengauss_api_0018__en-us_topic_0128427215_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="opengauss_api_0018__adfea1a9c155942a5b09099f89569ab45">Indicates the database switchover policy. The value can be <strong id="opengauss_api_0018__a79825d5be43c4b56b5836b8ffabed746">reliability</strong> or <strong id="opengauss_api_0018__a8d449b8bf174452eb6a6efc45aed22bd">availability</strong>, indicating the reliability first and availability first, respectively.</p>
</td>
</tr>
<tr id="opengauss_api_0018__ra0033b16f0f74de9a54f04a3a6d51ac9"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="opengauss_api_0018__ac0f2b7cf044b4d25a84dc97d7a106fd5">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="opengauss_api_0018__a7bd235ce654a4ebd8bda3be48b1db50b">Object</p>
</td>
<td class="cellrowborder" valign="top" width="51.519999999999996%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="opengauss_api_0018__en-us_topic_0128427215_p812798122620">Indicates the backup policy.</p>
<p id="opengauss_api_0018__adcb8bb7c3f4148ecad3619bb7e5b8851">For details, see <a href="#opengauss_api_0018__tda12769996d34d20ae6bc4a6a64176ec">Table 7</a>.</p>
</td>
</tr>
<tr id="opengauss_api_0018__r6d28eb391bcf44bf9bf70d824c8ab61c"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="opengauss_api_0018__en-us_topic_0128427215_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="opengauss_api_0018__a774a8590a13d406a92d880690f662d66">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.519999999999996%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="opengauss_api_0018__a9e85352ad082477d9d12233420d45d70">Indicates the start time of the maintenance time window in the UTC format.</p>
</td>
</tr>
<tr id="opengauss_api_0018__red6ed0f2ee70490f8a45b50b32126c66"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="opengauss_api_0018__a19756d058bdc423895bb53d6d698aaef">nodes</p>
</td>
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="opengauss_api_0018__a48d339fd6d3c4be0a4c0343b8a68b721">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="opengauss_api_0018__a7380c02f20c84718b6bd40cfadaec488">Indicates the instance node information.</p>
<p id="opengauss_api_0018__en-us_topic_0128427215_p118919506137">For details, see <a href="#opengauss_api_0018__tf0062fb484974d3ea2bfc9d3f81a8684">Table 8</a>.</p>
</td>
</tr>
<tr id="opengauss_api_0018__rb525303d33b840de8fad580775b0237c"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="opengauss_api_0018__en-us_topic_0128427215_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="opengauss_api_0018__a8c8d60f00573435b8c3c297e7ec25b02">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="opengauss_api_0018__en-us_topic_0128427215_p161289862617">Indicates the list of associated DB instances. The parameters are not involved in <span id="opengauss_api_0018__text1546762312714">GaussDB(openGauss)</span>.</p>
</td>
</tr>
<tr id="opengauss_api_0018__r24fe4a4e3e1e4cc4817738d7d8be084d"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="opengauss_api_0018__en-us_topic_0128427215_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="opengauss_api_0018__en-us_topic_0128427215_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="opengauss_api_0018__a2cc452f68e5f4f1fb7b5148cd156e9cf">Indicates the time zone.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="opengauss_api_0018__t281024fe14ef4fdb8157c38431571dcf"></a><a name="t281024fe14ef4fdb8157c38431571dcf"></a><table cellpadding="4" cellspacing="0" summary="" id="opengauss_api_0018__t281024fe14ef4fdb8157c38431571dcf" frame="border" border="1" rules="all"><caption><b>Table 4 </b>ha field data structure description</caption><thead align="left"><tr id="opengauss_api_0018__rb6a31904d5544779a3c92ea02b6e0610"><th align="left" class="cellrowborder" valign="top" width="23.23%" id="mcps1.3.4.2.1.3.2.4.1.1"><p id="opengauss_api_0018__abce787fcfc054ba687310d32b199520e"><strong id="opengauss_api_0018__b2128468629">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="opengauss_api_0018__a3f2a2c9383ad456b8c8d6fb47a69982b"><strong id="opengauss_api_0018__b1330973715">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="opengauss_api_0018__aa99d8c158f674862a6d0cb73940eb852"><strong id="opengauss_api_0018__b875584469">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="opengauss_api_0018__rbdd493495f91404a83c933335db1f703"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="opengauss_api_0018__a22d1a5b7bd3c41498e8b8e55dd259107">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="opengauss_api_0018__en-us_topic_0128427215_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="opengauss_api_0018__en-us_topic_0128427215_p12130789263">Indicates the replication mode for the standby node.</p>
<p id="opengauss_api_0018__en-us_topic_0128427215_p613098162616">The value cannot be empty.</p>
<ul id="opengauss_api_0018__u98ec1eafa1fb4b699988929b74b77abc"><li id="opengauss_api_0018__en-us_topic_0128427215_li18463581110">For GaussDB(openGauss), the value is <strong id="opengauss_api_0018__b15134152664816">sync</strong>.</li></ul>
<div class="note" id="opengauss_api_0018__n7e5e98e8aea743b8ba902e81073a10f4"><span class="notetitle"> NOTE: </span><div class="notebody"><ul id="opengauss_api_0018__u631635fda98e4637aeed44e5aa34c83d"><li id="opengauss_api_0018__le4651ee84e37409f951e357009c33a1b"><strong id="opengauss_api_0018__b10723756155216">sync</strong> indicates the synchronous replication mode.</li></ul>
</div></div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="opengauss_api_0018__t35d4ec11774e49df8e0fd1027c0115de"></a><a name="t35d4ec11774e49df8e0fd1027c0115de"></a><table cellpadding="4" cellspacing="0" summary="" id="opengauss_api_0018__t35d4ec11774e49df8e0fd1027c0115de" frame="border" border="1" rules="all"><caption><b>Table 5 </b>datastore field data structure description</caption><thead align="left"><tr id="opengauss_api_0018__rddcfa348af2c45a3897e30b876485a52"><th align="left" class="cellrowborder" valign="top" width="23.23%" id="mcps1.3.4.2.1.4.2.4.1.1"><p id="opengauss_api_0018__en-us_topic_0128427215_p613316812264"><strong id="opengauss_api_0018__b1952345860">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="opengauss_api_0018__ab5503fdb59a64b649ea6589602a8526c"><strong id="opengauss_api_0018__b904520599">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="opengauss_api_0018__en-us_topic_0128427215_p21331385269"><strong id="opengauss_api_0018__b1680594129">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="opengauss_api_0018__r33007a9385b94f1a85c1fce2bc66102e"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.4.2.4.1.1 "><p id="opengauss_api_0018__ab4ba0dd4959345978310c283bc2369be">type</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.4.2.1.4.2.4.1.2 "><p id="opengauss_api_0018__a9162ba5d68054f2c9c4f076e70b9faa9">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.55%" headers="mcps1.3.4.2.1.4.2.4.1.3 "><p id="opengauss_api_0018__afb4c58e891ed4f0eb2cf5610104077b4">Indicates the DB engine.</p>
</td>
</tr>
<tr id="opengauss_api_0018__r25de4c72e8854ffcb5cca0bdf7b07408"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.4.2.4.1.1 "><p id="opengauss_api_0018__en-us_topic_0128427215_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="opengauss_api_0018__ac52ee9eed97f434fb1b8d8d1616ff23a">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.55%" headers="mcps1.3.4.2.1.4.2.4.1.3 "><p id="opengauss_api_0018__en-us_topic_0128427215_p181347842615">Indicates the database version.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="opengauss_api_0018__t3908aa1ee1944fe982a54300c17c270e"></a><a name="t3908aa1ee1944fe982a54300c17c270e"></a><table cellpadding="4" cellspacing="0" summary="" id="opengauss_api_0018__t3908aa1ee1944fe982a54300c17c270e" frame="border" border="1" rules="all"><caption><b>Table 6 </b>volume field data structure description</caption><thead align="left"><tr id="opengauss_api_0018__rbd9fc8c41f3643418b178c953518a6c0"><th align="left" class="cellrowborder" valign="top" width="23.23%" id="mcps1.3.4.2.1.5.2.4.1.1"><p id="opengauss_api_0018__en-us_topic_0128427215_p913708102613"><strong id="opengauss_api_0018__b1251963905">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="opengauss_api_0018__a08b835c60e04474598e6050f3c0c0a2f"><strong id="opengauss_api_0018__b885338766">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="opengauss_api_0018__en-us_topic_0128427215_p71376812616"><strong id="opengauss_api_0018__b1453577149">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="opengauss_api_0018__r3c33308106b24875873d833232724bd9"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.5.2.4.1.1 "><p id="opengauss_api_0018__a80b415d1891a4326beb79bc6ff5e068e">type</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.4.2.1.5.2.4.1.2 "><p id="opengauss_api_0018__en-us_topic_0128427215_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="opengauss_api_0018__en-us_topic_0128427215_p4137389266">Indicates the volume type.</p>
</td>
</tr>
<tr id="opengauss_api_0018__r19c1a4ea6a8844a49dd67572e62b1068"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.5.2.4.1.1 "><p id="opengauss_api_0018__en-us_topic_0128427215_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="opengauss_api_0018__aa27bb62f4e4143d98c1bf533d6a4b8d9">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="54.55%" headers="mcps1.3.4.2.1.5.2.4.1.3 "><p id="opengauss_api_0018__a1d35fb554a6c4e4ca3d90c21b5015012">Indicates the volume size.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="opengauss_api_0018__tda12769996d34d20ae6bc4a6a64176ec"></a><a name="tda12769996d34d20ae6bc4a6a64176ec"></a><table cellpadding="4" cellspacing="0" summary="" id="opengauss_api_0018__tda12769996d34d20ae6bc4a6a64176ec" frame="border" border="1" rules="all"><caption><b>Table 7 </b>backup_strategy field data structure description</caption><thead align="left"><tr id="opengauss_api_0018__r1bfa211b3b2a44cb9328caca71f0d377"><th align="left" class="cellrowborder" valign="top" width="23.23%" id="mcps1.3.4.2.1.6.2.4.1.1"><p id="opengauss_api_0018__en-us_topic_0128427215_p61401783265"><strong id="opengauss_api_0018__b1653498845">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="opengauss_api_0018__en-us_topic_0128427215_p4140287264"><strong id="opengauss_api_0018__b256723517">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="opengauss_api_0018__en-us_topic_0128427215_p101401384269"><strong id="opengauss_api_0018__b1499800270">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="opengauss_api_0018__r8f1ddba1a7164a979e6e0ed96ff3a527"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.6.2.4.1.1 "><p id="opengauss_api_0018__en-us_topic_0128427215_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="opengauss_api_0018__a2aa560bcd4fb4e20af86144115d9a6a4">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.55%" headers="mcps1.3.4.2.1.6.2.4.1.3 "><p id="opengauss_api_0018__en-us_topic_0128427215_p161401381268">Indicates the backup time window. Automated backups will be triggered during the backup time window.</p>
<p id="opengauss_api_0018__a347fbbe58a3042a493ea48cccaf471e9">The time is in the UTC format.</p>
</td>
</tr>
<tr id="opengauss_api_0018__r675060d2b4c94616b045e827f8b64040"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.6.2.4.1.1 "><p id="opengauss_api_0018__en-us_topic_0128427215_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="opengauss_api_0018__ad25d477a4b3f43f8a6161386aec8a47f">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="54.55%" headers="mcps1.3.4.2.1.6.2.4.1.3 "><p id="opengauss_api_0018__a0d4b69285c5848609cecc2b93cd12298">Indicates the number of days to retain the generated backup files.</p>
<p id="opengauss_api_0018__a35df37aa1f314ffd80f611449d7d7a60">The value ranges from 0 to 732. If the value is <strong id="opengauss_api_0018__ad5323deac42d47eea2c3950a37655e2f">0</strong>, the automated backup policy is not configured or has been disabled.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="opengauss_api_0018__tf0062fb484974d3ea2bfc9d3f81a8684"></a><a name="tf0062fb484974d3ea2bfc9d3f81a8684"></a><table cellpadding="4" cellspacing="0" summary="" id="opengauss_api_0018__tf0062fb484974d3ea2bfc9d3f81a8684" frame="border" border="1" rules="all"><caption><b>Table 8 </b>nodes field data structure description</caption><thead align="left"><tr id="opengauss_api_0018__r4fab1a41fc9343ae8b7568d025e663d7"><th align="left" class="cellrowborder" valign="top" width="23.23%" id="mcps1.3.4.2.1.7.2.4.1.1"><p id="opengauss_api_0018__a129c8ae856054466ae52ebe37b62fb64">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="opengauss_api_0018__en-us_topic_0128427215_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="opengauss_api_0018__a255dc1dc91654755809ed81078a827e8">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="opengauss_api_0018__ree87e2d140ad4ffbb5dde528ae2d8151"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.7.2.4.1.1 "><p id="opengauss_api_0018__aa326c6c4b1b4476383d060b582c4887a">id</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.4.2.1.7.2.4.1.2 "><p id="opengauss_api_0018__en-us_topic_0128427215_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="opengauss_api_0018__en-us_topic_0128427215_p914316812265">Indicates the node ID.</p>
</td>
</tr>
<tr id="opengauss_api_0018__rf986d80d43ee449799e2d07c42c9a25d"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.7.2.4.1.1 "><p id="opengauss_api_0018__a0079177cc14c445991ffd4fab67f685d">name</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.4.2.1.7.2.4.1.2 "><p id="opengauss_api_0018__ac1af10af5f2b4d009ff209e5f30c3a3e">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.55%" headers="mcps1.3.4.2.1.7.2.4.1.3 "><p id="opengauss_api_0018__en-us_topic_0128427215_p414313872615">Indicates the node name.</p>
</td>
</tr>
<tr id="opengauss_api_0018__r00f6915cdf634d4295efe269626b4278"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.7.2.4.1.1 "><p id="opengauss_api_0018__a356a9fa7ee174196a1385e8e09880654">role</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.4.2.1.7.2.4.1.2 "><p id="opengauss_api_0018__a2ab2144917214f33a0084a5071e691d8">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.55%" headers="mcps1.3.4.2.1.7.2.4.1.3 "><p id="opengauss_api_0018__en-us_topic_0128427215_p814516872618">Indicates the node type. The value can be <strong id="opengauss_api_0018__b551513446476">master</strong> or <strong id="opengauss_api_0018__b13515154434712">slave</strong>, indicating the primary node and standby node respectively.</p>
</td>
</tr>
<tr id="opengauss_api_0018__r101f4465bba441de977002902ba6a55f"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.7.2.4.1.1 "><p id="opengauss_api_0018__en-us_topic_0128427215_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="opengauss_api_0018__en-us_topic_0128427215_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="opengauss_api_0018__en-us_topic_0128427215_p114515814267">Indicates the node status.</p>
</td>
</tr>
<tr id="opengauss_api_0018__ref1e6a8fecfc4e52823cc2db54225203"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.7.2.4.1.1 "><p id="opengauss_api_0018__en-us_topic_0128427215_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="opengauss_api_0018__en-us_topic_0128427215_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="opengauss_api_0018__en-us_topic_0128427215_p131459819268">Indicates the AZ.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="opengauss_api_0018__en-us_topic_0128427215_li27619632">Example normal response<p id="opengauss_api_0018__en-us_topic_0128427215_p12928361362"><a name="opengauss_api_0018__en-us_topic_0128427215_li27619632"></a><a name="en-us_topic_0128427215_li27619632"></a><strong id="opengauss_api_0018__b4959182014533">Querying DB instances based on search criteria:</strong></p>
<pre class="codeblock" id="opengauss_api_0018__codeblock368794316311">{
"instances":[
{
"id":"3f6ee7c5e98f4c4d8c52be76cbf922efin14",
"status":"ACTIVE",
"name":"user1-no-delete-ng-B132_1",
"port":8000,
"type":"Enterprise",
"ha":{
"replication_mode":"sync"
},
"region":"eu-de",
"datastore":{
"type":"GaussDB(openGauss)",
"version":"1.1"
},
"created":"2020-06-25T03:09:02+0000",
"updated":"2020-06-25T05:34:53+0000",
"volume":{
"type":"ULTRAHIGH",
"size":160
},
"nodes":[
{
"id":"0218f10e317a4021ac8419c4b7e57dc2no14",
"name":"user1-no-delete-ng-B132_1_gaussdbv5cms_1",
"role":"slave",
"status":"ACTIVE",
"availability_zone":"eu-de-01"
},
{
"id":"24e233feb5c44075a2b0f650289c74fdno14",
"name":"user1-no-delete-ng-B132_1_gaussdbv5cn_1",
"role":"master",
"status":"ACTIVE",
"availability_zone":"eu-de-01"
},
{
"id":"2a8e9e6c55eb47759ade245af95a110fno14",
"name":"user1-no-delete-ng-B132_1_gaussdbv5dn2_2",
"role":"slave",
"status":"ACTIVE",
"availability_zone":"eu-de-01"
},
{
"id":"331dee7a09cf4e95a1d8eced07d1727ano14",
"name":"user1-no-delete-ng-B132_1_gaussdbv5gtm_1",
"role":"slave",
"status":"ACTIVE",
"availability_zone":"eu-de-01"
},
{
"id":"43b815a387fa4f2883659202e0c9a470no14",
"name":"user1-no-delete-ng-B132_1_gaussdbv5gtm_0",
"role":"master",
"status":"ACTIVE",
"availability_zone":"eu-de-01"
},
{
"id":"6274ceece9934a118dc5e5ff7f7f45c9no14",
"name":"user1-no-delete-ng-B132_1_gaussdbv5cn_0",
"role":"master",
"status":"ACTIVE",
"availability_zone":"eu-de-01"
},
{
"id":"650101ff9b3943d6b57f7f7098c3c0afno14",
"name":"user1-no-delete-ng-B132_1_gaussdbv5dn1_0",
"role":"master",
"status":"ACTIVE",
"availability_zone":"eu-de-01"
},
{
"id":"792859c1ec084b5da65532f4ad960b69no14",
"name":"user1-no-delete-ng-B132_1_gaussdbv5cms_2",
"role":"slave",
"status":"ACTIVE",
"availability_zone":"eu-de-01"
},
{
"id":"c59f81381f9c4e8d8ccded4792b7870fno14",
"name":"user1-no-delete-ng-B132_1_gaussdbv5dn2_1",
"role":"slave",
"status":"ACTIVE",
"availability_zone":"eu-de-01"
},
{
"id":"c6e15561a78548f6b94bd932356eb4a4no14",
"name":"user1-no-delete-ng-B132_1_gaussdbv5dn1_1",
"role":"slave",
"status":"ACTIVE",
"availability_zone":"eu-de-01"
},
{
"id":"cfc1dfb875ca4601bd488d5b313277d9no14",
"name":"user1-no-delete-ng-B132_1_gaussdbv5gtm_2",
"role":"slave",
"status":"ACTIVE",
"availability_zone":"eu-de-01"
},
{
"id":"d5846a820b214ae1863fe1cc41c1af93no14",
"name":"user1-no-delete-ng-B132_1_gaussdbv5dn2_0",
"role":"master",
"status":"ACTIVE",
"availability_zone":"eu-de-01"
},
{
"id":"eb0916d8fca4402b87686d8b085a7f53no14",
"name":"user1-no-delete-ng-B132_1_gaussdbv5cn_2",
"role":"master",
"status":"ACTIVE",
"availability_zone":"eu-de-01"
},
{
"id":"f486bc86fd254f80865221ca837524b6no14",
"name":"user1-no-delete-ng-B132_1_gaussdbv5dn1_2",
"role":"slave",
"status":"ACTIVE",
"availability_zone":"eu-de-01"
},
{
"id":"fa49d05061204bbb90dd5b0e5839961ano14",
"name":"user1-no-delete-ng-B132_1_gaussdbv5cms_0",
"role":"master",
"status":"ACTIVE",
"availability_zone":"eu-de-01"
}
],
"private_ips":[
"10.0.0.0 / 10.0.0.1 / 10.0.0.3"
],
"public_ips":[
],
"db_user_name":"root",
"vpc_id":"1f011c32-2de2-4aa8-a161-9498dbcef329",
"subnet_id":"54a44bec-e36f-441e-86bb-d749ace9c189",
"security_group_id":"c6123999-8532-421c-9db6-e078013ff58f",
"flavor_ref":"gaussdb.opengauss.ee.dn.m6.2xlarge.8.in",
"switch_strategy":"reliability",
"charge_info":{
"charge_mode":"postPaid"
},
"backup_strategy":{
"start_time":"",
"keep_days":0
},
"maintenance_window":"18:00-22:00",
"related_instance":[
],
"time_zone":"UTC+08:00"
}
],
"total_count":1
}</pre>
<pre class="codeblock" id="opengauss_api_0018__codeblock39527296492">{
"instances": [
{
"id": "3f6ee7c5e98f4c4d8c52be76cbf922efin14",
"status": "ACTIVE",
"name": "user1-no-delete-ng-B132_1",
"port": 8000,
"type": "Enterprise",
"ha": {
"replication_mode": "sync"
},
"region": "cn-xianhz-1",
"datastore": {
"type": "GaussDB(openGauss)",
"version": "1.1"
},
"created": "2020-06-25T03:09:02+0000",
"updated": "2020-06-25T05:34:53+0000",
"volume": {
"type": "ULTRAHIGH",
"size": 160
},
"nodes": [
{
"id": "0218f10e317a4021ac8419c4b7e57dc2no14",
"name": "user1-no-delete-ng-B132_1_gaussdbv5cms_1",
"role": "slave",
"status": "ACTIVE",
"availability_zone": "az1xahz"
},
{
"id": "24e233feb5c44075a2b0f650289c74fdno14",
"name": "user1-no-delete-ng-B132_1_gaussdbv5cn_1",
"role": "master",
"status": "ACTIVE",
"availability_zone": "az1xahz"
},
{
"id": "2a8e9e6c55eb47759ade245af95a110fno14",
"name": "user1-no-delete-ng-B132_1_gaussdbv5dn2_2",
"role": "slave",
"status": "ACTIVE",
"availability_zone": "az1xahz"
},
{
"id": "331dee7a09cf4e95a1d8eced07d1727ano14",
"name": "user1-no-delete-ng-B132_1_gaussdbv5gtm_1",
"role": "slave",
"status": "ACTIVE",
"availability_zone": "az1xahz"
},
{
"id": "43b815a387fa4f2883659202e0c9a470no14",
"name": "user1-no-delete-ng-B132_1_gaussdbv5gtm_0",
"role": "master",
"status": "ACTIVE",
"availability_zone": "az1xahz"
},
{
"id": "6274ceece9934a118dc5e5ff7f7f45c9no14",
"name": "user1-no-delete-ng-B132_1_gaussdbv5cn_0",
"role": "master",
"status": "ACTIVE",
"availability_zone": "az1xahz"
},
{
"id": "650101ff9b3943d6b57f7f7098c3c0afno14",
"name": "user1-no-delete-ng-B132_1_gaussdbv5dn1_0",
"role": "master",
"status": "ACTIVE",
"availability_zone": "az1xahz"
},
{
"id": "792859c1ec084b5da65532f4ad960b69no14",
"name": "user1-no-delete-ng-B132_1_gaussdbv5cms_2",
"role": "slave",
"status": "ACTIVE",
"availability_zone": "az1xahz"
},
{
"id": "c59f81381f9c4e8d8ccded4792b7870fno14",
"name": "user1-no-delete-ng-B132_1_gaussdbv5dn2_1",
"role": "slave",
"status": "ACTIVE",
"availability_zone": "az1xahz"
},
{
"id": "c6e15561a78548f6b94bd932356eb4a4no14",
"name": "user1-no-delete-ng-B132_1_gaussdbv5dn1_1",
"role": "slave",
"status": "ACTIVE",
"availability_zone": "az1xahz"
},
{
"id": "cfc1dfb875ca4601bd488d5b313277d9no14",
"name": "user1-no-delete-ng-B132_1_gaussdbv5gtm_2",
"role": "slave",
"status": "ACTIVE",
"availability_zone": "az1xahz"
},
{
"id": "d5846a820b214ae1863fe1cc41c1af93no14",
"name": "user1-no-delete-ng-B132_1_gaussdbv5dn2_0",
"role": "master",
"status": "ACTIVE",
"availability_zone": "az1xahz"
},
{
"id": "eb0916d8fca4402b87686d8b085a7f53no14",
"name": "user1-no-delete-ng-B132_1_gaussdbv5cn_2",
"role": "master",
"status": "ACTIVE",
"availability_zone": "az1xahz"
},
{
"id": "f486bc86fd254f80865221ca837524b6no14",
"name": "user1-no-delete-ng-B132_1_gaussdbv5dn1_2",
"role": "slave",
"status": "ACTIVE",
"availability_zone": "az1xahz"
},
{
"id": "fa49d05061204bbb90dd5b0e5839961ano14",
"name": "user1-no-delete-ng-B132_1_gaussdbv5cms_0",
"role": "master",
"status": "ACTIVE",
"availability_zone": "az1xahz"
}
],
"private_ips": [
"10.0.0.0 / 10.0.0.1 / 10.0.0.3"
],
"public_ips": [],
"db_user_name": "root",
"vpc_id": "1f011c32-2de2-4aa8-a161-9498dbcef329",
"subnet_id": "54a44bec-e36f-441e-86bb-d749ace9c189",
"security_group_id": "c6123999-8532-421c-9db6-e078013ff58f",
"flavor_ref": "gaussdb.opengauss.ee.dn.m6.2xlarge.8.in",
"switch_strategy": "reliability",
"charge_info": {
"charge_mode": "postPaid"
},
"backup_strategy": {
"start_time": "",
"keep_days": 0
},
"maintenance_window": "18:00-22:00",
"related_instance": [],
"time_zone": "UTC+08:00"
}
],
"total_count": 1
}</pre>
</li></ul>
<ul id="opengauss_api_0018__uf4500082d76f4a568a476520c68c9088"><li id="opengauss_api_0018__lfa420dd17e6345dcad5c3b675a71df3a"><strong id="opengauss_api_0018__b1244222115410">Querying all DB instances:</strong><pre class="codeblock" id="opengauss_api_0018__codeblock138251713548">{
"instances":[
{
"id":"4670359c9cb94644bf0e0111e3b0158bin14",
"status":"ACTIVE",
"name":"user_upgrade_test6_x86",
"port":8000,
"type":"Enterprise",
"ha":{
"replication_mode":"sync"
},
"region":"cn-xianhz-1",
"datastore":{
"type":"GaussDB(openGauss)",
"version":"1.1"
},
"created":"2020-06-22T12:45:41+0000",
"updated":"2020-06-22T12:45:41+0000",
"volume":{
"type":"ULTRAHIGH",
"size":120
},
"nodes":[
{
"id":"409ff2a1c8aa44db98c4df339bf5f9d6no14",
"name":"user_upgrade_test6_x86_gaussdbv5cms_1",
"role":"slave",
"status":"ACTIVE",
"availability_zone":"az2xahz"
},
{
"id":"595a235a51ab482ab997d1d0cff6dfb7no14",
"name":"user_upgrade_test6_x86_gaussdbv5cn_0",
"role":"master",
"status":"ACTIVE",
"availability_zone":"az2xahz"
},
{
"id":"5b944393b7434aa684b53b11fc572fcano14",
"name":"user_upgrade_test6_x86_gaussdbv5cms_0",
"role":"master",
"status":"ACTIVE",
"availability_zone":"az2xahz"
},
{
"id":"5c2d2f451a274113a0ae441e9187ae26no14",
"name":"user_upgrade_test6_x86_gaussdbv5dn1_1",
"role":"slave",
"status":"ACTIVE",
"availability_zone":"az2xahz"
},
{
"id":"718091e1229245af876f28cf8713225cno14",
"name":"user_upgrade_test6_x86_gaussdbv5gtm_1",
"role":"slave",
"status":"ACTIVE",
"availability_zone":"az2xahz"
},
{
"id":"96949fe1373b486ebab8c9c87c9cb1ddno14",
"name":"user_upgrade_test6_x86_gaussdbv5gtm_2",
"role":"slave",
"status":"ACTIVE",
"availability_zone":"az2xahz"
},
{
"id":"973d5816100841388b4a6b822aff6e20no14",
"name":"user_upgrade_test6_x86_gaussdbv5cms_2",
"role":"slave",
"status":"ACTIVE",
"availability_zone":"az2xahz"
},
{
"id":"a06bf305f995426f87b747aa98a94a4ano14",
"name":"user_upgrade_test6_x86_gaussdbv5gtm_0",
"role":"master",
"status":"ACTIVE",
"availability_zone":"az2xahz"
},
{
"id":"ab7793dfc70c4ae7a535921639233d9cno14",
"name":"user_upgrade_test6_x86_gaussdbv5dn1_0",
"role":"master",
"status":"ACTIVE",
"availability_zone":"az2xahz"
},
{
"id":"d6b081f12d984d3ba8804dadbb8920deno14",
"name":"user_upgrade_test6_x86_gaussdbv5dn1_2",
"role":"slave",
"status":"ACTIVE",
"availability_zone":"az2xahz"
}
],
"private_ips":[
"10.0.0.0"
],
"public_ips":[
],
"db_user_name":"root",
"vpc_id":"1f011c32-2de2-4aa8-a161-9498dbcef329",
"subnet_id":"54a44bec-e36f-441e-86bb-d749ace9c189",
"security_group_id":"c6123999-8532-421c-9db6-e078013ff58f",
"flavor_ref":"gaussdb.opengauss.ee.dn.m6.2xlarge.8.in",
"switch_strategy":"reliability",
"charge_info":{
"charge_mode":"postPaid"
},
"backup_strategy":{
"start_time":"",
"keep_days":0
},
"maintenance_window":"18:00-22:00",
"related_instance":[
],
"time_zone":"UTC+08:00"
},
{
"id":"08a693683a394bbd82907f300ea219abin14",
"status":"ACTIVE",
"name":"user_x86_01",
"port":8000,
"type":"Enterprise",
"ha":{
"replication_mode":"sync"
},
"region":"cn-xianhz-1",
"datastore":{
"type":"GaussDB(openGauss)",
"version":"1.1"
},
"created":"2020-06-22T08:54:50+0000",
"updated":"2020-06-22T08:54:50+0000",
"volume":{
"type":"ULTRAHIGH",
"size":120
},
"nodes":[
{
"id":"271ec8ed56d842839f117382582a631fno14",
"name":"user_x86_01_gaussdbv5dn1_0",
"role":"slave",
"status":"ACTIVE",
"availability_zone":"az2xahz"
},
{
"id":"54bfeea3d28d40ec9d49df7458f2ebe3no14",
"name":"user_x86_01_gaussdbv5dn1_2",
"role":"slave",
"status":"ACTIVE",
"availability_zone":"az2xahz"
},
{
"id":"688e0d16c0004a1ca0d4697cb8d74a32no14",
"name":"user_x86_01_gaussdbv5gtm_0",
"role":"master",
"status":"ACTIVE",
"availability_zone":"az2xahz"
},
{
"id":"81b682997ca84c668d1d0b727ee9662fno14",
"name":"user_x86_01_gaussdbv5gtm_2",
"role":"slave",
"status":"ACTIVE",
"availability_zone":"az2xahz"
},
{
"id":"847f153d9f524e4a845b39f2291742e6no14",
"name":"user_x86_01_gaussdbv5dn1_1",
"role":"master",
"status":"ACTIVE",
"availability_zone":"az2xahz"
},
{
"id":"a7fb4fb4d14940bb90a558d2fe7343c2no14",
"name":"user_x86_01_gaussdbv5gtm_1",
"role":"slave",
"status":"ACTIVE",
"availability_zone":"az2xahz"
},
{
"id":"b3f496af3a9745ae891bb5f4fc553a3eno14",
"name":"user_x86_01_gaussdbv5cms_2",
"role":"slave",
"status":"ACTIVE",
"availability_zone":"az2xahz"
},
{
"id":"c3a0fa4d919f40559000fa5e61fd1047no14",
"name":"user_x86_01_gaussdbv5cn_1",
"role":"master",
"status":"ACTIVE",
"availability_zone":"az2xahz"
},
{
"id":"cecfb26dbef846499e5e20fa3efd42f4no14",
"name":"user_x86_01_gaussdbv5cn_0",
"role":"master",
"status":"ACTIVE",
"availability_zone":"az2xahz"
},
{
"id":"cfc23c4642524a59a2d33dbf038f9f4bno14",
"name":"user_x86_01_gaussdbv5cms_0",
"role":"master",
"status":"ACTIVE",
"availability_zone":"az2xahz"
},
{
"id":"efb7f9059e7c439a9b8d53a991f5e526no14",
"name":"user_x86_01_gaussdbv5cms_1",
"role":"slave",
"status":"ACTIVE",
"availability_zone":"az2xahz"
}
],
"private_ips":[
"10.0.0.0 / 10.0.0.1"
],
"public_ips":[
],
"db_user_name":"root",
"vpc_id":"1f011c32-2de2-4aa8-a161-9498dbcef329",
"subnet_id":"54a44bec-e36f-441e-86bb-d749ace9c189",
"security_group_id":"c6123999-8532-421c-9db6-e078013ff58f",
"flavor_ref":"gaussdb.opengauss.ee.dn.m6.2xlarge.8.in",
"switch_strategy":"reliability",
"charge_info":{
"charge_mode":"postPaid"
},
"backup_strategy":{
"start_time":"",
"keep_days":0
},
"maintenance_window":"18:00-22:00",
"related_instance":[
],
"time_zone":"UTC+08:00"
}
],
"total_count":2
}</pre>
<pre class="codeblock" id="opengauss_api_0018__codeblock1864745961010">{
"instances":[
{
"id":"4670359c9cb94644bf0e0111e3b0158bin14",
"status":"ACTIVE",
"name":"user_upgrade_test6_x86",
"port":8000,
"type":"Enterprise",
"ha":{
"replication_mode":"sync"
},
"region":"eu-de",
"datastore":{
"type":"GaussDB(openGauss)",
"version":"1.1"
},
"created":"2020-06-22T12:45:41+0000",
"updated":"2020-06-22T12:45:41+0000",
"volume":{
"type":"ULTRAHIGH",
"size":120
},
"nodes":[
{
"id":"409ff2a1c8aa44db98c4df339bf5f9d6no14",
"name":"user_upgrade_test6_x86_gaussdbv5cms_1",
"role":"slave",
"status":"ACTIVE",
"availability_zone":"eu-de-01"
},
{
"id":"595a235a51ab482ab997d1d0cff6dfb7no14",
"name":"user_upgrade_test6_x86_gaussdbv5cn_0",
"role":"master",
"status":"ACTIVE",
"availability_zone":"eu-de-01"
},
{
"id":"5b944393b7434aa684b53b11fc572fcano14",
"name":"user_upgrade_test6_x86_gaussdbv5cms_0",
"role":"master",
"status":"ACTIVE",
"availability_zone":"eu-de-01"
},
{
"id":"5c2d2f451a274113a0ae441e9187ae26no14",
"name":"user_upgrade_test6_x86_gaussdbv5dn1_1",
"role":"slave",
"status":"ACTIVE",
"availability_zone":"eu-de-01"
},
{
"id":"718091e1229245af876f28cf8713225cno14",
"name":"user_upgrade_test6_x86_gaussdbv5gtm_1",
"role":"slave",
"status":"ACTIVE",
"availability_zone":"eu-de-01"
},
{
"id":"96949fe1373b486ebab8c9c87c9cb1ddno14",
"name":"user_upgrade_test6_x86_gaussdbv5gtm_2",
"role":"slave",
"status":"ACTIVE",
"availability_zone":"eu-de-01"
},
{
"id":"973d5816100841388b4a6b822aff6e20no14",
"name":"user_upgrade_test6_x86_gaussdbv5cms_2",
"role":"slave",
"status":"ACTIVE",
"availability_zone":"eu-de-01"
},
{
"id":"a06bf305f995426f87b747aa98a94a4ano14",
"name":"user_upgrade_test6_x86_gaussdbv5gtm_0",
"role":"master",
"status":"ACTIVE",
"availability_zone":"eu-de-01"
},
{
"id":"ab7793dfc70c4ae7a535921639233d9cno14",
"name":"user_upgrade_test6_x86_gaussdbv5dn1_0",
"role":"master",
"status":"ACTIVE",
"availability_zone":"eu-de-01"
},
{
"id":"d6b081f12d984d3ba8804dadbb8920deno14",
"name":"user_upgrade_test6_x86_gaussdbv5dn1_2",
"role":"slave",
"status":"ACTIVE",
"availability_zone":"eu-de-01"
}
],
"private_ips":[
"10.0.0.0"
],
"public_ips":[
],
"db_user_name":"root",
"vpc_id":"1f011c32-2de2-4aa8-a161-9498dbcef329",
"subnet_id":"54a44bec-e36f-441e-86bb-d749ace9c189",
"security_group_id":"c6123999-8532-421c-9db6-e078013ff58f",
"flavor_ref":"gaussdb.opengauss.ee.dn.m6.2xlarge.8.in",
"switch_strategy":"reliability",
"charge_info":{
"charge_mode":"postPaid"
},
"backup_strategy":{
"start_time":"",
"keep_days":0
},
"maintenance_window":"18:00-22:00",
"related_instance":[
],
"time_zone":"UTC+08:00"
},
{
"id":"08a693683a394bbd82907f300ea219abin14",
"status":"ACTIVE",
"name":"user_x86_01",
"port":8000,
"type":"Enterprise",
"ha":{
"replication_mode":"sync"
},
"region":"eu-de",
"datastore":{
"type":"GaussDB(openGauss)",
"version":"1.1"
},
"created":"2020-06-22T08:54:50+0000",
"updated":"2020-06-22T08:54:50+0000",
"volume":{
"type":"ULTRAHIGH",
"size":120
},
"nodes":[
{
"id":"271ec8ed56d842839f117382582a631fno14",
"name":"user_x86_01_gaussdbv5dn1_0",
"role":"slave",
"status":"ACTIVE",
"availability_zone":"eu-de-01"
},
{
"id":"54bfeea3d28d40ec9d49df7458f2ebe3no14",
"name":"user_x86_01_gaussdbv5dn1_2",
"role":"slave",
"status":"ACTIVE",
"availability_zone":"eu-de-01"
},
{
"id":"688e0d16c0004a1ca0d4697cb8d74a32no14",
"name":"user_x86_01_gaussdbv5gtm_0",
"role":"master",
"status":"ACTIVE",
"availability_zone":"eu-de-01"
},
{
"id":"81b682997ca84c668d1d0b727ee9662fno14",
"name":"user_x86_01_gaussdbv5gtm_2",
"role":"slave",
"status":"ACTIVE",
"availability_zone":"eu-de-01"
},
{
"id":"847f153d9f524e4a845b39f2291742e6no14",
"name":"user_x86_01_gaussdbv5dn1_1",
"role":"master",
"status":"ACTIVE",
"availability_zone":"eu-de-01"
},
{
"id":"a7fb4fb4d14940bb90a558d2fe7343c2no14",
"name":"user_x86_01_gaussdbv5gtm_1",
"role":"slave",
"status":"ACTIVE",
"availability_zone":"eu-de-01"
},
{
"id":"b3f496af3a9745ae891bb5f4fc553a3eno14",
"name":"user_x86_01_gaussdbv5cms_2",
"role":"slave",
"status":"ACTIVE",
"availability_zone":"eu-de-01"
},
{
"id":"c3a0fa4d919f40559000fa5e61fd1047no14",
"name":"user_x86_01_gaussdbv5cn_1",
"role":"master",
"status":"ACTIVE",
"availability_zone":"eu-de-01"
},
{
"id":"cecfb26dbef846499e5e20fa3efd42f4no14",
"name":"user_x86_01_gaussdbv5cn_0",
"role":"master",
"status":"ACTIVE",
"availability_zone":"eu-de-01"
},
{
"id":"cfc23c4642524a59a2d33dbf038f9f4bno14",
"name":"user_x86_01_gaussdbv5cms_0",
"role":"master",
"status":"ACTIVE",
"availability_zone":"eu-de-01"
},
{
"id":"efb7f9059e7c439a9b8d53a991f5e526no14",
"name":"user_x86_01_gaussdbv5cms_1",
"role":"slave",
"status":"ACTIVE",
"availability_zone":"eu-de-01"
}
],
"private_ips":[
"10.0.0.0 / 10.0.0.1"
],
"public_ips":[
],
"db_user_name":"root",
"vpc_id":"1f011c32-2de2-4aa8-a161-9498dbcef329",
"subnet_id":"54a44bec-e36f-441e-86bb-d749ace9c189",
"security_group_id":"c6123999-8532-421c-9db6-e078013ff58f",
"flavor_ref":"gaussdb.opengauss.ee.dn.m6.2xlarge.8.in",
"switch_strategy":"reliability",
"charge_info":{
"charge_mode":"postPaid"
},
"backup_strategy":{
"start_time":"",
"keep_days":0
},
"maintenance_window":"18:00-22:00",
"related_instance":[
],
"time_zone":"UTC+08:00"
}
],
"total_count":2
}</pre>
<p id="opengauss_api_0018__p98266139418"></p>
</li><li id="opengauss_api_0018__en-us_topic_0128427215_li15857509162">Abnormal response<p id="opengauss_api_0018__a49cce877333646e8bf59f35902243a82"><a name="opengauss_api_0018__en-us_topic_0128427215_li15857509162"></a><a name="en-us_topic_0128427215_li15857509162"></a>For details, see <a href="opengauss_api_0031.html">Abnormal Request Results</a>.</p>
</li></ul>
</div>
<div class="section" id="opengauss_api_0018__sf4d6e4bd217141b49e82ad45b3aead18"><h4 class="sectiontitle">Status Codes</h4><p id="opengauss_api_0018__ad6824e04527a4a76a14f3ecaae2eb642">For details, see <a href="opengauss_api_0032.html">Status Codes</a>.</p>
</div>
<div class="section" id="opengauss_api_0018__s999ce49405d44f2b997f9e8d96bed3b7"><h4 class="sectiontitle">Error Codes</h4><p id="opengauss_api_0018__a478f17fa76dc42f792612496f9e1fdba">For details, see <a href="opengauss_api_0033.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="opengauss_api_0014.html">DB Instance Management</a></div>
</div>
</div>
View Git Blame Copy Permalink