yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
8af0f653c62826e99afeb45bbd2fb0ad702f0fce
doc-exports/docs/taurusdb/api-ref/ListInstanceConfigurations.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

345 lines
29 KiB
HTML
Raw Blame History

<a name="ListInstanceConfigurations"></a><a name="ListInstanceConfigurations"></a>
<h1 class="topictitle1">Obtaining Parameter Information of a Specified DB Instance</h1>
<div id="body0000002259034709"><div class="section" id="ListInstanceConfigurations__section171335197252"><h4 class="sectiontitle">Function</h4><p id="ListInstanceConfigurations__p19133151962516">This API is used to obtain parameter information of a specified DB instance. Before calling this API:</p>
<ul id="ListInstanceConfigurations__ul924420236520"><li id="ListInstanceConfigurations__gaussdb_04_0001_li136356359522">Learn how to <a href="gaussdb_03_0001.html">authorize and authenticate</a> it.</li><li id="ListInstanceConfigurations__gaussdb_04_0001_li1991981933613">Obtain the required <a href="gaussdb_00_0003.html">region and endpoint</a>.</li></ul>
</div>
<div class="section" id="ListInstanceConfigurations__section413311194255"><h4 class="sectiontitle">URI</h4><p id="ListInstanceConfigurations__p8134191962515">GET /v3/{project_id}/instances/{instance_id}/configurations</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListInstanceConfigurations__table17135171922513" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="ListInstanceConfigurations__row013461992512"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ListInstanceConfigurations__p8135161915254">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ListInstanceConfigurations__p113621916257">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="ListInstanceConfigurations__p17136201992515">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="ListInstanceConfigurations__p1613671982511">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListInstanceConfigurations__row1913421914254"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ListInstanceConfigurations__p11443574517">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ListInstanceConfigurations__p16441856454">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ListInstanceConfigurations__p3441855459">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ListInstanceConfigurations__p18830181310462">Project ID of a tenant in a region.</p>
<p id="ListInstanceConfigurations__p118301913154617">To obtain this value, see <a href="gaussdb_10_0004.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
<tr id="ListInstanceConfigurations__row5135131913258"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ListInstanceConfigurations__p1313812195257">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ListInstanceConfigurations__p16139119182520">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ListInstanceConfigurations__p161391319172516">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ListInstanceConfigurations__p18782229202115">Instance ID, which uniquely identifies an instance.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListInstanceConfigurations__table7453514517" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query parameters</caption><thead align="left"><tr id="ListInstanceConfigurations__row6441754458"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="ListInstanceConfigurations__p1845358451">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="ListInstanceConfigurations__p1459584514">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="ListInstanceConfigurations__p1145155194516">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="ListInstanceConfigurations__p54512512458">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListInstanceConfigurations__row4441355458"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListInstanceConfigurations__p19458544514">offset</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListInstanceConfigurations__p194575144520">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListInstanceConfigurations__p1345105144512">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListInstanceConfigurations__p124612554516">Index offset. If <strong id="ListInstanceConfigurations__b138111347194912">offset</strong> is set to <em id="ListInstanceConfigurations__i48112477493">N</em>, the resource query starts from the <em id="ListInstanceConfigurations__i17811144713493">N</em>+1 piece of data. The value is <strong id="ListInstanceConfigurations__b581114718490">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="ListInstanceConfigurations__row4446516456"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListInstanceConfigurations__p2046556455">limit</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListInstanceConfigurations__p13464515458">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListInstanceConfigurations__p3461455459">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListInstanceConfigurations__p1246165184510">Number of records to be queried. The default value is <strong id="ListInstanceConfigurations__b4881021402">100</strong>. The value must be a positive integer. The minimum value is <strong id="ListInstanceConfigurations__b168914219014">1</strong> and the maximum value is <strong id="ListInstanceConfigurations__b1289321409">100</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListInstanceConfigurations__section1114419194257"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListInstanceConfigurations__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameter</caption><thead align="left"><tr id="ListInstanceConfigurations__row1346255459"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="ListInstanceConfigurations__p134710524511">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="ListInstanceConfigurations__p114713519451">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="ListInstanceConfigurations__p64775174514">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="ListInstanceConfigurations__p12471159459">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListInstanceConfigurations__row19460524518"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ListInstanceConfigurations__p44735144513">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ListInstanceConfigurations__p18479515453">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ListInstanceConfigurations__p19471853455">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ListInstanceConfigurations__p194716564518">User token.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListInstanceConfigurations__section41491219172512"><h4 class="sectiontitle">Response Parameters</h4><p id="ListInstanceConfigurations__p1149181962510"><strong id="ListInstanceConfigurations__b17150419162512">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListInstanceConfigurations__en-us_topic_0000001731567853_response_ListInstanceConfigurationsResp" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="ListInstanceConfigurations__row5150819132510"><th align="left" class="cellrowborder" valign="top" width="24.86%" id="mcps1.3.4.3.2.4.1.1"><p id="ListInstanceConfigurations__p315141910250">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="34.949999999999996%" id="mcps1.3.4.3.2.4.1.2"><p id="ListInstanceConfigurations__p915181915258">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40.19%" id="mcps1.3.4.3.2.4.1.3"><p id="ListInstanceConfigurations__p3152201982515">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListInstanceConfigurations__row1615041918255"><td class="cellrowborder" valign="top" width="24.86%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListInstanceConfigurations__p14152619162511">configurations</p>
</td>
<td class="cellrowborder" valign="top" width="34.949999999999996%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListInstanceConfigurations__p41529192255"><a href="#ListInstanceConfigurations__en-us_topic_0000001731567853_response_ParameterConfigurationInfo">ParameterConfigurationInfo</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="40.19%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListInstanceConfigurations__p376095712919">Instance parameter template information.</p>
</td>
</tr>
<tr id="ListInstanceConfigurations__row1515031917256"><td class="cellrowborder" valign="top" width="24.86%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListInstanceConfigurations__p19153111910259">total_count</p>
</td>
<td class="cellrowborder" valign="top" width="34.949999999999996%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListInstanceConfigurations__p6153019172518">Long</p>
</td>
<td class="cellrowborder" valign="top" width="40.19%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListInstanceConfigurations__p17761757112920">Total number of instance parameters.</p>
</td>
</tr>
<tr id="ListInstanceConfigurations__row915015191252"><td class="cellrowborder" valign="top" width="24.86%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListInstanceConfigurations__p181537197259">parameter_values</p>
</td>
<td class="cellrowborder" valign="top" width="34.949999999999996%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListInstanceConfigurations__p41541119132516">Array of <a href="#ListInstanceConfigurations__en-us_topic_0000001731567853_response_ParameterValuesInfo">ParameterValuesInfo</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="40.19%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListInstanceConfigurations__p16761175720297">Instance parameter information.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListInstanceConfigurations__en-us_topic_0000001731567853_response_ParameterConfigurationInfo"></a><a name="en-us_topic_0000001731567853_response_ParameterConfigurationInfo"></a><table cellpadding="4" cellspacing="0" summary="" id="ListInstanceConfigurations__en-us_topic_0000001731567853_response_ParameterConfigurationInfo" frame="border" border="1" rules="all"><caption><b>Table 5 </b>ParameterConfigurationInfo</caption><thead align="left"><tr id="ListInstanceConfigurations__row815510197254"><th align="left" class="cellrowborder" valign="top" width="24.88%" id="mcps1.3.4.4.2.4.1.1"><p id="ListInstanceConfigurations__p515619194258">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.189999999999998%" id="mcps1.3.4.4.2.4.1.2"><p id="ListInstanceConfigurations__p515691982511">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52.93%" id="mcps1.3.4.4.2.4.1.3"><p id="ListInstanceConfigurations__p17156171932511">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListInstanceConfigurations__row91556198253"><td class="cellrowborder" valign="top" width="24.88%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstanceConfigurations__p1615712191251">datastore_version_name</p>
</td>
<td class="cellrowborder" valign="top" width="22.189999999999998%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstanceConfigurations__p1815701902516">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.93%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstanceConfigurations__p19531129173016">DB version name.</p>
</td>
</tr>
<tr id="ListInstanceConfigurations__row1115511962519"><td class="cellrowborder" valign="top" width="24.88%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstanceConfigurations__p11157171962510">datastore_name</p>
</td>
<td class="cellrowborder" valign="top" width="22.189999999999998%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstanceConfigurations__p4158101922517">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.93%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstanceConfigurations__p18531119193016">DB engine name in the parameter template.</p>
</td>
</tr>
<tr id="ListInstanceConfigurations__row18809114035320"><td class="cellrowborder" valign="top" width="24.88%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstanceConfigurations__p485945045316">configuration_id</p>
</td>
<td class="cellrowborder" valign="top" width="22.189999999999998%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstanceConfigurations__p128783556536">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.93%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstanceConfigurations__p581064025320">Parameter template ID.</p>
</td>
</tr>
<tr id="ListInstanceConfigurations__row1215513199258"><td class="cellrowborder" valign="top" width="24.88%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstanceConfigurations__p17159619142519">created</p>
</td>
<td class="cellrowborder" valign="top" width="22.189999999999998%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstanceConfigurations__p1515941902518">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.93%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstanceConfigurations__p18531993308">Time when the parameter template was created. The format is "yyyy-mm-ddThh:mm:ssZ".</p>
<p id="ListInstanceConfigurations__p1853189143010"><strong id="ListInstanceConfigurations__b21303317272570">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="ListInstanceConfigurations__b914348832570">Z</strong> indicates the time zone offset. For example, if the time zone offset is one hour, the value of <strong id="ListInstanceConfigurations__b2984501952570">Z</strong> is <strong id="ListInstanceConfigurations__b6196691772570">+0100</strong>.</p>
</td>
</tr>
<tr id="ListInstanceConfigurations__row191551196253"><td class="cellrowborder" valign="top" width="24.88%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstanceConfigurations__p1116121913250">updated</p>
</td>
<td class="cellrowborder" valign="top" width="22.189999999999998%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstanceConfigurations__p416171912517">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.93%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstanceConfigurations__p105322920307">Time when the parameter template was updated. The format is "yyyy-mm-ddThh:mm:ssZ".</p>
<p id="ListInstanceConfigurations__p55321294303"><strong id="ListInstanceConfigurations__b5271642002570">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="ListInstanceConfigurations__b20196230362570">Z</strong> indicates the time zone offset. For example, if the time zone offset is one hour, the value of <strong id="ListInstanceConfigurations__b1854284112570">Z</strong> is <strong id="ListInstanceConfigurations__b14118012982570">+0100</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListInstanceConfigurations__en-us_topic_0000001731567853_response_ParameterValuesInfo"></a><a name="en-us_topic_0000001731567853_response_ParameterValuesInfo"></a><table cellpadding="4" cellspacing="0" summary="" id="ListInstanceConfigurations__en-us_topic_0000001731567853_response_ParameterValuesInfo" frame="border" border="1" rules="all"><caption><b>Table 6 </b>ParameterValuesInfo</caption><thead align="left"><tr id="ListInstanceConfigurations__row1116241932513"><th align="left" class="cellrowborder" valign="top" width="24.529999999999998%" id="mcps1.3.4.5.2.4.1.1"><p id="ListInstanceConfigurations__p151630197257">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.45%" id="mcps1.3.4.5.2.4.1.2"><p id="ListInstanceConfigurations__p121641819142517">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.02%" id="mcps1.3.4.5.2.4.1.3"><p id="ListInstanceConfigurations__p181641919112514">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListInstanceConfigurations__row1316220197253"><td class="cellrowborder" valign="top" width="24.529999999999998%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListInstanceConfigurations__p1616401942514">name</p>
</td>
<td class="cellrowborder" valign="top" width="22.45%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListInstanceConfigurations__p101641219102510">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.02%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListInstanceConfigurations__p119716458305">Parameter name.</p>
</td>
</tr>
<tr id="ListInstanceConfigurations__row1216271919254"><td class="cellrowborder" valign="top" width="24.529999999999998%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListInstanceConfigurations__p1016511917258">value</p>
</td>
<td class="cellrowborder" valign="top" width="22.45%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListInstanceConfigurations__p13165131913253">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.02%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListInstanceConfigurations__p15971184553019">Parameter value.</p>
</td>
</tr>
<tr id="ListInstanceConfigurations__row1816211912258"><td class="cellrowborder" valign="top" width="24.529999999999998%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListInstanceConfigurations__p3166131916251">restart_required</p>
</td>
<td class="cellrowborder" valign="top" width="22.45%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListInstanceConfigurations__p11166111992511">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="53.02%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListInstanceConfigurations__p89711345203018">Whether a reboot is required.</p>
<ul id="ListInstanceConfigurations__ul49721645193013"><li id="ListInstanceConfigurations__li109721945103012"><strong id="ListInstanceConfigurations__b56321748161419">false</strong>: no</li><li id="ListInstanceConfigurations__li189721045163018"><strong id="ListInstanceConfigurations__b0431151181419">true</strong>: yes</li></ul>
</td>
</tr>
<tr id="ListInstanceConfigurations__row19162161942517"><td class="cellrowborder" valign="top" width="24.529999999999998%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListInstanceConfigurations__p916781911252">readonly</p>
</td>
<td class="cellrowborder" valign="top" width="22.45%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListInstanceConfigurations__p18167201919250">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="53.02%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListInstanceConfigurations__p497274553019">Whether the parameter is read-only.</p>
<ul id="ListInstanceConfigurations__ul7972745123015"><li id="ListInstanceConfigurations__li1097254510304"><strong id="ListInstanceConfigurations__b19137587148">false</strong>: no</li><li id="ListInstanceConfigurations__li1297210459308"><strong id="ListInstanceConfigurations__b7410141510">true</strong>: yes</li></ul>
</td>
</tr>
<tr id="ListInstanceConfigurations__row1216361932517"><td class="cellrowborder" valign="top" width="24.529999999999998%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListInstanceConfigurations__p7168121942519">value_range</p>
</td>
<td class="cellrowborder" valign="top" width="22.45%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListInstanceConfigurations__p131691319172516">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.02%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListInstanceConfigurations__p1972194520305">Value range.</p>
</td>
</tr>
<tr id="ListInstanceConfigurations__row161636199259"><td class="cellrowborder" valign="top" width="24.529999999999998%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListInstanceConfigurations__p21699193251">type</p>
</td>
<td class="cellrowborder" valign="top" width="22.45%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListInstanceConfigurations__p191701191254">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.02%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListInstanceConfigurations__p49720458306">Parameter type.</p>
<ul id="ListInstanceConfigurations__ul1497294513018"><li id="ListInstanceConfigurations__li139721945153011">string</li><li id="ListInstanceConfigurations__li119721445193014">integer</li><li id="ListInstanceConfigurations__li1097216458308">boolean</li><li id="ListInstanceConfigurations__li0972445183015">list</li><li id="ListInstanceConfigurations__li13973124583017">float</li></ul>
</td>
</tr>
<tr id="ListInstanceConfigurations__row816311918258"><td class="cellrowborder" valign="top" width="24.529999999999998%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListInstanceConfigurations__p16178519182520">description</p>
</td>
<td class="cellrowborder" valign="top" width="22.45%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListInstanceConfigurations__p1178101916253">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.02%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListInstanceConfigurations__p69731453308">Parameter description.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ListInstanceConfigurations__p12179319152511"><strong id="ListInstanceConfigurations__b10179151917254">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListInstanceConfigurations__en-us_topic_0000001731567853_response_MysqlErrorResponse" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Response body parameters</caption><thead align="left"><tr id="ListInstanceConfigurations__row8179119102518"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.1"><p id="ListInstanceConfigurations__p4180111962519">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.2"><p id="ListInstanceConfigurations__p111801019162514">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.7.2.4.1.3"><p id="ListInstanceConfigurations__p4181619132511">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListInstanceConfigurations__row121791719192519"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ListInstanceConfigurations__p1218112198259">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ListInstanceConfigurations__p19181419172518">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ListInstanceConfigurations__p3181191920251">Error code.</p>
</td>
</tr>
<tr id="ListInstanceConfigurations__row91791519182513"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ListInstanceConfigurations__p3182111972513">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ListInstanceConfigurations__p4182121910257">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ListInstanceConfigurations__p418215196252">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ListInstanceConfigurations__p1318251912251"><strong id="ListInstanceConfigurations__b8182319152515">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListInstanceConfigurations__table161828196253" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Response body parameters</caption><thead align="left"><tr id="ListInstanceConfigurations__row1318311922511"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.9.2.4.1.1"><p id="ListInstanceConfigurations__p018411912258">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.9.2.4.1.2"><p id="ListInstanceConfigurations__p418414196258">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.9.2.4.1.3"><p id="ListInstanceConfigurations__p118412197255">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListInstanceConfigurations__row2183619152515"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="ListInstanceConfigurations__p20185121982517">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="ListInstanceConfigurations__p101851619132514">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="ListInstanceConfigurations__p1818512195255">Error code.</p>
</td>
</tr>
<tr id="ListInstanceConfigurations__row171837197256"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="ListInstanceConfigurations__p1118621916251">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="ListInstanceConfigurations__p3186191962512">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="ListInstanceConfigurations__p111861119142519">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListInstanceConfigurations__section8186141962514"><h4 class="sectiontitle">Example Request</h4><p id="ListInstanceConfigurations__p1918714191252">Obtaining parameter information of a specified DB instance</p>
<pre class="screen" id="ListInstanceConfigurations__screen7187101922510">
GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/61a4ea66210545909d74a05c27a7179ein07/configurations</pre>
</div>
<div class="section" id="ListInstanceConfigurations__section171871119182514"><h4 class="sectiontitle">Example Response</h4><p id="ListInstanceConfigurations__p81871019152516"><strong id="ListInstanceConfigurations__b16188201942514">Status code: 200</strong></p>
<p id="ListInstanceConfigurations__p13188121914258">Success.</p>
<pre class="screen" id="ListInstanceConfigurations__screen7189131912250">{
"configurations" : {
"datastore_version_name" : "2.0",
"datastore_name" : "taurus",
"configuration_id": "f35d2c4501944225bc96ef8d20ece2bcpr07",
"created" : "2022-10-29T09:38:36+0000",
"updated" : "2022-10-29T09:38:36+0000"
},
"total_count" : 125,
"parameter_values" : [ {
"name" : "auto_increment_increment",
"value" : "1",
"restart_required" : false,
"readonly" : false,
"value_range" : "1-65535",
"type" : "integer",
"description": <strong id="ListInstanceConfigurations__b842352706212626">auto_increment_increment</strong> and <strong id="ListInstanceConfigurations__b842352706212629">auto_increment_offset</strong> are used for master-to-master replication and to control the operations of the AUTO_INCREMENT column.
}, {
"name" : "auto_increment_offset",
"value" : "1",
"restart_required" : false,
"readonly" : false,
"value_range" : "1-65535",
"type" : "integer",
"description": <strong id="ListInstanceConfigurations__b1839417472209">auto_increment_increment</strong> and <strong id="ListInstanceConfigurations__b16395144715203">auto_increment_offset</strong> are used for master-to-master replication and to control the operations of the AUTO_INCREMENT column.
} ]
}</pre>
</div>
<div class="section" id="ListInstanceConfigurations__section4778540915440"><h4 class="sectiontitle">Status Code</h4><p id="ListInstanceConfigurations__gaussdb_04_0011_p0723374409">For details, see <a href="gaussdb_10_0002.html">Status Codes</a>.</p>
</div>
<div class="section" id="ListInstanceConfigurations__section946032144017"><h4 class="sectiontitle">Error Code</h4><p id="ListInstanceConfigurations__gaussdb_04_0011_p19357163913406">For details, see <a href="gaussdb_10_0003.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="gaussdb_04_0008.html">Parameter Template Management</a></div>
</div>
</div>
View Git Blame Copy Permalink