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_11_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

721 lines
52 KiB
HTML
Raw Blame History

<a name="gaussdb_11_0006"></a><a name="gaussdb_11_0006"></a>
<h1 class="topictitle1">Querying Details of a DB Instance</h1>
<div id="body8662426"><div class="section" id="gaussdb_11_0006__en-us_topic_0000001297344605_section44230431101549"><h4 class="sectiontitle">Function</h4><p id="gaussdb_11_0006__en-us_topic_0000001297344605_p1350220403353">This API is used to query the details of a specified DB instance. Before calling this API:</p>
<ul id="gaussdb_11_0006__en-us_topic_0000001297344605_ul924420236520"><li id="gaussdb_11_0006__en-us_topic_0000001267522832_en-us_topic_0000001250985350_li136356359522">Learn how to <a href="gaussdb_03_0001.html">authorize and authenticate</a> it.</li><li id="gaussdb_11_0006__en-us_topic_0000001267522832_en-us_topic_0000001250985350_li1991981933613">Obtain the required <a href="gaussdb_00_0003.html">region and endpoint</a>.</li></ul>
</div>
<div class="section" id="gaussdb_11_0006__en-us_topic_0000001297344605_section31729879101549"><h4 class="sectiontitle">URI</h4><ul id="gaussdb_11_0006__en-us_topic_0000001297344605_ul19983374101549"><li id="gaussdb_11_0006__en-us_topic_0000001297344605_li45632644101549">URI format<p id="gaussdb_11_0006__en-us_topic_0000001297344605_p8040618101549"><a name="gaussdb_11_0006__en-us_topic_0000001297344605_li45632644101549"></a><a name="en-us_topic_0000001297344605_li45632644101549"></a>GET https://{endpoint}/mysql/v3/{project_id}/instances/{instance_id}</p>
</li><li id="gaussdb_11_0006__en-us_topic_0000001297344605_li54691335131412">URI example<p id="gaussdb_11_0006__p1439511401536"><a name="gaussdb_11_0006__en-us_topic_0000001297344605_li54691335131412"></a><a name="en-us_topic_0000001297344605_li54691335131412"></a>GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/436aaafb689c4250a9a5bb33cb271e8cin07</p>
</li><li id="gaussdb_11_0006__en-us_topic_0000001297344605_li47310355101549">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0006__en-us_topic_0000001297344605_table23140016101549" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="gaussdb_11_0006__en-us_topic_0000001297344605_row27795795101549"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.2.2.3.1.2.5.1.1"><p id="gaussdb_11_0006__en-us_topic_0000001297344605_p36866898101549"><strong id="gaussdb_11_0006__en-us_topic_0000001297344605_b471785919390">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13%" id="mcps1.3.2.2.3.1.2.5.1.2"><p id="gaussdb_11_0006__en-us_topic_0000001297344605_p156174610411">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11%" id="mcps1.3.2.2.3.1.2.5.1.3"><p id="gaussdb_11_0006__en-us_topic_0000001297344605_p33428750101549">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="59%" id="mcps1.3.2.2.3.1.2.5.1.4"><p id="gaussdb_11_0006__en-us_topic_0000001297344605_p23374190101549"><strong id="gaussdb_11_0006__en-us_topic_0000001297344605_b1341817405">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_11_0006__en-us_topic_0000001297344605_row14261210101549"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.3.1.2.5.1.1 "><p id="gaussdb_11_0006__en-us_topic_0000001297344605_p104922035165518">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.2.3.1.2.5.1.2 "><p id="gaussdb_11_0006__en-us_topic_0000001297344605_p1956194615414">String</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.2.2.3.1.2.5.1.3 "><p id="gaussdb_11_0006__en-us_topic_0000001297344605_p18047737101549">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.2.2.3.1.2.5.1.4 "><p id="gaussdb_11_0006__en-us_topic_0000001297344605_p52580603101549">Project ID of a tenant in a region.</p>
<p id="gaussdb_11_0006__en-us_topic_0000001297344605_p16476914175718">To obtain this value, see <a href="gaussdb_10_0004.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
<tr id="gaussdb_11_0006__en-us_topic_0000001297344605_row197844933113"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.3.1.2.5.1.1 "><p id="gaussdb_11_0006__en-us_topic_0000001297344605_p156090206383">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.2.3.1.2.5.1.2 "><p id="gaussdb_11_0006__en-us_topic_0000001297344605_p36091220183819">String</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.2.2.3.1.2.5.1.3 "><p id="gaussdb_11_0006__en-us_topic_0000001297344605_p346994410599">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.2.2.3.1.2.5.1.4 "><p id="gaussdb_11_0006__en-us_topic_0000001297344605_p84691144145915">DB instance ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="gaussdb_11_0006__section69642465557"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0006__en-us_topic_0000001226443923_HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="gaussdb_11_0006__row19964204610552"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="gaussdb_11_0006__p1596534616551">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="gaussdb_11_0006__p696564615555">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="gaussdb_11_0006__p9965164614552">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="gaussdb_11_0006__p149651946145519">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_11_0006__row29642462555"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="gaussdb_11_0006__p996574613557">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="gaussdb_11_0006__p29651746135514">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="gaussdb_11_0006__p1196514665513">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="gaussdb_11_0006__p129651446135513">User token.</p>
</td>
</tr>
<tr id="gaussdb_11_0006__row59641946105510"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="gaussdb_11_0006__p209665468553">X-Language</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="gaussdb_11_0006__p209661146115510">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="gaussdb_11_0006__p16966134695515">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="gaussdb_11_0006__p109661346145514">Language.</p>
</td>
</tr>
<tr id="gaussdb_11_0006__row1627849183116"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="gaussdb_11_0006__p15665114311157">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="gaussdb_11_0006__p36651643101518">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="gaussdb_11_0006__p10665443181514">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="gaussdb_11_0006__p1866504318159">MIME type of the request body. You are advised to use the default value <strong id="gaussdb_11_0006__b158105824173539">application/json</strong>. For APIs used to upload objects or images, the value can vary depending on the flow type.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="gaussdb_11_0006__section12966134620552"><h4 class="sectiontitle">Response Parameters</h4><p id="gaussdb_11_0006__p1966164613558"><strong id="gaussdb_11_0006__b29187636273340">Status code: 201</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0006__en-us_topic_0000001226443923_response_MysqlInstanceInfo" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameter</caption><thead align="left"><tr id="gaussdb_11_0006__row0967114665519"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="gaussdb_11_0006__p296713462555">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="gaussdb_11_0006__p18967346135510">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="gaussdb_11_0006__p159670462554">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_11_0006__row1396754615559"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="gaussdb_11_0006__p7967446135513">instance</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="gaussdb_11_0006__p896764615520"><a href="#gaussdb_11_0006__en-us_topic_0000001226443923_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_11_0006__p196774610555">Instance information.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="gaussdb_11_0006__en-us_topic_0000001226443923_response_MysqlInstanceInfoDetail"></a><a name="en-us_topic_0000001226443923_response_MysqlInstanceInfoDetail"></a><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0006__en-us_topic_0000001226443923_response_MysqlInstanceInfoDetail" frame="border" border="1" rules="all"><caption><b>Table 4 </b>MysqlInstanceInfoDetail</caption><thead align="left"><tr id="gaussdb_11_0006__row119688461554"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="gaussdb_11_0006__p169691446125511">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="gaussdb_11_0006__p3969154617551">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="gaussdb_11_0006__p0969134655516">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_11_0006__row1968124611556"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0006__p1596974605510">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0006__p09691846115510">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0006__p4969246135516">DB instance ID.</p>
</td>
</tr>
<tr id="gaussdb_11_0006__row1296834617552"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0006__p4969194635512">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0006__p15969246185513">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0006__p15969194615516">DB instance name.</p>
</td>
</tr>
<tr id="gaussdb_11_0006__row3968846115519"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0006__p69691469553">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0006__p17970124655512">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0006__p17970124619554">Project ID of a tenant in a region.</p>
</td>
</tr>
<tr id="gaussdb_11_0006__row1968946115512"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0006__p17970246145510">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0006__p1597020466550">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0006__p101121723135611">DB instance status. Values:</p>
<p id="gaussdb_11_0006__p824963112562">If the value is <strong id="gaussdb_11_0006__en-us_topic_0000001297344605_b28194471546">BUILD</strong>, the DB instance is being created.</p>
<p id="gaussdb_11_0006__p1268683218563">If the value is <strong id="gaussdb_11_0006__en-us_topic_0000001297344605_b628114559418">ACTIVE</strong>, the DB instance is normal.</p>
<p id="gaussdb_11_0006__p821913455616">If the value is <strong id="gaussdb_11_0006__en-us_topic_0000001297344605_b1534711457">FAILED</strong>, the DB instance is abnormal.</p>
<p id="gaussdb_11_0006__p7861935185615">If the value is <strong id="gaussdb_11_0006__en-us_topic_0000001297344605_b2681942057">FROZEN</strong>, the DB instance is frozen.</p>
<p id="gaussdb_11_0006__p1645313885619">If the value is <strong id="gaussdb_11_0006__en-us_topic_0000001297344605_b31408720514">MODIFYING</strong>, the DB instance is being scaled up.</p>
<p id="gaussdb_11_0006__p21722044175619">If the value is <strong id="gaussdb_11_0006__en-us_topic_0000001297344605_b981214141356">REBOOTING</strong>, the DB instance is being rebooted.</p>
<p id="gaussdb_11_0006__p16514194665614">If the value is <strong id="gaussdb_11_0006__en-us_topic_0000001297344605_b19631817454">RESTORING</strong>, the DB instance is being restored.</p>
<p id="gaussdb_11_0006__p1323914913561">If the value is <strong id="gaussdb_11_0006__en-us_topic_0000001297344605_b1351872019516">MODIFYING INSTANCE TYPE</strong>, the DB instance is changing from primary to standby.</p>
<p id="gaussdb_11_0006__p1245716515562">If the value is <strong id="gaussdb_11_0006__en-us_topic_0000001297344605_b1148214486276">SWITCHOVER</strong>, the primary/standby switchover is being performed.</p>
<p id="gaussdb_11_0006__p2618145445612">If the value is <strong id="gaussdb_11_0006__en-us_topic_0000001297344605_b3420101768">MIGRATING</strong>, the DB instance is being migrated.</p>
<p id="gaussdb_11_0006__p112171356145619">If the value is <strong id="gaussdb_11_0006__en-us_topic_0000001297344605_b39023513611">BACKING UP</strong>, the DB instance is being backed up.</p>
<p id="gaussdb_11_0006__p6999158165616">If the value is <strong id="gaussdb_11_0006__en-us_topic_0000001297344605_b9200581961">MODIFYING DATABASE PORT</strong>, the database port is being changed.</p>
<p id="gaussdb_11_0006__p69704462558">If the value is <strong id="gaussdb_11_0006__b20400153873539">STORAGE FULL</strong>, the instance storage space is full.</p>
</td>
</tr>
<tr id="gaussdb_11_0006__row896812466553"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0006__p1597014615517">port</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0006__p1797094619555">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0006__p16970164615555">Database port.</p>
</td>
</tr>
<tr id="gaussdb_11_0006__row59689467553"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0006__p1897054605519">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0006__p1970346175515">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0006__p139701846125513">Instance type. The value is <strong id="gaussdb_11_0006__b200515274873539">Cluster</strong>.</p>
</td>
</tr>
<tr id="gaussdb_11_0006__row15968144613551"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0006__p17970104675515">node_count</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0006__p19971446155519">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0006__p15971846105516">Number of nodes.</p>
</td>
</tr>
<tr id="gaussdb_11_0006__row1968346165514"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0006__p189711346145518">datastore</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0006__p13971446185510"><a href="#gaussdb_11_0006__en-us_topic_0000001226443923_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_11_0006__p13971846195515">Database information.</p>
</td>
</tr>
<tr id="gaussdb_11_0006__row1796884625514"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0006__p397134685517">backup_used_space</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0006__p597134645512">Double</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0006__p897116469558">Used backup space in GB.</p>
</td>
</tr>
<tr id="gaussdb_11_0006__row7968154605516"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0006__p39711546185515">created</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0006__p4971114665515">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0006__p11971204610555">Creation time in the "yyyy-mm-ddThh:mm:ssZ" format. <strong id="gaussdb_11_0006__b75102513310">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="gaussdb_11_0006__b135161151035">Z</strong> indicates the time zone offset. The value is empty unless the instance creation is complete.</p>
</td>
</tr>
<tr id="gaussdb_11_0006__row18968144675514"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0006__p2972154618551">updated</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0006__p159728468555">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0006__p497324695512">Update time. The format is the same as that of the <strong id="gaussdb_11_0006__en-us_topic_0000001297344605_b12339824971">created</strong> field. The value is empty unless the instance creation is complete.</p>
</td>
</tr>
<tr id="gaussdb_11_0006__row49680469556"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0006__p109731746185511">private_write_ips</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0006__p0973204675512">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0006__p1197364610555">Private IP address for write.</p>
</td>
</tr>
<tr id="gaussdb_11_0006__row996813462552"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0006__p129731346115514">public_ips</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0006__p897374685517">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0006__p14973104610557">Public IP address of the instance.</p>
</td>
</tr>
<tr id="gaussdb_11_0006__row29681746165518"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0006__p6973146175517">db_user_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0006__p1497344615511">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0006__p6973446195520">Default username.</p>
</td>
</tr>
<tr id="gaussdb_11_0006__row0968446125512"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0006__p4974146145518">vpc_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0006__p7974114655513">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0006__p497414615516">VPC ID.</p>
</td>
</tr>
<tr id="gaussdb_11_0006__row696816469557"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0006__p29749469557">subnet_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0006__p897414466557">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0006__p109746464555">Network ID of the subnet.</p>
</td>
</tr>
<tr id="gaussdb_11_0006__row15968946155520"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0006__p179740468555">security_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0006__p16974114615519">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0006__p9974546155514">Security group ID.</p>
</td>
</tr>
<tr id="gaussdb_11_0006__row11968174645517"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0006__p13974124665511">configuration_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0006__p297424655515">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0006__p0975154618551">ID of the parameter template used for creating an instance or ID of the latest parameter template that is applied to an instance.</p>
</td>
</tr>
<tr id="gaussdb_11_0006__row109681646105511"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0006__p297554614555">backup_strategy</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0006__p1297513462558"><a href="#gaussdb_11_0006__en-us_topic_0000001226443923_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_11_0006__p3975246105512">Backup policy.</p>
</td>
</tr>
<tr id="gaussdb_11_0006__row2096854605514"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0006__p1797574615510">nodes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0006__p197524625514">Array of <a href="#gaussdb_11_0006__en-us_topic_0000001226443923_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_11_0006__p1976104611552">Node information.</p>
</td>
</tr>
<tr id="gaussdb_11_0006__row696834675513"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0006__p1297634620553">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0006__p189769464550">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0006__p197611466555">Enterprise project ID.</p>
</td>
</tr>
<tr id="gaussdb_11_0006__row1696804665517"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0006__p1297624645515">time_zone</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0006__p997619463558">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0006__p99761046185514">Time zone.</p>
</td>
</tr>
<tr id="gaussdb_11_0006__row796884611557"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0006__p69762465552">az_mode</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0006__p89761346175517">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0006__p69771946165513">AZ type. It can be <strong id="gaussdb_11_0006__en-us_topic_0000001297344605_b1786294116170">single</strong> or <strong id="gaussdb_11_0006__en-us_topic_0000001297344605_b58621441121717">multi</strong>.</p>
</td>
</tr>
<tr id="gaussdb_11_0006__row996814611558"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0006__p11977164645510">master_az_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0006__p8977946165513">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0006__p1297734645513">Primary AZ.</p>
</td>
</tr>
<tr id="gaussdb_11_0006__row596816462552"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0006__p5977134620554">maintenance_window</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0006__p10977946205517">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0006__p1697719462559">Maintenance window in the UTC format.</p>
</td>
</tr>
<tr id="gaussdb_11_0006__row199681646115512"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0006__p1497724675515">tags</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0006__p6977546145512">Array of <a href="#gaussdb_11_0006__en-us_topic_0000001226443923_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_11_0006__p1597754645517">Tags for managing instances.</p>
</td>
</tr>
<tr id="gaussdb_11_0006__row796894612558"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0006__p189771546105520">dedicated_resource_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0006__p897819468558">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0006__p3978204675514">Dedicated resource pool ID. This parameter is returned only when the instance belongs to a dedicated resource pool.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="gaussdb_11_0006__en-us_topic_0000001226443923_response_MysqlDatastore"></a><a name="en-us_topic_0000001226443923_response_MysqlDatastore"></a><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0006__en-us_topic_0000001226443923_response_MysqlDatastore" frame="border" border="1" rules="all"><caption><b>Table 5 </b>MysqlDatastore</caption><thead align="left"><tr id="gaussdb_11_0006__row15978134695513"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="gaussdb_11_0006__p13978204655510">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="gaussdb_11_0006__p169781946175516">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="gaussdb_11_0006__p13978346135511">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_11_0006__row2097819467558"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="gaussdb_11_0006__p119782046195517">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="gaussdb_11_0006__p209791746165511">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="gaussdb_11_0006__p16979154675511">DB engine. Currently, only gaussdb-mysql is supported.</p>
</td>
</tr>
<tr id="gaussdb_11_0006__row14978164618551"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="gaussdb_11_0006__p17979146105519">version</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="gaussdb_11_0006__p7979114625515">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="gaussdb_11_0006__p9979246185511">DB version.</p>
</td>
</tr>
<tr id="gaussdb_11_0006__row4765449111015"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="gaussdb_11_0006__p422545811237">kernel_version</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="gaussdb_11_0006__p22254581234">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="gaussdb_11_0006__p1622665818239">Database kernel version.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="gaussdb_11_0006__response_MysqlVolumeInfo"></a><a name="response_MysqlVolumeInfo"></a><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0006__response_MysqlVolumeInfo" frame="border" border="1" rules="all"><caption><b>Table 6 </b>MysqlInatanceNodeVolumeInfo</caption><thead align="left"><tr id="gaussdb_11_0006__row1142631311717"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.1"><p id="gaussdb_11_0006__p942610131871">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.2"><p id="gaussdb_11_0006__p164261313478">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.6.2.4.1.3"><p id="gaussdb_11_0006__p34263139713">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_11_0006__row8426413673"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="gaussdb_11_0006__p1742718131479">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="gaussdb_11_0006__p10427191314716">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="gaussdb_11_0006__p1242716131172">Disk type.</p>
</td>
</tr>
<tr id="gaussdb_11_0006__row642613138715"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="gaussdb_11_0006__p192982741719">used</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="gaussdb_11_0006__p4427121316711">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="gaussdb_11_0006__p542717131477">Used disk size in GB.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="gaussdb_11_0006__en-us_topic_0000001226443923_response_MysqlBackupStrategy"></a><a name="en-us_topic_0000001226443923_response_MysqlBackupStrategy"></a><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0006__en-us_topic_0000001226443923_response_MysqlBackupStrategy" frame="border" border="1" rules="all"><caption><b>Table 7 </b>MysqlBackupStrategy</caption><thead align="left"><tr id="gaussdb_11_0006__row4980154610554"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.1"><p id="gaussdb_11_0006__p398119460554">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.2"><p id="gaussdb_11_0006__p6981144614551">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.7.2.4.1.3"><p id="gaussdb_11_0006__p1398120465553">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_11_0006__row6981154675519"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="gaussdb_11_0006__p198110463557">start_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="gaussdb_11_0006__p10981124645510">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="gaussdb_11_0006__p189811746195516">Automated backup start time. The automated backup will be triggered within one hour after the time specified by this parameter.</p>
</td>
</tr>
<tr id="gaussdb_11_0006__row998134617557"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="gaussdb_11_0006__p149822466559">keep_days</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="gaussdb_11_0006__p698212465554">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="gaussdb_11_0006__p3141138182619">Backup retention days.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="gaussdb_11_0006__en-us_topic_0000001226443923_response_MysqlInstanceNodeInfo"></a><a name="en-us_topic_0000001226443923_response_MysqlInstanceNodeInfo"></a><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0006__en-us_topic_0000001226443923_response_MysqlInstanceNodeInfo" frame="border" border="1" rules="all"><caption><b>Table 8 </b>MysqlInstanceNodeInfo</caption><thead align="left"><tr id="gaussdb_11_0006__row19982194610553"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.8.2.4.1.1"><p id="gaussdb_11_0006__p798374614556">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.8.2.4.1.2"><p id="gaussdb_11_0006__p2983946185516">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.8.2.4.1.3"><p id="gaussdb_11_0006__p2983346205515">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_11_0006__row13982046125516"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="gaussdb_11_0006__p89837461557">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="gaussdb_11_0006__p14983134605515">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="gaussdb_11_0006__p6983164615518">DB instance ID.</p>
</td>
</tr>
<tr id="gaussdb_11_0006__row198210467550"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="gaussdb_11_0006__p13983154665512">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="gaussdb_11_0006__p149835465551">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="gaussdb_11_0006__p59831946185517">Node name.</p>
</td>
</tr>
<tr id="gaussdb_11_0006__row1982144620558"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="gaussdb_11_0006__p798444618558">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="gaussdb_11_0006__p798416468557">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="gaussdb_11_0006__p11984194615517">Node type, which can be <strong id="gaussdb_11_0006__en-us_topic_0000001297344605_b17222165717554">master</strong> or <strong id="gaussdb_11_0006__en-us_topic_0000001297344605_b129871581553">slave</strong>.</p>
</td>
</tr>
<tr id="gaussdb_11_0006__row1798284665513"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="gaussdb_11_0006__p1298434610555">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="gaussdb_11_0006__p698414615519">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="gaussdb_11_0006__p49841746115511">Node status.</p>
</td>
</tr>
<tr id="gaussdb_11_0006__row129821462552"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="gaussdb_11_0006__p99841346145510">port</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="gaussdb_11_0006__p179847462559">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="gaussdb_11_0006__p4984124612558">Database port.</p>
</td>
</tr>
<tr id="gaussdb_11_0006__row119823463551"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="gaussdb_11_0006__p798554611557">private_read_ips</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="gaussdb_11_0006__p1498524615512">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="gaussdb_11_0006__p9985154620556">Private IP address for read of the node.</p>
</td>
</tr>
<tr id="gaussdb_11_0006__row12982104615558"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="gaussdb_11_0006__p1198564616550">volume</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="gaussdb_11_0006__p198524645513"><a href="#gaussdb_11_0006__response_MysqlVolumeInfo">Table 6</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="gaussdb_11_0006__p5985114695510">Storage disk information.</p>
</td>
</tr>
<tr id="gaussdb_11_0006__row1898284625511"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="gaussdb_11_0006__p8985154685517">az_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="gaussdb_11_0006__p12985154613559">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="gaussdb_11_0006__p598564612553">AZ.</p>
</td>
</tr>
<tr id="gaussdb_11_0006__row0982146205512"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="gaussdb_11_0006__p7985846145510">region_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="gaussdb_11_0006__p118724719552">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="gaussdb_11_0006__p1087104715550">Region where the instance is located.</p>
</td>
</tr>
<tr id="gaussdb_11_0006__row798218465551"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="gaussdb_11_0006__p387134710554">created</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="gaussdb_11_0006__p208724711555">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="gaussdb_11_0006__p1587154713552">DB instance creation time.</p>
</td>
</tr>
<tr id="gaussdb_11_0006__row39822046135518"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="gaussdb_11_0006__p1287114717556">updated</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="gaussdb_11_0006__p687164716550">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="gaussdb_11_0006__p108714715558">Update time.</p>
</td>
</tr>
<tr id="gaussdb_11_0006__row298264635513"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="gaussdb_11_0006__p18713477557">flavor_ref</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="gaussdb_11_0006__p787154711557">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="gaussdb_11_0006__p3873471558">Specification code.</p>
</td>
</tr>
<tr id="gaussdb_11_0006__row1982346135510"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="gaussdb_11_0006__p20871547115517">max_connections</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="gaussdb_11_0006__p8875478554">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="gaussdb_11_0006__p1787194795510">Maximum number of connections.</p>
</td>
</tr>
<tr id="gaussdb_11_0006__row398224610557"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="gaussdb_11_0006__p88714718559">vcpus</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="gaussdb_11_0006__p14871747145516">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="gaussdb_11_0006__p6882479556">Number of vCPUs.</p>
</td>
</tr>
<tr id="gaussdb_11_0006__row5982134675516"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="gaussdb_11_0006__p68811472555">ram</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="gaussdb_11_0006__p68894745519">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="gaussdb_11_0006__p15887473558">Memory size in GB.</p>
</td>
</tr>
<tr id="gaussdb_11_0006__row4982124612554"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="gaussdb_11_0006__p8881547185518">need_restart</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="gaussdb_11_0006__p38816473556">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="gaussdb_11_0006__p108811479557">Whether to reboot the instance for the parameter modifications to take effect.</p>
</td>
</tr>
<tr id="gaussdb_11_0006__row189824463550"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="gaussdb_11_0006__p188847135514">priority</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="gaussdb_11_0006__p1188184710556">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="gaussdb_11_0006__p1488184710555">Failover priority.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="gaussdb_11_0006__en-us_topic_0000001226443923_response_MysqlTags"></a><a name="en-us_topic_0000001226443923_response_MysqlTags"></a><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0006__en-us_topic_0000001226443923_response_MysqlTags" frame="border" border="1" rules="all"><caption><b>Table 9 </b>MysqlTags</caption><thead align="left"><tr id="gaussdb_11_0006__row4988114605513"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.9.2.4.1.1"><p id="gaussdb_11_0006__p98994712550">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.9.2.4.1.2"><p id="gaussdb_11_0006__p189194745513">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.9.2.4.1.3"><p id="gaussdb_11_0006__p1989134710556">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_11_0006__row99882046145518"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="gaussdb_11_0006__p168924715518">key</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="gaussdb_11_0006__p18899476554">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="gaussdb_11_0006__p38944755514">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_11_0006__row179884466559"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="gaussdb_11_0006__p188944755519">value</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="gaussdb_11_0006__p4895473551">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="gaussdb_11_0006__p48913476556">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>
<p id="gaussdb_11_0006__p78914713559"><strong id="gaussdb_11_0006__b184332395072451">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0006__en-us_topic_0000001226443923_response_MysqlErrorResponse" frame="border" border="1" rules="all"><caption><b>Table 10 </b>Response body parameters</caption><thead align="left"><tr id="gaussdb_11_0006__row8989154616555"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.11.2.4.1.1"><p id="gaussdb_11_0006__p14891647145517">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.11.2.4.1.2"><p id="gaussdb_11_0006__p1989647105513">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.11.2.4.1.3"><p id="gaussdb_11_0006__p789164719559">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_11_0006__row2989046165511"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.1 "><p id="gaussdb_11_0006__p188917471553">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.2 "><p id="gaussdb_11_0006__p989047125510">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.11.2.4.1.3 "><p id="gaussdb_11_0006__p158964705511">Error code.</p>
</td>
</tr>
<tr id="gaussdb_11_0006__row1898916461553"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.1 "><p id="gaussdb_11_0006__p7891347175520">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.2 "><p id="gaussdb_11_0006__p88910478556">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.11.2.4.1.3 "><p id="gaussdb_11_0006__p128974712551">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="gaussdb_11_0006__p1589174735513"><strong id="gaussdb_11_0006__b185438558463958">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0006__table119906465551" frame="border" border="1" rules="all"><caption><b>Table 11 </b>Response body parameters</caption><thead align="left"><tr id="gaussdb_11_0006__row17990446205518"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.13.2.4.1.1"><p id="gaussdb_11_0006__p178944765520">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.13.2.4.1.2"><p id="gaussdb_11_0006__p168924715513">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.13.2.4.1.3"><p id="gaussdb_11_0006__p189114710559">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_11_0006__row799020467559"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.1 "><p id="gaussdb_11_0006__p1889647175512">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.2 "><p id="gaussdb_11_0006__p1089947175511">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.13.2.4.1.3 "><p id="gaussdb_11_0006__p8896474554">Error code.</p>
</td>
</tr>
<tr id="gaussdb_11_0006__row199901346155515"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.1 "><p id="gaussdb_11_0006__p1189124711552">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.2 "><p id="gaussdb_11_0006__p2891047105519">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.13.2.4.1.3 "><p id="gaussdb_11_0006__p889144715514">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="gaussdb_11_0006__section1989154716550"><h4 class="sectiontitle">Example Request</h4><p id="gaussdb_11_0006__p128910477557">Querying details of a DB instance</p>
<pre class="screen" id="gaussdb_11_0006__screen2853197185320">GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/d2cda7b97a39488e8b30e3cea4066204in07</pre>
</div>
<div class="section" id="gaussdb_11_0006__section7891847155518"><h4 class="sectiontitle">Example Response</h4><p id="gaussdb_11_0006__p58920473558"><strong id="gaussdb_11_0006__b60568813773340">Status code: 201</strong></p>
<p id="gaussdb_11_0006__p5891547175516">Success.</p>
<pre class="screen" id="gaussdb_11_0006__screen1889147175511">{
"instance": {
"id": "d2cda7b97a39488e8b30e3cea4066204in07",
"name": "taurusdb-d616-lb07",
"status": "ACTIVE",
"project_id": "053f533ead80d5102f0cc012e8d468a4",
"enterprise_project_id": "0",
"type": "Cluster",
"charge_info": {
"charge_mode": "postPaid",
"order_id": ""
},
"node_count": 2,
"datastore": {
"type": "gaussdb-mysql",
"version": "8.0"
},
"created": "2020-07-21T09:13:56+0200",
"updated": "2020-07-21T09:27:54+0200",
"public_ips": "",
"private_write_ips": [
"192.168.0.235"
],
"db_user_name": "root",
"port": "3306",
"vpc_id": "f7ee62e2-9705-4523-ba49-a85ea1a1fa87",
"subnet_id": "140af7bf-a9da-4dcf-8837-34199fd6d186",
"security_group_id": "c7f69884-fe2b-4630-8114-70a11499d902",
"backup_strategy": {
"start_time": "00:00-00:00",
"keep_days": "0"
},
"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.0"
},
"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": null,
"vcpus": "4",
"ram": "32",
"need_restart": false,
"priority": 1
},
{
"id": "816459d771c444db9fa4c1d5c173cb1cno07",
"name": "taurusdb-d616-lb07_node02",
"type": "slave",
"status": "ACTIVE",
"port": 3306,
"private_read_ips": [
"192.168.0.160"
],
"volume": {
"type": "POOL",
"used": "0.0"
},
"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": null,
"vcpus": "4",
"ram": "32",
"need_restart": false,
"priority": 1
}
],
"time_zone": "UTC+08:00",
"backup_used_space": 0,
"az_mode": "single",
"master_az_code": "eu-de-01",
"maintenance_window": "18:00-22:00"
}
}</pre>
</div>
<div class="section" id="gaussdb_11_0006__section4778540915440"><h4 class="sectiontitle">Status Code</h4><p id="gaussdb_11_0006__p0723374409">For details, see <a href="gaussdb_10_0002.html">Status Codes</a>.</p>
</div>
<div class="section" id="gaussdb_11_0006__section2557116171718"><h4 class="sectiontitle">Error Code</h4><p id="gaussdb_11_0006__p855716160178">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_11_0003.html">Instance Management</a></div>
</div>
</div>
View Git Blame Copy Permalink