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_0005.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

634 lines
50 KiB
HTML
Raw Blame History

<a name="gaussdb_11_0005"></a><a name="gaussdb_11_0005"></a>
<h1 class="topictitle1">Querying DB Instances</h1>
<div id="body8662426"><div class="section" id="gaussdb_11_0005__en-us_topic_0000001297344601_section44230431101549"><h4 class="sectiontitle">Function</h4><p id="gaussdb_11_0005__en-us_topic_0000001297344601_p1350220403353">This API is used to query instances according to search criteria. Before calling this API:</p>
<ul id="gaussdb_11_0005__en-us_topic_0000001297344601_ul924420236520"><li id="gaussdb_11_0005__en-us_topic_0000001250985350_li136356359522">Learn how to <a href="gaussdb_03_0001.html">authorize and authenticate</a> it.</li><li id="gaussdb_11_0005__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_0005__en-us_topic_0000001297344601_section31729879101549"><h4 class="sectiontitle">URI</h4><ul id="gaussdb_11_0005__en-us_topic_0000001297344601_ul19983374101549"><li id="gaussdb_11_0005__en-us_topic_0000001297344601_li45632644101549">URI format<p id="gaussdb_11_0005__en-us_topic_0000001297344601_p8040618101549"><a name="gaussdb_11_0005__en-us_topic_0000001297344601_li45632644101549"></a><a name="en-us_topic_0000001297344601_li45632644101549"></a>GET https://{endpoint}/mysql/v3/{project_id}/instances?id={id}&amp;name={name}&amp;type={type}&amp;datastore_type={datastore_type}&amp;vpc_id={vpc_id}&amp;subnet_id={subnet_id}&amp;offset={offset}&amp;limit={limit}</p>
</li><li id="gaussdb_11_0005__en-us_topic_0000001297344601_li54691335131412">URI example<p id="gaussdb_11_0005__p69316282316"><a name="gaussdb_11_0005__en-us_topic_0000001297344601_li54691335131412"></a><a name="en-us_topic_0000001297344601_li54691335131412"></a>GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances?id=ed7cc6166ec24360a5ed5c5c9c2ed726in01&amp;name=hy&amp;type=Cluster&amp;datastore_type=gaussdb-mysql&amp;vpc_id=19e5d45d-70fd-4a91-87e9-b27e71c9891f&amp;subnet_id=bd51fb45-2dcb-4296-8783-8623bfe89bb7&amp;offset=0&amp;limit=10</p>
</li><li id="gaussdb_11_0005__en-us_topic_0000001297344601_li47310355101549">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0005__en-us_topic_0000001297344601_table23140016101549" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="gaussdb_11_0005__en-us_topic_0000001297344601_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_0005__en-us_topic_0000001297344601_p36866898101549"><strong id="gaussdb_11_0005__en-us_topic_0000001297344601_b1296923713513">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_0005__en-us_topic_0000001297344601_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_0005__en-us_topic_0000001297344601_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_0005__en-us_topic_0000001297344601_p23374190101549"><strong id="gaussdb_11_0005__en-us_topic_0000001297344601_b23501539185116">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_11_0005__en-us_topic_0000001297344601_row14261210101549"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.3.1.2.5.1.1 "><p id="gaussdb_11_0005__en-us_topic_0000001297344601_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_0005__en-us_topic_0000001297344601_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_0005__en-us_topic_0000001297344601_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_0005__en-us_topic_0000001297344601_p52580603101549">Project ID of a tenant in a region.</p>
<p id="gaussdb_11_0005__en-us_topic_0000001297344601_p16476914175718">To obtain this value, see <a href="gaussdb_10_0004.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
<tr id="gaussdb_11_0005__en-us_topic_0000001297344601_row197844933113"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.3.1.2.5.1.1 "><p id="gaussdb_11_0005__en-us_topic_0000001297344601_p84691445594">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_0005__en-us_topic_0000001297344601_p8572046164115">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_0005__en-us_topic_0000001297344601_p346994410599">No</p>
</td>
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.2.2.3.1.2.5.1.4 "><p id="gaussdb_11_0005__en-us_topic_0000001297344601_p84691144145915">DB instance ID.</p>
<p id="gaussdb_11_0005__en-us_topic_0000001297344601_p1369222017578">The asterisk (*) is reserved for the system. If the instance ID starts with an asterisk (*), the value following asterisk (*) is used for fuzzy matching. Otherwise, the instance ID is used for exact matching.</p>
</td>
</tr>
<tr id="gaussdb_11_0005__en-us_topic_0000001297344601_row2489615125917"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.3.1.2.5.1.1 "><p id="gaussdb_11_0005__en-us_topic_0000001297344601_p16469194410599">name</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.2.3.1.2.5.1.2 "><p id="gaussdb_11_0005__en-us_topic_0000001297344601_p857164618412">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_0005__en-us_topic_0000001297344601_p6469124415911">No</p>
</td>
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.2.2.3.1.2.5.1.4 "><p id="gaussdb_11_0005__en-us_topic_0000001297344601_p946944412596">DB instance name.</p>
<p id="gaussdb_11_0005__en-us_topic_0000001297344601_p11563926175714">The asterisk (*) is reserved for the system. If the instance name starts with an asterisk (*), the value following asterisk (*) is used for fuzzy matching. Otherwise, the instance name is used for exact matching.</p>
</td>
</tr>
<tr id="gaussdb_11_0005__en-us_topic_0000001297344601_row1525110198591"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.3.1.2.5.1.1 "><p id="gaussdb_11_0005__en-us_topic_0000001297344601_p1773813251016">type</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.2.3.1.2.5.1.2 "><p id="gaussdb_11_0005__en-us_topic_0000001297344601_p15734616412">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_0005__en-us_topic_0000001297344601_p12738925418">No</p>
</td>
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.2.2.3.1.2.5.1.4 "><p id="gaussdb_11_0005__en-us_topic_0000001297344601_p573892515118">DB instance type to be queried. Currently, only the cluster type is supported.</p>
</td>
</tr>
<tr id="gaussdb_11_0005__en-us_topic_0000001297344601_row4676255803"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.3.1.2.5.1.1 "><p id="gaussdb_11_0005__en-us_topic_0000001297344601_p135955121367">datastore_type</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.2.3.1.2.5.1.2 "><p id="gaussdb_11_0005__en-us_topic_0000001297344601_p95951612169">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_0005__en-us_topic_0000001297344601_p373812511115">No</p>
</td>
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.2.2.3.1.2.5.1.4 "><p id="gaussdb_11_0005__en-us_topic_0000001297344601_p1940993541716">DB type. Currently, only gaussdb-mysql is supported.</p>
</td>
</tr>
<tr id="gaussdb_11_0005__en-us_topic_0000001297344601_row391114581019"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.3.1.2.5.1.1 "><p id="gaussdb_11_0005__en-us_topic_0000001297344601_p873811251313">vpc_id</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.2.3.1.2.5.1.2 "><p id="gaussdb_11_0005__en-us_topic_0000001297344601_p75794618416">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_0005__en-us_topic_0000001297344601_p147381257113">No</p>
</td>
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.2.2.3.1.2.5.1.4 "><p id="gaussdb_11_0005__en-us_topic_0000001297344601_p87381125112">VPC ID.</p>
<ul id="gaussdb_11_0005__en-us_topic_0000001297344601_ul475921618452"><li id="gaussdb_11_0005__en-us_topic_0000001297344601_en-us_topic_0128427213_li67651171359">Method 1: Log in to the VPC console and view the VPC ID on the VPC details page.</li><li id="gaussdb_11_0005__en-us_topic_0000001297344601_en-us_topic_0128427213_li948317405377">Method 2: See "Querying VPCs" in the <em id="gaussdb_11_0005__i202581651161310">Virtual Private Cloud API Reference</em>.</li></ul>
</td>
</tr>
<tr id="gaussdb_11_0005__en-us_topic_0000001297344601_row57790155118"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.3.1.2.5.1.1 "><p id="gaussdb_11_0005__en-us_topic_0000001297344601_p173811251019">subnet_id</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.2.3.1.2.5.1.2 "><p id="gaussdb_11_0005__en-us_topic_0000001297344601_p1757194617418">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_0005__en-us_topic_0000001297344601_p073882514117">No</p>
</td>
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.2.2.3.1.2.5.1.4 "><p id="gaussdb_11_0005__en-us_topic_0000001297344601_p7738172511118">Network ID of the subnet.</p>
<ul id="gaussdb_11_0005__en-us_topic_0000001297344601_ul375971611456"><li id="gaussdb_11_0005__en-us_topic_0000001297344601_en-us_topic_0128427213_li121534277395">Method 1: Log in to the VPC console and click the target subnet on the <strong id="gaussdb_11_0005__b1955512611144">Subnets</strong> page. You can view the network ID on the displayed page.</li><li id="gaussdb_11_0005__en-us_topic_0000001297344601_en-us_topic_0128427213_li073418475515">Method 2: See section "Querying Subnets" under "APIs" or section "Querying Networks" under "OpenStack Neutron APIs" in the <em id="gaussdb_11_0005__i73231147201414">Virtual Private Cloud API Reference</em>.</li></ul>
</td>
</tr>
<tr id="gaussdb_11_0005__en-us_topic_0000001297344601_row378505943118"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.3.1.2.5.1.1 "><p id="gaussdb_11_0005__en-us_topic_0000001297344601_p18469644135918">offset</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.2.3.1.2.5.1.2 "><p id="gaussdb_11_0005__en-us_topic_0000001297344601_p20571146174113">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.2.2.3.1.2.5.1.3 "><p id="gaussdb_11_0005__en-us_topic_0000001297344601_p64691544165913">No</p>
</td>
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.2.2.3.1.2.5.1.4 "><p id="gaussdb_11_0005__en-us_topic_0000001297344601_p184691344165912">Index offset. If <strong id="gaussdb_11_0005__b022514516470">offset</strong> is set to <em id="gaussdb_11_0005__i162311445104712">N</em>, the resource query starts from the N+1 piece of data. The value is <strong id="gaussdb_11_0005__b2023184512478">0</strong> by default, indicating that the query starts from the first piece of data. The value cannot be a negative number.</p>
</td>
</tr>
<tr id="gaussdb_11_0005__en-us_topic_0000001297344601_row31182243218"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.3.1.2.5.1.1 "><p id="gaussdb_11_0005__en-us_topic_0000001297344601_p646954415917">limit</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.2.3.1.2.5.1.2 "><p id="gaussdb_11_0005__en-us_topic_0000001297344601_p125714615419">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.2.2.3.1.2.5.1.3 "><p id="gaussdb_11_0005__en-us_topic_0000001297344601_p7469444115910">No</p>
</td>
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.2.2.3.1.2.5.1.4 "><p id="gaussdb_11_0005__en-us_topic_0000001297344601_p19469194465917">Number of records to be queried. The default value is <strong id="gaussdb_11_0005__en-us_topic_0000001297344601_b16325644124312">100</strong>. The value must be a positive integer. The minimum value is <strong id="gaussdb_11_0005__en-us_topic_0000001297344601_b15325194411434">1</strong> and the maximum value is <strong id="gaussdb_11_0005__en-us_topic_0000001297344601_b732694416437">100</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="gaussdb_11_0005__section1951813350516"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0005__en-us_topic_0000001181084214_HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="gaussdb_11_0005__row105191335205113"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="gaussdb_11_0005__p135194351515">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_0005__p55191835115119">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_0005__p251963595112">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_0005__p6519143518512">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_11_0005__row18519143512514"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="gaussdb_11_0005__p1452020356517">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_0005__p16520163520514">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="gaussdb_11_0005__p5520193515116">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="gaussdb_11_0005__p7520133595112">User token.</p>
</td>
</tr>
<tr id="gaussdb_11_0005__row251993517512"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="gaussdb_11_0005__p115201035185113">X-Language</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="gaussdb_11_0005__p1552013515113">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="gaussdb_11_0005__p16520935155115">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="gaussdb_11_0005__p75219350518">Language.</p>
</td>
</tr>
<tr id="gaussdb_11_0005__row1366594320154"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="gaussdb_11_0005__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_0005__p36651643101518">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="gaussdb_11_0005__p10665443181514">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="gaussdb_11_0005__p1866504318159">MIME type of the request body. You are advised to use the default value <strong id="gaussdb_11_0005__b84514688273555">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_0005__section25211935195119"><h4 class="sectiontitle">Response Parameters</h4><p id="gaussdb_11_0005__p1452115353519"><strong id="gaussdb_11_0005__b0521153535114">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0005__en-us_topic_0000001181084214_response_MysqlInstanceList" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="gaussdb_11_0005__row15521235175112"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="gaussdb_11_0005__p55222356511">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_0005__p165227358512">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_0005__p3522835185117">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_11_0005__row1852120353516"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="gaussdb_11_0005__p1852283514513">instances</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="gaussdb_11_0005__p195232358515">Array of <a href="#gaussdb_11_0005__en-us_topic_0000001181084214_response_MysqlInstanceListInfo">MysqlInstanceListInfo</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="gaussdb_11_0005__p125231735165112">Instance list information.</p>
</td>
</tr>
<tr id="gaussdb_11_0005__row55211735135118"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="gaussdb_11_0005__p1252423515116">total_count</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="gaussdb_11_0005__p15524103519515">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="gaussdb_11_0005__p15241335145116">Total number of records.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="gaussdb_11_0005__en-us_topic_0000001181084214_response_MysqlInstanceListInfo"></a><a name="en-us_topic_0000001181084214_response_MysqlInstanceListInfo"></a><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0005__en-us_topic_0000001181084214_response_MysqlInstanceListInfo" frame="border" border="1" rules="all"><caption><b>Table 4 </b>MysqlInstanceListInfo</caption><thead align="left"><tr id="gaussdb_11_0005__row16524103575118"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="gaussdb_11_0005__p95251735125117">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_0005__p18525135175115">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_0005__p85252352517">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_11_0005__row165241835205116"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0005__p7525183516510">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0005__p1652613516518">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0005__p16526935185120">DB instance ID.</p>
</td>
</tr>
<tr id="gaussdb_11_0005__row7524735105118"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0005__p55261435155117">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0005__p052693512514">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0005__p4526183515517">DB instance name.</p>
</td>
</tr>
<tr id="gaussdb_11_0005__row1452423545114"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0005__p3526113512512">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0005__p552683535113">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0005__p18527153565116">DB instance status.</p>
</td>
</tr>
<tr id="gaussdb_11_0005__row65242352511"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0005__p17527235195119">private_ips</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0005__p552753510514">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_0005__p14527535145110">Private IP address for write. It is a blank string until an ECS is created.</p>
</td>
</tr>
<tr id="gaussdb_11_0005__row18524173514518"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0005__p195271535205110">public_ips</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0005__p15527635185119">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_0005__p175271357515">Public IP addresses.</p>
</td>
</tr>
<tr id="gaussdb_11_0005__row6524163595111"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0005__p452743511516">port</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0005__p18528835125117">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0005__p95281935125110">Database port.</p>
</td>
</tr>
<tr id="gaussdb_11_0005__row65243356519"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0005__p135288357518">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0005__p165281635195115">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0005__p7528173510518">DB instance type. The value is <strong id="gaussdb_11_0005__en-us_topic_0000001297344601_b715568769">Cluster</strong>.</p>
</td>
</tr>
<tr id="gaussdb_11_0005__row115247357516"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0005__p11528335125113">region</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0005__p1452815354512">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0005__p19529123520514">Region where the DB instance is deployed.</p>
</td>
</tr>
<tr id="gaussdb_11_0005__row2524535195113"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0005__p5529143505113">datastore</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0005__p19529133512514"><a href="#gaussdb_11_0005__en-us_topic_0000001181084214_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_0005__p19529153555117">Database information.</p>
</td>
</tr>
<tr id="gaussdb_11_0005__row2052423545118"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0005__p3529193525116">created</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0005__p352915352510">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0005__p8324155992417">Creation time in the "yyyy-mm-ddThh:mm:ssZ" format.</p>
<p id="gaussdb_11_0005__p350917152516"><strong id="gaussdb_11_0005__b5598199194611">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="gaussdb_11_0005__b660515954616">Z</strong> indicates the time zone offset.</p>
<p id="gaussdb_11_0005__p1153011359517">The value is empty unless the instance creation is complete.</p>
</td>
</tr>
<tr id="gaussdb_11_0005__row55241235185111"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0005__p115304356512">updated</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0005__p953043519515">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0005__p15329332257">Update time. The format is the same as that of the <strong id="gaussdb_11_0005__b168263662973555">created</strong> field.</p>
<p id="gaussdb_11_0005__p1530163517513">The value is empty unless the instance creation is complete.</p>
</td>
</tr>
<tr id="gaussdb_11_0005__row1252463513515"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0005__p1453016354511">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_0005__p165301535105110">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0005__p105302353519">Default username.</p>
</td>
</tr>
<tr id="gaussdb_11_0005__row552503525112"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0005__p1953043515514">vpc_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0005__p1953043519515">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0005__p1853117352516">VPC ID.</p>
</td>
</tr>
<tr id="gaussdb_11_0005__row16525183535115"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0005__p953103575114">subnet_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0005__p15315359511">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0005__p2053153535111">Network ID of the subnet.</p>
</td>
</tr>
<tr id="gaussdb_11_0005__row13525103515116"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0005__p6531735105112">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_0005__p453153575113">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0005__p653118358519">Security group ID.</p>
</td>
</tr>
<tr id="gaussdb_11_0005__row25251035145114"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0005__p3531163518517">flavor_ref</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0005__p1853293519518">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0005__p1253243515515">Specification code.</p>
</td>
</tr>
<tr id="gaussdb_11_0005__row18525123535111"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0005__p35329355515">flavor_info</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0005__p16532435175110"><a href="#gaussdb_11_0005__en-us_topic_0000001181084214_response_MysqlFlavorInfo">MysqlFlavorInfo</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0005__p15841527181614">Specification description.</p>
</td>
</tr>
<tr id="gaussdb_11_0005__row13100102803614"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0005__p6174642105410">volume</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0005__p15174442105415"><a href="#gaussdb_11_0005__response_MysqlVolumeInfo">MysqlVolumeInfo</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0005__p1117494217540">Storage disk information.</p>
</td>
</tr>
<tr id="gaussdb_11_0005__row1152563510518"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0005__p4533935115110">backup_strategy</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0005__p1953313520517"><a href="#gaussdb_11_0005__en-us_topic_0000001181084214_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_0005__p1533135105119">Backup policy.</p>
</td>
</tr>
<tr id="gaussdb_11_0005__row552523513518"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0005__p155331435185120">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_0005__p85336358511">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0005__p18533435175116">Enterprise project ID.</p>
</td>
</tr>
<tr id="gaussdb_11_0005__row2525123575112"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0005__p4533103512511">time_zone</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0005__p653416351519">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0005__p8534153511513">Time zone.</p>
</td>
</tr>
<tr id="gaussdb_11_0005__row1252516359517"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0005__p25343353512">charge_info</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0005__p1534435155112"><a href="#gaussdb_11_0005__en-us_topic_0000001181084214_response_MysqlChargeInfo">MysqlChargeInfo</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0005__p175347358513">Billing mode, which is yearly/monthly or pay-per-use (default setting).</p>
</td>
</tr>
<tr id="gaussdb_11_0005__row1452523514514"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0005__p11534935185115">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_0005__p11534235155120">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0005__p135341135125114">Dedicated resource pool ID. This parameter is returned only when the instance belongs to a dedicated resource pool.</p>
</td>
</tr>
<tr id="gaussdb_11_0005__row3525113518514"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0005__p1753512352516">tags</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0005__p17535163515516">Array of <a href="#gaussdb_11_0005__en-us_topic_0000001181084214_response_InstanceTagItem">InstanceTagItem</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0005__p17535173525111">Tag list.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="gaussdb_11_0005__en-us_topic_0000001181084214_response_MysqlDatastore"></a><a name="en-us_topic_0000001181084214_response_MysqlDatastore"></a><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0005__en-us_topic_0000001181084214_response_MysqlDatastore" frame="border" border="1" rules="all"><caption><b>Table 5 </b>MysqlDatastore</caption><thead align="left"><tr id="gaussdb_11_0005__row1535135175118"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="gaussdb_11_0005__p653514353512">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_0005__p1653619356518">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_0005__p253633525111">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_11_0005__row35351135165111"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="gaussdb_11_0005__p9536133535113">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="gaussdb_11_0005__p18536335145115">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="gaussdb_11_0005__p053673510516">DB engine. Currently, only <strong id="gaussdb_11_0005__b75878708073555">gaussdb-mysql</strong> is supported.</p>
</td>
</tr>
<tr id="gaussdb_11_0005__row155351735115111"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="gaussdb_11_0005__p105371535155120">version</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="gaussdb_11_0005__p1753753517516">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="gaussdb_11_0005__p953783535116">DB version.</p>
<p id="gaussdb_11_0005__p18537113585113">To obtain details about supported DB engine versions, call the API for querying the DB engine versions.</p>
</td>
</tr>
<tr id="gaussdb_11_0005__row1697218473112"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="gaussdb_11_0005__p422545811237">kernel_version</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="gaussdb_11_0005__p22254581234">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="gaussdb_11_0005__p1622665818239">Database kernel version.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="gaussdb_11_0005__en-us_topic_0000001181084214_response_MysqlFlavorInfo"></a><a name="en-us_topic_0000001181084214_response_MysqlFlavorInfo"></a><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0005__en-us_topic_0000001181084214_response_MysqlFlavorInfo" frame="border" border="1" rules="all"><caption><b>Table 6 </b>MysqlFlavorInfo</caption><thead align="left"><tr id="gaussdb_11_0005__row653718353510"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.1"><p id="gaussdb_11_0005__p35381335155119">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_0005__p65381035125113">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_0005__p1653823575117">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_11_0005__row1953712356511"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="gaussdb_11_0005__p3538193514519">vcpus</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="gaussdb_11_0005__p14538123585117">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="gaussdb_11_0005__p12538143518519">Number of vCPUs.</p>
</td>
</tr>
<tr id="gaussdb_11_0005__row1653713356516"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="gaussdb_11_0005__p353812358513">ram</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="gaussdb_11_0005__p0538835195117">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="gaussdb_11_0005__p1553953518518">Memory size in GB.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="gaussdb_11_0005__response_MysqlVolumeInfo"></a><a name="response_MysqlVolumeInfo"></a><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0005__response_MysqlVolumeInfo" frame="border" border="1" rules="all"><caption><b>Table 7 </b>MysqlVolumeInfo</caption><thead align="left"><tr id="gaussdb_11_0005__row51803424545"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.1"><p id="gaussdb_11_0005__p141801642185413">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_0005__p1118011422547">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_0005__p161811842185418">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_11_0005__row618016423544"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="gaussdb_11_0005__p91815421542">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="gaussdb_11_0005__p9181184214546">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="gaussdb_11_0005__p17181184295420">Disk type.</p>
</td>
</tr>
<tr id="gaussdb_11_0005__row201801242185420"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="gaussdb_11_0005__p191811842105410">size</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="gaussdb_11_0005__p1318174235418">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="gaussdb_11_0005__p418112427545">Used disk size in GB.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="gaussdb_11_0005__en-us_topic_0000001181084214_response_MysqlBackupStrategy"></a><a name="en-us_topic_0000001181084214_response_MysqlBackupStrategy"></a><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0005__en-us_topic_0000001181084214_response_MysqlBackupStrategy" frame="border" border="1" rules="all"><caption><b>Table 8 </b>MysqlBackupStrategy</caption><thead align="left"><tr id="gaussdb_11_0005__row105416352516"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.8.2.4.1.1"><p id="gaussdb_11_0005__p1664123515512">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_0005__p15641163555116">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_0005__p11641335185112">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_11_0005__row3541735155114"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="gaussdb_11_0005__p13641135145116">start_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="gaussdb_11_0005__p1564163565115">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="gaussdb_11_0005__p18641133514511">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_0005__row154116352514"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="gaussdb_11_0005__p1564113353512">keep_days</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="gaussdb_11_0005__p364103585113">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="gaussdb_11_0005__p3141138182619">Backup retention days.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="gaussdb_11_0005__en-us_topic_0000001181084214_response_MysqlChargeInfo"></a><a name="en-us_topic_0000001181084214_response_MysqlChargeInfo"></a><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0005__en-us_topic_0000001181084214_response_MysqlChargeInfo" frame="border" border="1" rules="all"><caption><b>Table 9 </b>MysqlChargeInfo</caption><thead align="left"><tr id="gaussdb_11_0005__row1854253565113"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.9.2.4.1.1"><p id="gaussdb_11_0005__p17641123510511">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_0005__p20642123511513">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_0005__p464218354515">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_11_0005__row654216352515"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="gaussdb_11_0005__p4642335145119">charge_mode</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="gaussdb_11_0005__p7642103510519">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="gaussdb_11_0005__p13419304384">Billing mode.</p>
<p id="gaussdb_11_0005__p134812510201">Value: <strong id="gaussdb_11_0005__b91563185873555">postPaid</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="gaussdb_11_0005__en-us_topic_0000001181084214_response_InstanceTagItem"></a><a name="en-us_topic_0000001181084214_response_InstanceTagItem"></a><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0005__en-us_topic_0000001181084214_response_InstanceTagItem" frame="border" border="1" rules="all"><caption><b>Table 10 </b>InstanceTagItem</caption><thead align="left"><tr id="gaussdb_11_0005__row354683513519"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.10.2.4.1.1"><p id="gaussdb_11_0005__p186421335155110">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.10.2.4.1.2"><p id="gaussdb_11_0005__p96421635175114">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.10.2.4.1.3"><p id="gaussdb_11_0005__p116421435185117">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_11_0005__row15461235165112"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.1 "><p id="gaussdb_11_0005__p156421835115110">key</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.2 "><p id="gaussdb_11_0005__p46421135105112">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.10.2.4.1.3 "><p id="gaussdb_11_0005__p16642113545117">Tag key.</p>
</td>
</tr>
<tr id="gaussdb_11_0005__row854613575119"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.1 "><p id="gaussdb_11_0005__p136421435115115">value</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.2 "><p id="gaussdb_11_0005__p17642113512517">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.10.2.4.1.3 "><p id="gaussdb_11_0005__p1164233511515">Tag value.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="gaussdb_11_0005__p56421335195120"><strong id="gaussdb_11_0005__b179432626772448">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0005__en-us_topic_0000001181084214_response_MysqlErrorResponse" frame="border" border="1" rules="all"><caption><b>Table 11 </b>Response body parameters</caption><thead align="left"><tr id="gaussdb_11_0005__row1154733518516"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.12.2.4.1.1"><p id="gaussdb_11_0005__p11642143517517">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.12.2.4.1.2"><p id="gaussdb_11_0005__p1464263515515">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.12.2.4.1.3"><p id="gaussdb_11_0005__p106423350513">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_11_0005__row1554712351516"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.12.2.4.1.1 "><p id="gaussdb_11_0005__p1264218352515">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.12.2.4.1.2 "><p id="gaussdb_11_0005__p1964293519515">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.12.2.4.1.3 "><p id="gaussdb_11_0005__p164353535120">Error code.</p>
</td>
</tr>
<tr id="gaussdb_11_0005__row25472035175111"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.12.2.4.1.1 "><p id="gaussdb_11_0005__p864313516512">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.12.2.4.1.2 "><p id="gaussdb_11_0005__p126434354516">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.12.2.4.1.3 "><p id="gaussdb_11_0005__p56435352514">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="gaussdb_11_0005__p1464315353510"><strong id="gaussdb_11_0005__b61307519163954">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0005__table85481135195116" frame="border" border="1" rules="all"><caption><b>Table 12 </b>Response body parameters</caption><thead align="left"><tr id="gaussdb_11_0005__row8549235175116"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.14.2.4.1.1"><p id="gaussdb_11_0005__p176431635115117">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.14.2.4.1.2"><p id="gaussdb_11_0005__p12643113555110">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.14.2.4.1.3"><p id="gaussdb_11_0005__p26431635165114">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_11_0005__row054910355510"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.14.2.4.1.1 "><p id="gaussdb_11_0005__p1064343515511">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.14.2.4.1.2 "><p id="gaussdb_11_0005__p12643103513510">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.14.2.4.1.3 "><p id="gaussdb_11_0005__p46432355518">Error code.</p>
</td>
</tr>
<tr id="gaussdb_11_0005__row1549535145118"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.14.2.4.1.1 "><p id="gaussdb_11_0005__p964314357518">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.14.2.4.1.2 "><p id="gaussdb_11_0005__p86432351513">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.14.2.4.1.3 "><p id="gaussdb_11_0005__p1064319358513">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="gaussdb_11_0005__section6643635115110"><h4 class="sectiontitle">Example Request</h4><p id="gaussdb_11_0005__p8643163513513">Querying DB Instances</p>
<pre class="screen" id="gaussdb_11_0005__screen175151040115215">GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances?id=ed7cc6166ec24360a5ed5c5c9c2ed726in01&amp;name=hy&amp;type=Cluster&amp;datastore_type=gaussdb-mysql&amp;vpc_id=19e5d45d-70fd-4a91-87e9-b27e71c9891f&amp;subnet_id=bd51fb45-2dcb-4296-8783-8623bfe89bb7&amp;offset=0&amp;limit=10</pre>
</div>
<div class="section" id="gaussdb_11_0005__section17643435175113"><h4 class="sectiontitle">Example Response</h4><p id="gaussdb_11_0005__p1664310351515"><strong id="gaussdb_11_0005__b7643133513516">Status code: 200</strong></p>
<p id="gaussdb_11_0005__p36434358518">Success.</p>
<pre class="screen" id="gaussdb_11_0005__screen864315358515">{
"total_count" : 1,
"instances" : [ {
"id" : "ed7cc6166ec24360a5ed5c5c9c2ed726in01",
"name" : "taurusdb-instance01",
"status" : "ACTIVE",
"port" : 3306,
"type" : "Cluster",
"private_ips" : [ "192.168.0.142" ],
"db_user_name" : "root",
"region" : "eu-de",
"datastore" : {
"type" : "gaussdb-mysql",
"version" : "8.0"
},
"created" : "2018-08-20T02:33:49_0800",
"updated" : "2018-08-20T02:33:49_0800",
"volume" : {
"type" : "POOL",
"used_size" : 100
},
"vpc_id" : "3cedfc54-b105-4652-a4e0-847b11576b58",
"subnet_id" : "c1cfa53c-65d3-431e-8552-326bf310c7ad",
"security_group_id" : "fc577a1a-f202-424a-977f-24faec3fdd55",
"flavor_ref" : "gaussdb.mysql.c3.small.4",
"flavor_info" : {
"vcpus" : 8,
"ram" : 16
},
"backup_strategy" : {
"start_time" : "19:00-20:00",
"keep_days" : 7
},
"charge_info" : {
"charge_mode" : "postPaid"
},
"enterprise_project_id" : 0,
"time_zone" : "UTC",
"tags" : [ ]
} ]
}</pre>
</div>
<div class="section" id="gaussdb_11_0005__section4778540915440"><h4 class="sectiontitle">Status Code</h4><p id="gaussdb_11_0005__p0723374409">For details, see <a href="gaussdb_10_0002.html">Status Codes</a>.</p>
</div>
<div class="section" id="gaussdb_11_0005__section2557116171718"><h4 class="sectiontitle">Error Code</h4><p id="gaussdb_11_0005__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