Files
doc-exports/docs/taurusdb/api-ref/gaussdb_04_0006.html
wangdengke2 ee9f8aa0b6 taurusdb_api
Reviewed-by: Gladkov, Maksim <mgladkov@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: wangdengke2 <wangdengke2@huawei.com>
Co-committed-by: wangdengke2 <wangdengke2@huawei.com>
2025-10-30 15:48:33 +00:00

806 lines
56 KiB
HTML

<a name="gaussdb_04_0006"></a><a name="gaussdb_04_0006"></a>
<h1 class="topictitle1">Querying Details of a DB Instance</h1>
<div id="body1590815684863"><div class="section" id="gaussdb_04_0006__section44230431101549"><h4 class="sectiontitle">Function</h4><p id="gaussdb_04_0006__p1350220403353">This API is used to query the details of a specified DB instance. Before using this API:</p>
<ul id="gaussdb_04_0006__ul924420236520"><li id="gaussdb_04_0006__li136356359522">Learn how to <a href="gaussdb_03_0001.html">authorize and authenticate</a> it.</li><li id="gaussdb_04_0006__li1991981933613">Obtain the required <a href="gaussdb_00_0003.html">region and endpoint</a>.</li></ul>
</div>
<div class="section" id="gaussdb_04_0006__section11188224102013"><h4 class="sectiontitle">URI</h4><p id="gaussdb_04_0006__p20188624112012">GET /v3/{project_id}/instances/{instance_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_04_0006__table41888243208" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="gaussdb_04_0006__row7188102442019"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="gaussdb_04_0006__p1418911248202">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_0006__p17189102413207">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_0006__p1218952415203">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_0006__p131891924152017">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_04_0006__row131881624202019"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="gaussdb_04_0006__p1619082452012">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="gaussdb_04_0006__p719015247203">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="gaussdb_04_0006__p1119002432012">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="gaussdb_04_0006__p4759193414215">Project ID of a tenant in a region.</p>
<p id="gaussdb_04_0006__p1775993415218">To obtain this value, see <a href="gaussdb_10_0004.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
<tr id="gaussdb_04_0006__row41881024162016"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="gaussdb_04_0006__p71901024112010">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="gaussdb_04_0006__p819111245203">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="gaussdb_04_0006__p4191142412206">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="gaussdb_04_0006__p819112416207">DB instance ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="gaussdb_04_0006__section419112410204"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_04_0006__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="gaussdb_04_0006__row1319117242201"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="gaussdb_04_0006__p2019262452014">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_0006__p1819215244202">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_0006__p1319232418209">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_0006__p1019216249205">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_04_0006__row161911724162012"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="gaussdb_04_0006__p121921224192015">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_0006__p15192102412015">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="gaussdb_04_0006__p3193224132012">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="gaussdb_04_0006__p131932024182018">User token.</p>
</td>
</tr>
<tr id="gaussdb_04_0006__row11911124202011"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="gaussdb_04_0006__p1319352411205">X-Language</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="gaussdb_04_0006__p1619392410204">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="gaussdb_04_0006__p12193112492013">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="gaussdb_04_0006__p191931324142018">Language.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="gaussdb_04_0006__section8194152410206"><h4 class="sectiontitle">Response Parameters</h4><p id="gaussdb_04_0006__p12194624142013"><strong id="gaussdb_04_0006__b1958075486">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_04_0006__response_MysqlInstanceInfo" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="gaussdb_04_0006__row131945241207"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="gaussdb_04_0006__p191947249205">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_0006__p219511245205">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_0006__p1819519245206">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_04_0006__row419492416205"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="gaussdb_04_0006__p18195102415200">instance</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="gaussdb_04_0006__p919572442011"><a href="#gaussdb_04_0006__response_MysqlInstanceInfoDetail">MysqlInstanceInfoDetail</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="gaussdb_04_0006__p41951324142010">DB instance information.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="gaussdb_04_0006__response_MysqlInstanceInfoDetail"></a><a name="response_MysqlInstanceInfoDetail"></a><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_04_0006__response_MysqlInstanceInfoDetail" frame="border" border="1" rules="all"><caption><b>Table 4 </b>MysqlInstanceInfoDetail</caption><thead align="left"><tr id="gaussdb_04_0006__row1319692482018"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="gaussdb_04_0006__p16197924202011">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_0006__p181972242209">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_0006__p8197824142016">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_04_0006__row91966249204"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_04_0006__p17197152420206">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_04_0006__p19197624172016">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_04_0006__p19197182472011">DB instance ID.</p>
</td>
</tr>
<tr id="gaussdb_04_0006__row61966248207"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_04_0006__p41981524172020">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_04_0006__p181983248206">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_04_0006__p1419822414203">DB instance name.</p>
</td>
</tr>
<tr id="gaussdb_04_0006__row1819610248205"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_04_0006__p1319810243207">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_04_0006__p7198424142016">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_04_0006__p81981424182012">Project ID of a tenant in a region.</p>
</td>
</tr>
<tr id="gaussdb_04_0006__row319642432017"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_04_0006__p5198132422014">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_04_0006__p17199102415206">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_04_0006__p95931306221">DB instance status.</p>
<p id="gaussdb_04_0006__p359350192217">Valid value:</p>
<p id="gaussdb_04_0006__p195934052215">If the value is <strong id="gaussdb_04_0006__b28194471546">BUILD</strong>, the DB instance is being created.</p>
<p id="gaussdb_04_0006__p05945012229">If the value is <strong id="gaussdb_04_0006__b628114559418">ACTIVE</strong>, the DB instance is normal.</p>
<p id="gaussdb_04_0006__p35945018227">If the value is <strong id="gaussdb_04_0006__b1534711457">FAILED</strong>, the DB instance is abnormal.</p>
<p id="gaussdb_04_0006__p1359419015223">If the value is <strong id="gaussdb_04_0006__b2681942057">FROZEN</strong>, the DB instance is frozen.</p>
<p id="gaussdb_04_0006__p11594100142211">If the value is <strong id="gaussdb_04_0006__b31408720514">MODIFYING</strong>, the DB instance is being scaled up.</p>
<p id="gaussdb_04_0006__p20594100225">If the value is <strong id="gaussdb_04_0006__b981214141356">REBOOTING</strong>, the DB instance is being rebooted.</p>
<p id="gaussdb_04_0006__p1259410092219">If the value is <strong id="gaussdb_04_0006__b19631817454">RESTORING</strong>, the DB instance is being restored.</p>
<p id="gaussdb_04_0006__p10594303222">If the value is <strong id="gaussdb_04_0006__b1351872019516">MODIFYING INSTANCE TYPE</strong>, the DB instance is changing from primary to standby.</p>
<p id="gaussdb_04_0006__p3594150112217">If the value is <strong id="gaussdb_04_0006__b1148214486276">SWITCHOVER</strong>, the primary/standby switchover is being performed.</p>
<p id="gaussdb_04_0006__p159419020227">If the value is <strong id="gaussdb_04_0006__b3420101768">MIGRATING</strong>, the DB instance is being migrated.</p>
<p id="gaussdb_04_0006__p95941706222">If the value is <strong id="gaussdb_04_0006__b39023513611">BACKING UP</strong>, the DB instance is being backed up.</p>
<p id="gaussdb_04_0006__p135946082212">If the value is <strong id="gaussdb_04_0006__b9200581961">MODIFYING DATABASE PORT</strong>, the database port is being changed.</p>
<p id="gaussdb_04_0006__p159416032217">If the value is <strong id="gaussdb_04_0006__b91363139812">STORAGE FULL</strong>, the DB instance storage space is full.</p>
</td>
</tr>
<tr id="gaussdb_04_0006__row16196202412013"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_04_0006__p919992413209">port</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_04_0006__p1199724102013">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_04_0006__p6199112432018">Database port.</p>
</td>
</tr>
<tr id="gaussdb_04_0006__row9196182414202"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_04_0006__p17199124142013">alias</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_04_0006__p119942452017">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_04_0006__p92001724162011">DB instance remarks.</p>
</td>
</tr>
<tr id="gaussdb_04_0006__row16196162413209"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_04_0006__p20200102417204">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_04_0006__p920002419200">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_04_0006__p3200624142017">DB instance type. The value is <strong id="gaussdb_04_0006__b637132175116">Cluster</strong>.</p>
</td>
</tr>
<tr id="gaussdb_04_0006__row991615371617"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_04_0006__p6374114313154">charge_info</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_04_0006__p137464301511"><a href="#gaussdb_04_0006__response_MysqlInstanceChargeInfo">MysqlInstanceChargeInfo</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_04_0006__p203741435154">Billing mode, which is yearly/monthly or pay-per-use (default setting).</p>
</td>
</tr>
<tr id="gaussdb_04_0006__row14196122417205"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_04_0006__p1620052412012">node_count</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_04_0006__p12200132411208">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_04_0006__p11200112412010">Number of nodes.</p>
</td>
</tr>
<tr id="gaussdb_04_0006__row219617249203"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_04_0006__p32011124142016">datastore</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_04_0006__p142011243209"><a href="#gaussdb_04_0006__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_0006__p3201152482010">Database information.</p>
</td>
</tr>
<tr id="gaussdb_04_0006__row1019662422013"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_04_0006__p1120115247200">backup_used_space</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_04_0006__p1320119248204">Double</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_04_0006__p10201162411201">Used backup space in GB.</p>
</td>
</tr>
<tr id="gaussdb_04_0006__row3196192419208"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_04_0006__p62013243202">created</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_04_0006__p1720216249209">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_04_0006__p19202162413206">Creation time in the "yyyy-mm-ddThh:mm:ssZ" format. <strong id="gaussdb_04_0006__b3253847142716">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="gaussdb_04_0006__b5259134762717">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_0006__row161961124172015"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_04_0006__p5202824102016">updated</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_04_0006__p1320222410202">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_04_0006__p62027245206">Update time. The format is the same as that of the <strong id="gaussdb_04_0006__b12339824971">created</strong> field. The value is empty unless the DB instance creation is complete.</p>
</td>
</tr>
<tr id="gaussdb_04_0006__row21963247209"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_04_0006__p82022248207">private_write_ips</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_04_0006__p920312414201">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_0006__p12203152419200">Private IP address for write.</p>
</td>
</tr>
<tr id="gaussdb_04_0006__row2019612416209"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_04_0006__p20203172472017">public_ips</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_04_0006__p182037248208">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_04_0006__p14203724152012">Public IP address of the DB instance.</p>
</td>
</tr>
<tr id="gaussdb_04_0006__row1619610245208"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_04_0006__p82031824162012">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_0006__p1520362432014">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_04_0006__p12203102422018">Default username.</p>
</td>
</tr>
<tr id="gaussdb_04_0006__row13196122412016"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_04_0006__p14204324182013">vpc_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_04_0006__p520462492017">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_04_0006__p92041424152020">VPC ID.</p>
</td>
</tr>
<tr id="gaussdb_04_0006__row8196924112015"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_04_0006__p1120452472019">subnet_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_04_0006__p4204202402017">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_04_0006__p920415248204">Network ID of the subnet.</p>
</td>
</tr>
<tr id="gaussdb_04_0006__row8196112452018"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_04_0006__p162041324152013">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_0006__p102051324142018">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_04_0006__p32059244207">Security group ID.</p>
</td>
</tr>
<tr id="gaussdb_04_0006__row419617242202"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_04_0006__p3205152410203">configuration_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_04_0006__p172057247202">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_04_0006__p10205162415200">ID of the parameter template used for creating a DB instance or ID of the latest parameter template that is applied to an instance.</p>
</td>
</tr>
<tr id="gaussdb_04_0006__row01969242206"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_04_0006__p172057244208">backup_strategy</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_04_0006__p18205524142013"><a href="#gaussdb_04_0006__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_0006__p14206112411203">Automated backup policy.</p>
</td>
</tr>
<tr id="gaussdb_04_0006__row11196172412019"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_04_0006__p820772410206">nodes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_04_0006__p820714249205">Array of <a href="#gaussdb_04_0006__response_MysqlInstanceNodeInfo">MysqlInstanceNodeInfo</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_04_0006__p62079245205">Node information.</p>
</td>
</tr>
<tr id="gaussdb_04_0006__row14196142410201"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_04_0006__p3208132414206">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_04_0006__p62088248201">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_04_0006__p420842419200">Enterprise project ID.</p>
</td>
</tr>
<tr id="gaussdb_04_0006__row10196224122011"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_04_0006__p5208624102011">time_zone</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_04_0006__p020817247201">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_04_0006__p13208172402015">Time zone.</p>
</td>
</tr>
<tr id="gaussdb_04_0006__row1619652412013"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_04_0006__p6209182419209">az_mode</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_04_0006__p520912492010">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_04_0006__p920972413204">AZ type. It can be <strong id="gaussdb_04_0006__b1786294116170">single</strong> or <strong id="gaussdb_04_0006__b58621441121717">multi</strong>.</p>
</td>
</tr>
<tr id="gaussdb_04_0006__row01961824142020"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_04_0006__p1209192413201">master_az_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_04_0006__p120912247206">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_04_0006__p2020922462015">Primary AZ.</p>
</td>
</tr>
<tr id="gaussdb_04_0006__row619602414200"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_04_0006__p421062418208">maintenance_window</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_04_0006__p0210132415204">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_04_0006__p17210124152018">Maintenance window in the UTC format.</p>
</td>
</tr>
<tr id="gaussdb_04_0006__row719622419202"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_04_0006__p62105243201">tags</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_04_0006__p17210324172017">Array of <a href="#gaussdb_04_0006__response_MysqlTags">MysqlTags</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_04_0006__p1621072432019">Tags for managing DB instances.</p>
</td>
</tr>
<tr id="gaussdb_04_0006__row101966240206"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_04_0006__p8210162422016">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_0006__p13211142442019">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_04_0006__p721111247205">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_0006__row919613247209"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_04_0006__p82111424112020">proxies</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_04_0006__p18211824192013">Array of <a href="#gaussdb_04_0006__response_MysqlProxyInfo">MysqlProxyInfo</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_04_0006__p1121172419207">Proxy information.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="gaussdb_04_0006__response_MysqlInstanceChargeInfo"></a><a name="response_MysqlInstanceChargeInfo"></a><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_04_0006__response_MysqlInstanceChargeInfo" frame="border" border="1" rules="all"><caption><b>Table 5 </b>MysqlInstanceChargeInfo</caption><thead align="left"><tr id="gaussdb_04_0006__row16384114319159"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="gaussdb_04_0006__p153851743191511">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_0006__p73853431152">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_0006__p63856435155">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_04_0006__row5384243161516"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="gaussdb_04_0006__p11385144391519">charge_mode</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="gaussdb_04_0006__p1538524315150">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="gaussdb_04_0006__p5385164311511">Billing mode.</p>
</td>
</tr>
<tr id="gaussdb_04_0006__row1038412430155"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="gaussdb_04_0006__p738574319158">order_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="gaussdb_04_0006__p93863437154">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="gaussdb_04_0006__p10386124381519">Order ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="gaussdb_04_0006__response_MysqlDatastore"></a><a name="response_MysqlDatastore"></a><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_04_0006__response_MysqlDatastore" frame="border" border="1" rules="all"><caption><b>Table 6 </b>MysqlDatastoreWithKernelVersion</caption><thead align="left"><tr id="gaussdb_04_0006__row521119242206"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.1"><p id="gaussdb_04_0006__p021222414207">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_0006__p3212324142017">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_0006__p82121924132018">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_04_0006__row10212024102010"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="gaussdb_04_0006__p621210249207">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="gaussdb_04_0006__p19213202462014">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="gaussdb_04_0006__p621315246207">DB engine. Currently, only gaussdb-mysql is supported.</p>
</td>
</tr>
<tr id="gaussdb_04_0006__row821217248200"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="gaussdb_04_0006__p10213124142013">version</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="gaussdb_04_0006__p19213192411209">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="gaussdb_04_0006__p42130240200">DB version.</p>
<p id="gaussdb_04_0006__p521315249201">To obtain details about supported DB engine versions, call the API for querying the DB engine versions.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="gaussdb_04_0006__response_MysqlBackupStrategy"></a><a name="response_MysqlBackupStrategy"></a><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_04_0006__response_MysqlBackupStrategy" frame="border" border="1" rules="all"><caption><b>Table 7 </b>MysqlBackupStrategy</caption><thead align="left"><tr id="gaussdb_04_0006__row19214112492010"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.1"><p id="gaussdb_04_0006__p3214224132010">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_0006__p12214142414206">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_0006__p321417248206">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_04_0006__row18214624102014"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="gaussdb_04_0006__p1421422462011">start_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="gaussdb_04_0006__p8215182415200">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="gaussdb_04_0006__p1921552432020">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_0006__p1921572472011">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_0006__ol192159247207"><li id="gaussdb_04_0006__li12155242201">The <strong id="gaussdb_04_0006__b1759012762620">HH</strong> value must be 1 greater than the <strong id="gaussdb_04_0006__b8590137112616">hh</strong> value.</li><li id="gaussdb_04_0006__li16215182492017">The values of <strong id="gaussdb_04_0006__b460419918261">mm</strong> and <strong id="gaussdb_04_0006__b6605139172615">MM</strong> must be the same and must be set to <strong id="gaussdb_04_0006__b1460559152610">00</strong>.</li></ol>
</td>
</tr>
<tr id="gaussdb_04_0006__row321492412209"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="gaussdb_04_0006__p142150247206">keep_days</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="gaussdb_04_0006__p14215224122014">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="gaussdb_04_0006__p221622419208">Automated backup retention days. Value: 1-732.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="gaussdb_04_0006__response_MysqlInstanceNodeInfo"></a><a name="response_MysqlInstanceNodeInfo"></a><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_04_0006__response_MysqlInstanceNodeInfo" frame="border" border="1" rules="all"><caption><b>Table 8 </b>MysqlInstanceNodeInfo</caption><thead align="left"><tr id="gaussdb_04_0006__row17216142412017"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.8.2.4.1.1"><p id="gaussdb_04_0006__p4217152417209">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_0006__p15217152442017">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_0006__p132171524152020">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_04_0006__row8216142412205"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="gaussdb_04_0006__p16217182414202">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="gaussdb_04_0006__p62181242200">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="gaussdb_04_0006__p192181424132017">DB instance ID.</p>
</td>
</tr>
<tr id="gaussdb_04_0006__row202161324132018"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="gaussdb_04_0006__p162186248200">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="gaussdb_04_0006__p2218724182011">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="gaussdb_04_0006__p1021892412207">Node name.</p>
</td>
</tr>
<tr id="gaussdb_04_0006__row162168249204"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="gaussdb_04_0006__p7218202422019">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="gaussdb_04_0006__p142181924102013">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="gaussdb_04_0006__p122184240207">Node type, which can be <strong id="gaussdb_04_0006__b17222165717554">master</strong> or <strong id="gaussdb_04_0006__b129871581553">slave</strong>.</p>
</td>
</tr>
<tr id="gaussdb_04_0006__row121652411207"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="gaussdb_04_0006__p221982452019">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="gaussdb_04_0006__p52198245200">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="gaussdb_04_0006__p021942462010">Node status.</p>
</td>
</tr>
<tr id="gaussdb_04_0006__row12168248202"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="gaussdb_04_0006__p13219122452011">port</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="gaussdb_04_0006__p18219724172020">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="gaussdb_04_0006__p19219142412205">Database port.</p>
</td>
</tr>
<tr id="gaussdb_04_0006__row02166244206"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="gaussdb_04_0006__p121962422019">private_read_ips</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="gaussdb_04_0006__p1921952416209">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="gaussdb_04_0006__p322072422019">Private IP address for read of the node.</p>
</td>
</tr>
<tr id="gaussdb_04_0006__row52166244206"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="gaussdb_04_0006__p422082422015">volume</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="gaussdb_04_0006__p1322011249207"><a href="#gaussdb_04_0006__response_MysqlInstanceNodeVolumeInfo">MysqlInstanceNodeVolumeInfo</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="gaussdb_04_0006__p5220142462012">Storage disk information.</p>
</td>
</tr>
<tr id="gaussdb_04_0006__row621692442010"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="gaussdb_04_0006__p9220724172016">az_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="gaussdb_04_0006__p132201724172011">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="gaussdb_04_0006__p19220324132018">AZ.</p>
</td>
</tr>
<tr id="gaussdb_04_0006__row18216142412019"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="gaussdb_04_0006__p522102452014">region_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="gaussdb_04_0006__p1222122472013">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="gaussdb_04_0006__p12211924122010">Region where the DB instance is located.</p>
</td>
</tr>
<tr id="gaussdb_04_0006__row17216112442019"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="gaussdb_04_0006__p1322116247201">created</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="gaussdb_04_0006__p72211324182017">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="gaussdb_04_0006__p22211824202020">Creation time in the "yyyy-mm-ddThh:mm:ssZ" format. <strong id="gaussdb_04_0006__b152882495279">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="gaussdb_04_0006__b1928824911276">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_0006__row19216182414209"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="gaussdb_04_0006__p9221132452013">updated</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="gaussdb_04_0006__p622172420207">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="gaussdb_04_0006__p14222192402013">Update time. The format is the same as that of the <strong id="gaussdb_04_0006__b63060484">created</strong> field. The value is empty unless the DB instance creation is complete.</p>
</td>
</tr>
<tr id="gaussdb_04_0006__row2061365818534"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="gaussdb_04_0006__p9530183120482">flavor_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="gaussdb_04_0006__p7530143117484">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="gaussdb_04_0006__p9530203120485">Specification ID.</p>
</td>
</tr>
<tr id="gaussdb_04_0006__row12216122420205"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="gaussdb_04_0006__p340710244203">flavor_ref</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="gaussdb_04_0006__p18407202412200">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="gaussdb_04_0006__p16407224122016">Specification code.</p>
</td>
</tr>
<tr id="gaussdb_04_0006__row3217524182012"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="gaussdb_04_0006__p240862422014">max_connections</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="gaussdb_04_0006__p140815249200">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="gaussdb_04_0006__p1440872482017">Maximum number of connections.</p>
</td>
</tr>
<tr id="gaussdb_04_0006__row1421710244205"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="gaussdb_04_0006__p140892422015">vcpus</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="gaussdb_04_0006__p8408162419200">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="gaussdb_04_0006__p84081824162013">Number of vCPUs.</p>
</td>
</tr>
<tr id="gaussdb_04_0006__row15217182432015"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="gaussdb_04_0006__p8408102492019">ram</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="gaussdb_04_0006__p12408152492011">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="gaussdb_04_0006__p7408324132017">Memory size in GB.</p>
</td>
</tr>
<tr id="gaussdb_04_0006__row02171524142013"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="gaussdb_04_0006__p24081824182011">need_restart</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="gaussdb_04_0006__p1740832462012">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="gaussdb_04_0006__p10408122442014">Whether to reboot the DB instance for the parameter modifications to take effect.</p>
</td>
</tr>
<tr id="gaussdb_04_0006__row921752492020"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="gaussdb_04_0006__p2040814242205">priority</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="gaussdb_04_0006__p2408182442019">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="gaussdb_04_0006__p1840814247209">Failover priority.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="gaussdb_04_0006__response_MysqlInstanceNodeVolumeInfo"></a><a name="response_MysqlInstanceNodeVolumeInfo"></a><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_04_0006__response_MysqlInstanceNodeVolumeInfo" frame="border" border="1" rules="all"><caption><b>Table 9 </b>MysqlInstanceNodeVolumeInfo</caption><thead align="left"><tr id="gaussdb_04_0006__row5224124202012"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.9.2.4.1.1"><p id="gaussdb_04_0006__p1740822414205">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_0006__p4408142419205">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_0006__p740882432012">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_04_0006__row12246241209"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="gaussdb_04_0006__p64084249208">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="gaussdb_04_0006__p14081824202018">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="gaussdb_04_0006__p144081524162010">Disk type.</p>
</td>
</tr>
<tr id="gaussdb_04_0006__row102247242201"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="gaussdb_04_0006__p64097246205">used</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="gaussdb_04_0006__p340919244206">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="gaussdb_04_0006__p1640918246207">Used disk size in GB.</p>
</td>
</tr>
<tr id="gaussdb_04_0006__row822422416205"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="gaussdb_04_0006__p74093244201">size</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="gaussdb_04_0006__p1409182418209">Long</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="gaussdb_04_0006__p104091524132013">Disk size of the yearly/monthly DB instance in GB</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="gaussdb_04_0006__response_MysqlTags"></a><a name="response_MysqlTags"></a><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_04_0006__response_MysqlTags" frame="border" border="1" rules="all"><caption><b>Table 10 </b>MysqlTags</caption><thead align="left"><tr id="gaussdb_04_0006__row1822612412204"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.10.2.4.1.1"><p id="gaussdb_04_0006__p140922442015">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.10.2.4.1.2"><p id="gaussdb_04_0006__p1840914246202">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.10.2.4.1.3"><p id="gaussdb_04_0006__p11409192411205">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_04_0006__row18226122411209"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.1 "><p id="gaussdb_04_0006__p4409132412203">key</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.2 "><p id="gaussdb_04_0006__p840932410207">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.10.2.4.1.3 "><p id="gaussdb_04_0006__p54097244205">Tag key. The value can contain a maximum of 36 Unicode characters. The value cannot be an empty string, a space, or left blank. Only uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_) are allowed.</p>
</td>
</tr>
<tr id="gaussdb_04_0006__row722614247205"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.1 "><p id="gaussdb_04_0006__p940962492015">value</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.2 "><p id="gaussdb_04_0006__p18409122418209">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.10.2.4.1.3 "><p id="gaussdb_04_0006__p104093246206">Tag value. It contains a maximum of 43 Unicode characters. The value can be an empty string. Only uppercase letters, lowercase letters, digits, periods (.), hyphens (-), and underscores (_) are allowed.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="gaussdb_04_0006__response_MysqlProxyInfo"></a><a name="response_MysqlProxyInfo"></a><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_04_0006__response_MysqlProxyInfo" frame="border" border="1" rules="all"><caption><b>Table 11 </b>MysqlProxyInfo</caption><thead align="left"><tr id="gaussdb_04_0006__row112271324202011"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.11.2.4.1.1"><p id="gaussdb_04_0006__p7409024192020">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_0006__p4409182462014">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_0006__p114091224122015">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_04_0006__row1222742414207"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.1 "><p id="gaussdb_04_0006__p74091524102013">pool_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.2 "><p id="gaussdb_04_0006__p134091724162014">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.11.2.4.1.3 "><p id="gaussdb_04_0006__p10409142422011">Proxy instance ID.</p>
</td>
</tr>
<tr id="gaussdb_04_0006__row1322711246208"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.1 "><p id="gaussdb_04_0006__p340917248206">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.2 "><p id="gaussdb_04_0006__p741072412205">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.11.2.4.1.3 "><p id="gaussdb_04_0006__p1241032432020">Proxy instance name.</p>
</td>
</tr>
<tr id="gaussdb_04_0006__row322752422017"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.1 "><p id="gaussdb_04_0006__p19410102411203">address</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.2 "><p id="gaussdb_04_0006__p1041018243204">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.11.2.4.1.3 "><p id="gaussdb_04_0006__p1041062412201">Proxy read/write splitting address.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="gaussdb_04_0006__p1410132452013"><strong id="gaussdb_04_0006__b8880184452718">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_04_0006__response_MysqlErrorResponse" frame="border" border="1" rules="all"><caption><b>Table 12 </b>Response body parameters</caption><thead align="left"><tr id="gaussdb_04_0006__row11229182442017"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.13.2.4.1.1"><p id="gaussdb_04_0006__p18410172452012">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_0006__p13410424132019">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_0006__p1241042422018">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_04_0006__row1522922492013"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.1 "><p id="gaussdb_04_0006__p541092452016">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.2 "><p id="gaussdb_04_0006__p54104248208">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.13.2.4.1.3 "><p id="gaussdb_04_0006__p1741017247207">Error code.</p>
</td>
</tr>
<tr id="gaussdb_04_0006__row1922912452018"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.1 "><p id="gaussdb_04_0006__p441032416205">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.2 "><p id="gaussdb_04_0006__p1541018242203">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.13.2.4.1.3 "><p id="gaussdb_04_0006__p10410142442016">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="gaussdb_04_0006__p7410102462015"><strong id="gaussdb_04_0006__b5772348132719">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_04_0006__table123013242209" frame="border" border="1" rules="all"><caption><b>Table 13 </b>Response body parameters</caption><thead align="left"><tr id="gaussdb_04_0006__row1023082420205"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.15.2.4.1.1"><p id="gaussdb_04_0006__p441072415206">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.15.2.4.1.2"><p id="gaussdb_04_0006__p1841012415207">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.15.2.4.1.3"><p id="gaussdb_04_0006__p14410824152020">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_04_0006__row1823022452011"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.15.2.4.1.1 "><p id="gaussdb_04_0006__p18410724112017">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.15.2.4.1.2 "><p id="gaussdb_04_0006__p104112024142013">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.15.2.4.1.3 "><p id="gaussdb_04_0006__p124111624182010">Error code.</p>
</td>
</tr>
<tr id="gaussdb_04_0006__row162318241205"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.15.2.4.1.1 "><p id="gaussdb_04_0006__p2411724132018">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.15.2.4.1.2 "><p id="gaussdb_04_0006__p1641115245202">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.15.2.4.1.3 "><p id="gaussdb_04_0006__p0411182418208">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="gaussdb_04_0006__section84111524122015"><h4 class="sectiontitle">Example Request</h4><p id="gaussdb_04_0006__p1341111246204">Querying instance details</p>
<pre class="screen" id="gaussdb_04_0006__screen84871444164418">GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/97b026aa9cc4417888c14c84a1ad9860/instances/436aaafb689c4250a9a5bb33cb271e8cin07</pre>
</div>
<div class="section" id="gaussdb_04_0006__section19411524112013"><h4 class="sectiontitle">Example Response</h4><p id="gaussdb_04_0006__p144116246204"><strong id="gaussdb_04_0006__b93781705282">Status code: 201</strong></p>
<p id="gaussdb_04_0006__p9411224122010">Success.</p>
<pre class="screen" id="gaussdb_04_0006__screen204991643121516">{
"instance" : {
"id" : "436aaafb689c4250a9a5bb33cb271e8cin07",
"name" : "taurusdb-instance01",
"alias" : "",
"status" : "ACTIVE",
"project_id" : "97b026aa9cc4417888c14c84a1ad9860",
"enterprise_project_id" : 0,
"type" : "Cluster",
"charge_info" : {
"charge_mode" : "postPaid",
"order_id" : ""
},
"node_count" : 2,
"datastore" : {
"type" : "gaussdb-mysql",
"version" : "8.0",
"kernel_version" : "2.0.29.1"
},
"created" : "2022-07-14T16:26:58+0800",
"updated" : "2022-07-18T14:20:33+0800",
"public_ips" : [ "10.154.219.187" ],
"private_write_ips" : [ "192.168.0.142" ],
"db_user_name" : "root",
"port" : 3306,
"vpc_id" : "3cedfc54-b105-4652-a4e0-847b11576b58",
"subnet_id" : "c1cfa53c-65d3-431e-8552-326bf310c7ad",
"security_group_id" : "fc577a1a-f202-424a-977f-24faec3fdd55",
"backup_strategy" : {
"start_time" : "19:00-20:00",
"keep_days" : 7
},
"nodes" : [ {
"id" : "799a0f2fa49a4151bf9f7063c1fbba36no07",
"name" : "taurusdb-d616-lb07_node01",
"type" : "master",
"status" : "ACTIVE",
"port" : 3306,
"private_read_ips" : [ "192.168.0.163" ],
"volume" : {
"type" : "POOL",
"used" : 0.07
},
"az_code" : "eu-de-01",
"region_code" : "eu-de",
"flavor_id" : "3169caaf-6c2f-41d5-aadd-c8fc3d83597e",
"flavor_ref" : "gaussdb.mysql.xlarge.x86.8",
"max_connections" : 10000,
"vcpus" : 4,
"ram" : 32,
"need_restart" : false,
"priority" : 1,
"created" : "2022-07-14T16:26:58+0800",
"updated" : "2022-07-18T09:24:18+0800"
}, {
"id" : "799a0f2fa49a4151bf9f7063c1fbba35no07",
"name" : "taurusdb-d616-lb07_node02",
"type" : "slave",
"status" : "ACTIVE",
"port" : 3306,
"private_read_ips" : [ "192.168.0.162" ],
"volume" : {
"type" : "POOL",
"used" : 0.07
},
"az_code" : "eu-de-01",
"region_code" : "eu-de",
"flavor_id" : "3169caaf-6c2f-41d5-aadd-c8fc3d83597e",
"flavor_ref" : "gaussdb.mysql.xlarge.x86.8",
"max_connections" : 10000,
"vcpus" : 4,
"ram" : 32,
"need_restart" : false,
"priority" : 1,
"created" : "2022-07-14T16:26:58+0800",
"updated" : "2022-07-18T09:36:18+0800"
} ],
"time_zone" : "UTC+08:00",
"backup_used_space" : 0.24,
"az_mode" : "single",
"master_az_code" : "eu-de-01",
"maintenance_window" : "18:00-22:00",
"tags" : [ ],
"configuration_id" : "53570e0de54e40c5a15f331aa5sd2176pr07",
"dedicated_resource_id" : "",
"proxies" : [ {
"pool_id" : "dab1cfc5150c4d1ca0e8c6596bfc0d8cpo01",
"address" : "192.168.10.76",
"name" : "proxy-name"
} ]
}
}</pre>
</div>
<div class="section" id="gaussdb_04_0006__section4778540915440"><h4 class="sectiontitle">Status Code</h4><p id="gaussdb_04_0006__p0723374409">For details, see <a href="gaussdb_10_0002.html">Status Codes</a>.</p>
</div>
<div class="section" id="gaussdb_04_0006__section946032144017"><h4 class="sectiontitle">Error Code</h4><p id="gaussdb_04_0006__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>