yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
a41a4e0331fbc0beff63bb28fa59228cc9a751df
doc-exports/docs/taurusdb/api-ref/gaussdb_04_0005.html
wangdengke2 1aae9268b0 taurusdb_api 
Reviewed-by: Boka, Ladislav <ladislav.boka@t-systems.com>
Co-authored-by: wangdengke2 <wangdengke2@huawei.com>
Co-committed-by: wangdengke2 <wangdengke2@huawei.com>
2025-06-17 09:00:31 +00:00

620 lines
44 KiB
HTML
Raw Blame History

<a name="gaussdb_04_0005"></a><a name="gaussdb_04_0005"></a>
<h1 class="topictitle1">Querying DB Instances</h1>
<div id="body1590815684863"><div class="section" id="gaussdb_04_0005__section44230431101549"><h4 class="sectiontitle">Function</h4><p id="gaussdb_04_0005__p1350220403353">This API is used to query DB instances according to search criteria. Before using this API:</p>
<ul id="gaussdb_04_0005__ul924420236520"><li id="gaussdb_04_0005__li136356359522">Learn how to <a href="gaussdb_03_0001.html">authorize and authenticate</a> it.</li><li id="gaussdb_04_0005__li1991981933613">Obtain the required <a href="gaussdb_00_0003.html">region and endpoint</a>.</li></ul>
</div>
<div class="section" id="gaussdb_04_0005__section42449433267"><h4 class="sectiontitle">URI</h4><p id="gaussdb_04_0005__p6244843152614">GET /v3/{project_id}/instances</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_04_0005__table182451433265" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="gaussdb_04_0005__row92459439266"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="gaussdb_04_0005__p6245134312268">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="gaussdb_04_0005__p1024584382614">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="gaussdb_04_0005__p17245194372616">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="gaussdb_04_0005__p1724504310267">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_04_0005__row124554310268"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="gaussdb_04_0005__p3246343172612">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="gaussdb_04_0005__p1724674312615">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="gaussdb_04_0005__p0246643172618">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="gaussdb_04_0005__p1651951252917">Project ID of a tenant in a region.</p>
<p id="gaussdb_04_0005__p151910126299">To obtain this value, see <a href="gaussdb_10_0004.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_04_0005__table162472043172620" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query parameters</caption><thead align="left"><tr id="gaussdb_04_0005__row17246743102617"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="gaussdb_04_0005__p824744313262">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="gaussdb_04_0005__p0247543202617">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="gaussdb_04_0005__p6247174372617">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="gaussdb_04_0005__p2024734318266">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_04_0005__row16246743192614"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="gaussdb_04_0005__p224704312616">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="gaussdb_04_0005__p192474437262">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="gaussdb_04_0005__p0248143132610">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="gaussdb_04_0005__p6248243102616">DB instance ID. The asterisk (*) is reserved for the system. If the DB 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 DB instance ID. The value cannot contain only asterisks (*).</p>
</td>
</tr>
<tr id="gaussdb_04_0005__row22466433262"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="gaussdb_04_0005__p15248174322612">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="gaussdb_04_0005__p112481943202619">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="gaussdb_04_0005__p1424894310264">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="gaussdb_04_0005__p224894314268">DB instance name. 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="gaussdb_04_0005__row18246843102618"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="gaussdb_04_0005__p22481043142615">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="gaussdb_04_0005__p18249124317264">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="gaussdb_04_0005__p152491443122614">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="gaussdb_04_0005__p424924315265">DB instance type to be queried. Currently, its value can only be <strong id="gaussdb_04_0005__b1785604817593">Cluster</strong>.</p>
</td>
</tr>
<tr id="gaussdb_04_0005__row11246194332612"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="gaussdb_04_0005__p202494434262">datastore_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="gaussdb_04_0005__p52491743122613">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="gaussdb_04_0005__p1824914312612">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="gaussdb_04_0005__p8249184319267">DB type. Currently, only gaussdb-mysql is supported.</p>
</td>
</tr>
<tr id="gaussdb_04_0005__row1624674311269"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="gaussdb_04_0005__p152491343132610">vpc_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="gaussdb_04_0005__p524934316262">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="gaussdb_04_0005__p525014316263">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="gaussdb_04_0005__p1947313244299">VPC ID.</p>
</td>
</tr>
<tr id="gaussdb_04_0005__row18246943192612"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="gaussdb_04_0005__p225015433262">subnet_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="gaussdb_04_0005__p32501643182612">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="gaussdb_04_0005__p1250124317268">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="gaussdb_04_0005__p1036613518296">Network ID of the subnet.</p>
</td>
</tr>
<tr id="gaussdb_04_0005__row2024617432266"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="gaussdb_04_0005__p625094316264">private_ip</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="gaussdb_04_0005__p13250843162619">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="gaussdb_04_0005__p62501943162611">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="gaussdb_04_0005__p152511743122619">Private IP address.</p>
</td>
</tr>
<tr id="gaussdb_04_0005__row624734316263"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="gaussdb_04_0005__p1025184362612">offset</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="gaussdb_04_0005__p10251184320269">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="gaussdb_04_0005__p2251443182611">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="gaussdb_04_0005__p1225117435268">Index offset. If <strong id="gaussdb_04_0005__b1918312517327">offset</strong> is set to <em id="gaussdb_04_0005__i1418412583219">N</em>, the resource query starts from the N+1 piece of data. The value is <strong id="gaussdb_04_0005__b518452515328">0</strong> by default, indicating that the query starts from the first piece of data. The value cannot be a negative number.</p>
</td>
</tr>
<tr id="gaussdb_04_0005__row112475438268"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="gaussdb_04_0005__p225134312268">limit</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="gaussdb_04_0005__p9251743162617">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="gaussdb_04_0005__p15251443132619">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="gaussdb_04_0005__p925114392611">Number of records to be queried. The default value is <strong id="gaussdb_04_0005__b19447115264615">100</strong>. The value must be a positive integer. The minimum value is <strong id="gaussdb_04_0005__b1644811529469">1</strong> and the maximum value is <strong id="gaussdb_04_0005__b644855216461">100</strong>.</p>
</td>
</tr>
<tr id="gaussdb_04_0005__row1424714435260"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="gaussdb_04_0005__p142521143142611">tags</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="gaussdb_04_0005__p152521243152613">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="gaussdb_04_0005__p1025274310261">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="gaussdb_04_0005__p19252184352614">Query based on the DB instance tag key and value. <em id="gaussdb_04_0005__i1180343644715">{key}</em> indicates the tag key, and <em id="gaussdb_04_0005__i1580323624712">{value}</em> indicates the tag value. To query DB instances with multiple tag keys and values, separate key-value pairs with commas (,). The key must be unique. Multiple keys are in AND relationship.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="gaussdb_04_0005__section10952132173017"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_04_0005__table1195242111301" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="gaussdb_04_0005__row9952121133016"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="gaussdb_04_0005__p9952172120306">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="gaussdb_04_0005__p12952172117308">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="gaussdb_04_0005__p119522021153017">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="gaussdb_04_0005__p1595217215301">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_04_0005__row5952221163014"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="gaussdb_04_0005__p495214219300">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="gaussdb_04_0005__p189521121113011">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="gaussdb_04_0005__p139522212306">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="gaussdb_04_0005__p19952102123015">User token.</p>
</td>
</tr>
<tr id="gaussdb_04_0005__row9952621143011"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="gaussdb_04_0005__p15952182117305">X-Language</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="gaussdb_04_0005__p795215217309">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="gaussdb_04_0005__p1395232193014">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="gaussdb_04_0005__p189521221143018">Language.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="gaussdb_04_0005__section82541543162620"><h4 class="sectiontitle">Response Parameters</h4><p id="gaussdb_04_0005__p9254124312269"><strong id="gaussdb_04_0005__b969220024813">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_04_0005__response_MysqlInstanceList" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="gaussdb_04_0005__row1225534311264"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="gaussdb_04_0005__p1425512437264">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="gaussdb_04_0005__p1925511431261">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="gaussdb_04_0005__p1255154352613">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_04_0005__row12255174317264"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="gaussdb_04_0005__p1525644302610">instances</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="gaussdb_04_0005__p1725644315263">Array of <a href="#gaussdb_04_0005__response_MysqlInstanceListInfo">MysqlInstanceListInfo</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="gaussdb_04_0005__p125694313263">DB instance list information.</p>
</td>
</tr>
<tr id="gaussdb_04_0005__row142551043162612"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="gaussdb_04_0005__p7256174314267">total_count</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="gaussdb_04_0005__p142562043172618">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="gaussdb_04_0005__p7256543152614">Total number of records.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="gaussdb_04_0005__response_MysqlInstanceListInfo"></a><a name="response_MysqlInstanceListInfo"></a><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_04_0005__response_MysqlInstanceListInfo" frame="border" border="1" rules="all"><caption><b>Table 5 </b>MysqlInstanceListInfo</caption><thead align="left"><tr id="gaussdb_04_0005__row1025734362613"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="gaussdb_04_0005__p225811433264">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="gaussdb_04_0005__p125864332610">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="gaussdb_04_0005__p1325814352612">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_04_0005__row152571543162615"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_04_0005__p11258184318262">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_04_0005__p325854342619">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_04_0005__p12583439265">DB instance ID.</p>
</td>
</tr>
<tr id="gaussdb_04_0005__row172571743172612"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_04_0005__p8258164318266">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_04_0005__p12597437268">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_04_0005__p1825917432265">DB instance name.</p>
</td>
</tr>
<tr id="gaussdb_04_0005__row13257154310269"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_04_0005__p1225934316266">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_04_0005__p16259114392614">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_04_0005__p1125911435269">DB instance status.</p>
</td>
</tr>
<tr id="gaussdb_04_0005__row102571643182611"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_04_0005__p18259194362616">private_ips</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_04_0005__p925944316262">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_04_0005__p1325934315263">Private IP address for write. It is a blank string until an ECS is created.</p>
</td>
</tr>
<tr id="gaussdb_04_0005__row20257194319262"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_04_0005__p20260104372611">public_ips</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_04_0005__p12260124315265">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_04_0005__p726020431267">Public IP addresses.</p>
</td>
</tr>
<tr id="gaussdb_04_0005__row1257164320269"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_04_0005__p5260184342611">port</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_04_0005__p17260143152618">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_04_0005__p202609433267">Database port.</p>
</td>
</tr>
<tr id="gaussdb_04_0005__row142571543182617"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_04_0005__p122605432265">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_04_0005__p14260943142616">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_04_0005__p62607435264">DB instance type. The value is <strong id="gaussdb_04_0005__b715568769">Cluster</strong>.</p>
</td>
</tr>
<tr id="gaussdb_04_0005__row10257104317264"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_04_0005__p026194312613">region</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_04_0005__p7261124342610">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_04_0005__p102617433263">Region where the DB instance is deployed.</p>
</td>
</tr>
<tr id="gaussdb_04_0005__row11257124318261"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_04_0005__p7261124312268">datastore</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_04_0005__p9261134322618"><a href="#gaussdb_04_0005__response_MysqlDatastore">MysqlDatastore</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_04_0005__p112622043162610">Database information.</p>
</td>
</tr>
<tr id="gaussdb_04_0005__row6257643172612"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_04_0005__p14262134317268">created</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_04_0005__p11262144322616">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_04_0005__p17263164319261">Creation time in the "yyyy-mm-ddThh:mm:ssZ" format. <strong id="gaussdb_04_0005__b9477173714271">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="gaussdb_04_0005__b1477113712274">Z</strong> indicates the time zone offset. The value is empty unless the DB instance creation is complete.</p>
</td>
</tr>
<tr id="gaussdb_04_0005__row1725704342617"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_04_0005__p192631243202617">updated</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_04_0005__p32630436264">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_04_0005__p326304362610">Update time. The format is the same as that of the <strong id="gaussdb_04_0005__b14524049184816">created</strong> field. The value is empty unless the DB instance creation is complete.</p>
</td>
</tr>
<tr id="gaussdb_04_0005__row15257154319261"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_04_0005__p13263164314260">db_user_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_04_0005__p426313433262">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_04_0005__p8263043132615">Default username.</p>
</td>
</tr>
<tr id="gaussdb_04_0005__row112573433261"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_04_0005__p92631343122612">vpc_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_04_0005__p17263204322613">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_04_0005__p226412439265">VPC ID.</p>
</td>
</tr>
<tr id="gaussdb_04_0005__row1925724316262"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_04_0005__p4264164318266">subnet_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_04_0005__p1626464314264">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_04_0005__p4264204392613">Network ID of the subnet.</p>
</td>
</tr>
<tr id="gaussdb_04_0005__row1725744332610"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_04_0005__p226474342610">security_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_04_0005__p11264943102614">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_04_0005__p3264143142618">Security group ID.</p>
</td>
</tr>
<tr id="gaussdb_04_0005__row17257143172617"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_04_0005__p16264943102612">flavor_ref</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_04_0005__p11265174319261">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_04_0005__p1226513430264">Specification code.</p>
</td>
</tr>
<tr id="gaussdb_04_0005__row6257124392616"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_04_0005__p22651443112617">flavor_info</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_04_0005__p226520432265"><a href="#gaussdb_04_0005__response_MysqlFlavorInfo">MysqlFlavorInfo</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_04_0005__p112651243102618">Flavor information.</p>
</td>
</tr>
<tr id="gaussdb_04_0005__row1625715434263"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_04_0005__p1126516438265">volume</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_04_0005__p326594342620"><a href="#gaussdb_04_0005__response_MysqlVolumeInfo">MysqlVolumeInfo</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_04_0005__p192650438263">Storage disk information.</p>
</td>
</tr>
<tr id="gaussdb_04_0005__row1425704311260"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_04_0005__p13266114315260">backup_strategy</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_04_0005__p152663435265"><a href="#gaussdb_04_0005__response_MysqlBackupStrategy">MysqlBackupStrategy</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_04_0005__p12266164313266">Automated backup policy.</p>
</td>
</tr>
<tr id="gaussdb_04_0005__row12257164322614"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_04_0005__p14266204362619">time_zone</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_04_0005__p1126614342618">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_04_0005__p19266144392610">Time zone.</p>
</td>
</tr>
<tr id="gaussdb_04_0005__row192572431261"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_04_0005__p1026710435268">dedicated_resource_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_04_0005__p426784312262">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_04_0005__p182671643172612">Dedicated resource pool ID. This parameter is returned only when the DB instance belongs to a dedicated resource pool.</p>
</td>
</tr>
<tr id="gaussdb_04_0005__row6257194312615"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_04_0005__p0267144316263">tags</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_04_0005__p42671643112615">Array of <a href="#gaussdb_04_0005__response_InstanceTagItem">InstanceTagItem</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_04_0005__p126720435269">Tag list.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="gaussdb_04_0005__response_MysqlDatastore"></a><a name="response_MysqlDatastore"></a><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_04_0005__response_MysqlDatastore" frame="border" border="1" rules="all"><caption><b>Table 6 </b>MysqlDatastoreWithKernelVersion</caption><thead align="left"><tr id="gaussdb_04_0005__row11268143152610"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="gaussdb_04_0005__p326824382615">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="gaussdb_04_0005__p6268184311267">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="gaussdb_04_0005__p1126894372619">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_04_0005__row2268443162619"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="gaussdb_04_0005__p1926894310263">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="gaussdb_04_0005__p8268843152614">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="gaussdb_04_0005__p18269204362611">DB engine. Currently, only gaussdb-mysql is supported.</p>
</td>
</tr>
<tr id="gaussdb_04_0005__row1268104332612"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="gaussdb_04_0005__p8269043192612">version</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="gaussdb_04_0005__p426964302620">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="gaussdb_04_0005__p1326917431265">DB version.</p>
<p id="gaussdb_04_0005__p13269043102614">To obtain details about supported DB engine versions, call the API for querying the DB engine versions.</p>
</td>
</tr>
<tr id="gaussdb_04_0005__row1866201216532"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="gaussdb_04_0005__p422545811237">kernel_version</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="gaussdb_04_0005__p22254581234">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="gaussdb_04_0005__p1622665818239">Database kernel version.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="gaussdb_04_0005__response_MysqlFlavorInfo"></a><a name="response_MysqlFlavorInfo"></a><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_04_0005__response_MysqlFlavorInfo" frame="border" border="1" rules="all"><caption><b>Table 7 </b>MysqlFlavorInfo</caption><thead align="left"><tr id="gaussdb_04_0005__row626914392615"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.1"><p id="gaussdb_04_0005__p192701743202614">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.2"><p id="gaussdb_04_0005__p1127014439266">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.6.2.4.1.3"><p id="gaussdb_04_0005__p4270243162619">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_04_0005__row6269174310261"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="gaussdb_04_0005__p2027014392619">vcpus</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="gaussdb_04_0005__p4270184318263">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="gaussdb_04_0005__p17270194311262">Number of vCPUs.</p>
</td>
</tr>
<tr id="gaussdb_04_0005__row12691743142614"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="gaussdb_04_0005__p192703434267">ram</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="gaussdb_04_0005__p0271114342612">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="gaussdb_04_0005__p182711043122618">Memory size in GB.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="gaussdb_04_0005__response_MysqlVolumeInfo"></a><a name="response_MysqlVolumeInfo"></a><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_04_0005__response_MysqlVolumeInfo" frame="border" border="1" rules="all"><caption><b>Table 8 </b>MysqlVolumeInfo</caption><thead align="left"><tr id="gaussdb_04_0005__row1427144318260"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.1"><p id="gaussdb_04_0005__p172713438263">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.2"><p id="gaussdb_04_0005__p2271134372610">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.7.2.4.1.3"><p id="gaussdb_04_0005__p7272143162611">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_04_0005__row8271343162618"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="gaussdb_04_0005__p12727439266">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="gaussdb_04_0005__p12272144392617">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="gaussdb_04_0005__p32722434261">Disk type.</p>
</td>
</tr>
<tr id="gaussdb_04_0005__row22711443172616"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="gaussdb_04_0005__p9272114372614">size</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="gaussdb_04_0005__p11272134317263">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="gaussdb_04_0005__p1827244316269">Used disk size in GB.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="gaussdb_04_0005__response_MysqlBackupStrategy"></a><a name="response_MysqlBackupStrategy"></a><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_04_0005__response_MysqlBackupStrategy" frame="border" border="1" rules="all"><caption><b>Table 9 </b>MysqlBackupStrategy</caption><thead align="left"><tr id="gaussdb_04_0005__row4273194382618"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.8.2.4.1.1"><p id="gaussdb_04_0005__p255613436269">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.8.2.4.1.2"><p id="gaussdb_04_0005__p1655624382612">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.8.2.4.1.3"><p id="gaussdb_04_0005__p155654392620">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_04_0005__row1127344317265"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="gaussdb_04_0005__p855610437265">start_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="gaussdb_04_0005__p1155694313264">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="gaussdb_04_0005__p855694362618">Automated backup start time. The automated backup will be triggered within one hour after the time specified by this parameter.</p>
<p id="gaussdb_04_0005__p2556134392614">The value cannot be empty. It must be a valid value in the "hh:mm-HH:MM" format. The current time is in the UTC format.</p>
<ol id="gaussdb_04_0005__ol655634311265"><li id="gaussdb_04_0005__li4556643152611">The <strong id="gaussdb_04_0005__b34691547194911">HH</strong> value must be 1 greater than the <strong id="gaussdb_04_0005__b1546984718499">hh</strong> value.</li><li id="gaussdb_04_0005__li85566437266">The values of <strong id="gaussdb_04_0005__b36463485494">mm</strong> and <strong id="gaussdb_04_0005__b8647548144915">MM</strong> must be the same and must be set to <strong id="gaussdb_04_0005__b1464784813493">00</strong>.</li></ol>
</td>
</tr>
<tr id="gaussdb_04_0005__row7273154314263"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="gaussdb_04_0005__p17556134382617">keep_days</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="gaussdb_04_0005__p135561843152617">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="gaussdb_04_0005__p185571343122615">Automated backup retention days. Value: 1-732.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="gaussdb_04_0005__response_InstanceTagItem"></a><a name="response_InstanceTagItem"></a><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_04_0005__response_InstanceTagItem" frame="border" border="1" rules="all"><caption><b>Table 10 </b>InstanceTagItem</caption><thead align="left"><tr id="gaussdb_04_0005__row12782043162616"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.9.2.4.1.1"><p id="gaussdb_04_0005__p1555844310268">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.9.2.4.1.2"><p id="gaussdb_04_0005__p9558243202612">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.9.2.4.1.3"><p id="gaussdb_04_0005__p155816430262">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_04_0005__row15278124315269"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="gaussdb_04_0005__p16558154313264">key</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="gaussdb_04_0005__p145589436264">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="gaussdb_04_0005__p145589434269">Tag key.</p>
</td>
</tr>
<tr id="gaussdb_04_0005__row827818433264"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="gaussdb_04_0005__p255812437262">value</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="gaussdb_04_0005__p175586437265">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="gaussdb_04_0005__p2558204320263">Tag value.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="gaussdb_04_0005__p755864317269"><strong id="gaussdb_04_0005__b07491273508">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_04_0005__response_MysqlErrorResponse" frame="border" border="1" rules="all"><caption><b>Table 11 </b>Response body parameters</caption><thead align="left"><tr id="gaussdb_04_0005__row3279743152620"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.11.2.4.1.1"><p id="gaussdb_04_0005__p16558184382610">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.11.2.4.1.2"><p id="gaussdb_04_0005__p755834316261">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.11.2.4.1.3"><p id="gaussdb_04_0005__p105584435263">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_04_0005__row127904302616"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.1 "><p id="gaussdb_04_0005__p6558144372611">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.2 "><p id="gaussdb_04_0005__p1655864362616">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.11.2.4.1.3 "><p id="gaussdb_04_0005__p16558443102614">Error code.</p>
</td>
</tr>
<tr id="gaussdb_04_0005__row17279144317260"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.1 "><p id="gaussdb_04_0005__p13558104382611">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.2 "><p id="gaussdb_04_0005__p8558643112614">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.11.2.4.1.3 "><p id="gaussdb_04_0005__p17558204312615">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="gaussdb_04_0005__p05581743102610"><strong id="gaussdb_04_0005__b571211301502">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_04_0005__table1428110436264" frame="border" border="1" rules="all"><caption><b>Table 12 </b>Response body parameters</caption><thead align="left"><tr id="gaussdb_04_0005__row3281843152615"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.13.2.4.1.1"><p id="gaussdb_04_0005__p1355817438262">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.13.2.4.1.2"><p id="gaussdb_04_0005__p1655810433267">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.13.2.4.1.3"><p id="gaussdb_04_0005__p555813439263">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_04_0005__row15281164392618"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.1 "><p id="gaussdb_04_0005__p1555812432262">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.2 "><p id="gaussdb_04_0005__p1155814437269">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.13.2.4.1.3 "><p id="gaussdb_04_0005__p355820430267">Error code.</p>
</td>
</tr>
<tr id="gaussdb_04_0005__row16281124322618"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.1 "><p id="gaussdb_04_0005__p12558164310266">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.2 "><p id="gaussdb_04_0005__p18558144318267">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.13.2.4.1.3 "><p id="gaussdb_04_0005__p1855884316267">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="gaussdb_04_0005__section115581043182612"><h4 class="sectiontitle">Example Request</h4><p id="gaussdb_04_0005__p55581543172620">Querying DB instances</p>
<pre class="screen" id="gaussdb_04_0005__screen178254454212">GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances?id=d738399de028480fabb2b8120d4e01a4in07&amp;name=taurusdb-instance01&amp;type=Cluster&amp;datastore_type=gaussdb-mysql&amp;vpc_id=3cedfc54-b105-4652-a4e0-847b11576b58&amp;subnet_id=c1cfa53c-65d3-431e-8552-326bf310c7ad&amp;private_ip=192.168.0.142&amp;offset=0&amp;limit=10&amp;tags=Key1=Value1</pre>
</div>
<div class="section" id="gaussdb_04_0005__section455844322617"><h4 class="sectiontitle">Example Response</h4><p id="gaussdb_04_0005__p45581743192618"><strong id="gaussdb_04_0005__b1875014816505">Status code: 200</strong></p>
<p id="gaussdb_04_0005__p75585436268">Success.</p>
<pre class="screen" id="gaussdb_04_0005__screen11558184316264">{
"total_count" : 1,
"instances" : [ {
"id" : "d738399de028480fabb2b8120d4e01a4in07",
"name" : "taurusdb-instance01",
"status" : "ACTIVE",
"port" : 3306,
"type" : "Cluster",
"private_ips" : [ "192.168.0.142" ],
"db_user_name" : "root",
"region" : "eu-de",
"datastore" : {
"type" : "gaussdb-mysql",
"version" : "8.0",
"kernel_version" : "2.0.28.7"
},
"created" : "2018-08-20T02:33:49_0800",
"updated" : "2018-08-20T02:33:49_0800",
"volume" : {
"type" : "POOL",
"size" : 100
},
"vpc_id" : "3cedfc54-b105-4652-a4e0-847b11576b58",
"subnet_id" : "c1cfa53c-65d3-431e-8552-326bf310c7ad",
"security_group_id" : "fc577a1a-f202-424a-977f-24faec3fdd55",
"flavor_ref" : "gaussdb.mysql.xlarge.x86.8",
"flavor_info" : {
"vcpus" : 4,
"ram" : 32
},
"backup_strategy" : {
"start_time" : "19:00-20:00",
"keep_days" : 7
},
"charge_info" : {
"charge_mode" : "postPaid"
},
"enterprise_project_id" : 0,
"time_zone" : "UTC",
"tags": [{
"key":"Key",
"value":"Value1"
}]
} ]
}</pre>
</div>
<div class="section" id="gaussdb_04_0005__section4778540915440"><h4 class="sectiontitle">Status Code</h4><p id="gaussdb_04_0005__p0723374409">For details, see <a href="gaussdb_10_0002.html">Status Codes</a>.</p>
</div>
<div class="section" id="gaussdb_04_0005__section946032144017"><h4 class="sectiontitle">Error Code</h4><p id="gaussdb_04_0005__p19357163913406">For details, see <a href="gaussdb_10_0003.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="gaussdb_04_0003.html">Managing DB Instances</a></div>
</div>
</div>
View Git Blame Copy Permalink