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

425 lines
38 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<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__p1213619194252">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ListInstanceConfigurations__p171371019162514">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ListInstanceConfigurations__p9137419192510">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ListInstanceConfigurations__p162491554202015"><strong id="ListInstanceConfigurations__b573025579566">Explanation</strong>:</p>
<p id="ListInstanceConfigurations__p8137519162511">Project ID of a tenant in a region.</p>
<p id="ListInstanceConfigurations__p213719198256">To obtain this value, see <a href="gaussdb_10_0004.html">Obtaining a Project ID</a>.</p>
<p id="ListInstanceConfigurations__p163361216182116"><strong id="ListInstanceConfigurations__b7654624194426">Constraints</strong>:</p>
<p id="ListInstanceConfigurations__p7336161642110">None</p>
<p id="ListInstanceConfigurations__p2336171662117"><strong id="ListInstanceConfigurations__b11841577904434">Value range</strong>:</p>
<p id="ListInstanceConfigurations__p8336916122119">The value can contain 32 characters. Only letters and digits are allowed.</p>
<p id="ListInstanceConfigurations__p933671616215"><strong id="ListInstanceConfigurations__b358193778446">Default value</strong>:</p>
<p id="ListInstanceConfigurations__p17336616112112">None</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"><strong id="ListInstanceConfigurations__b18160534654312">Explanation</strong>:</p>
<p id="ListInstanceConfigurations__p5782529102117">Instance ID, which uniquely identifies an instance.</p>
<p id="ListInstanceConfigurations__p178212918217"><strong id="ListInstanceConfigurations__b19049064894426">Constraints</strong>:</p>
<p id="ListInstanceConfigurations__p17782172914215">None</p>
<p id="ListInstanceConfigurations__p57821529102112"><strong id="ListInstanceConfigurations__b17776533714434">Value range</strong>:</p>
<p id="ListInstanceConfigurations__p57822293219">The value can contain 36 characters with a suffix of <strong id="ListInstanceConfigurations__b2011611329112148">in07</strong>. Only letters and digits are allowed.</p>
<p id="ListInstanceConfigurations__p1378217298212"><strong id="ListInstanceConfigurations__b1864139750112210">Default value</strong>:</p>
<p id="ListInstanceConfigurations__p27821929182114">None</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListInstanceConfigurations__table31403194258" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query parameters</caption><thead align="left"><tr id="ListInstanceConfigurations__row814081912252"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="ListInstanceConfigurations__p61411219162510">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="ListInstanceConfigurations__p141418197259">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="ListInstanceConfigurations__p214131913259">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="ListInstanceConfigurations__p18141131912510">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListInstanceConfigurations__row814051942512"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListInstanceConfigurations__p131427197256">offset</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListInstanceConfigurations__p31421219132513">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListInstanceConfigurations__p114231912256">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListInstanceConfigurations__p143914313215"><strong id="ListInstanceConfigurations__b10173010424312">Explanation</strong>:</p>
<p id="ListInstanceConfigurations__p6439543132112">Index offset. The query starts from the next piece of data indexed by this parameter.</p>
<p id="ListInstanceConfigurations__p17439124312115"><strong id="ListInstanceConfigurations__b8644963844426">Constraints</strong>:</p>
<p id="ListInstanceConfigurations__p16439134342119">The value must be an integer and cannot be a negative number.</p>
<p id="ListInstanceConfigurations__p2043915435218"><strong id="ListInstanceConfigurations__b16082290804434">Value range</strong>:</p>
<p id="ListInstanceConfigurations__p1743911439215">≥0</p>
<p id="ListInstanceConfigurations__p2439643172116"><strong id="ListInstanceConfigurations__b972756108112210">Default value</strong>:</p>
<p id="ListInstanceConfigurations__p6439144372118">0</p>
</td>
</tr>
<tr id="ListInstanceConfigurations__row1140171914259"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListInstanceConfigurations__p9143141914251">limit</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListInstanceConfigurations__p1614321962515">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListInstanceConfigurations__p14143519132520">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListInstanceConfigurations__p11439134302116"><strong id="ListInstanceConfigurations__b11219090544312">Explanation</strong>:</p>
<p id="ListInstanceConfigurations__p14439204310219">Number of records to be queried.</p>
<p id="ListInstanceConfigurations__p344016430216"><strong id="ListInstanceConfigurations__b14045417054426">Constraints</strong>:</p>
<p id="ListInstanceConfigurations__p64401243112114">The value must be an integer and cannot be a negative number.</p>
<p id="ListInstanceConfigurations__p124404437210"><strong id="ListInstanceConfigurations__b3479949854434">Value range</strong>:</p>
<p id="ListInstanceConfigurations__p944054392116">1–100</p>
<p id="ListInstanceConfigurations__p7440124319213"><strong id="ListInstanceConfigurations__b1174752201112210">Default value</strong>:</p>
<p id="ListInstanceConfigurations__p16440134302111">100</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__table1687519212718" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="ListInstanceConfigurations__en-us_topic_0250674552_en-us_topic_0250674551_row734552019488"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="ListInstanceConfigurations__en-us_topic_0250674552_en-us_topic_0250674551_p63461120114811">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="ListInstanceConfigurations__en-us_topic_0250674552_en-us_topic_0250674551_p234682034817">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.37%" id="mcps1.3.3.2.2.5.1.3"><p id="ListInstanceConfigurations__en-us_topic_0250674552_en-us_topic_0250674551_p334722034816">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40.63%" id="mcps1.3.3.2.2.5.1.4"><p id="ListInstanceConfigurations__en-us_topic_0250674552_en-us_topic_0250674551_p534762020489">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListInstanceConfigurations__en-us_topic_0250674552_en-us_topic_0250674551_row9345132094810"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ListInstanceConfigurations__en-us_topic_0250674552_en-us_topic_0250674551_p203489208489">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ListInstanceConfigurations__en-us_topic_0250674552_en-us_topic_0250674551_p934819209484">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="19.37%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ListInstanceConfigurations__en-us_topic_0250674552_en-us_topic_0250674551_p1634972015484">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.63%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ListInstanceConfigurations__en-us_topic_0250674552_p12618376712"><strong id="ListInstanceConfigurations__en-us_topic_0250674552_b511395416513">Explanation</strong>:</p>
<p id="ListInstanceConfigurations__en-us_topic_0250674552_en-us_topic_0250674551_p334942054817">User token.</p>
<p id="ListInstanceConfigurations__en-us_topic_0250674552_en-us_topic_0250674551_p128967161819">To obtain this value, call the IAM API for <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">obtaining a user token</a>.</p>
<p id="ListInstanceConfigurations__en-us_topic_0250674552_en-us_topic_0250674551_p761518203166">The value of <strong id="ListInstanceConfigurations__en-us_topic_0250674552_b159103391468">X-Subject-Token</strong> in the response header is the token value.</p>
<p id="ListInstanceConfigurations__en-us_topic_0250674552_p448211593713"><strong id="ListInstanceConfigurations__en-us_topic_0250674552_b5953018241">Constraints</strong>:</p>
<p id="ListInstanceConfigurations__en-us_topic_0250674552_p54829591477">None</p>
<p id="ListInstanceConfigurations__en-us_topic_0250674552_p4482105911716"><strong id="ListInstanceConfigurations__en-us_topic_0250674552_b933792718418">Value range</strong>:</p>
<p id="ListInstanceConfigurations__en-us_topic_0250674552_p6482759877">None</p>
<p id="ListInstanceConfigurations__en-us_topic_0250674552_p4482459976"><strong id="ListInstanceConfigurations__en-us_topic_0250674552_b143761659031">Default value</strong>:</p>
<p id="ListInstanceConfigurations__en-us_topic_0250674552_p24821159279">None</p>
</td>
</tr>
<tr id="ListInstanceConfigurations__en-us_topic_0250674552_en-us_topic_0250674551_row334572019482"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ListInstanceConfigurations__en-us_topic_0250674552_en-us_topic_0250674551_p33501320154810">X-Language</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ListInstanceConfigurations__en-us_topic_0250674552_en-us_topic_0250674551_p2035072034816">No</p>
</td>
<td class="cellrowborder" valign="top" width="19.37%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ListInstanceConfigurations__en-us_topic_0250674552_en-us_topic_0250674551_p3350320184817">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.63%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ListInstanceConfigurations__en-us_topic_0250674552_p1867119101089"><strong id="ListInstanceConfigurations__en-us_topic_0250674552_b41841351437">Explanation</strong>:</p>
<p id="ListInstanceConfigurations__en-us_topic_0250674552_p267181012815">Request language type.</p>
<p id="ListInstanceConfigurations__en-us_topic_0250674552_p1767111015818"><strong id="ListInstanceConfigurations__en-us_topic_0250674552_b169544181449">Constraints</strong>:</p>
<p id="ListInstanceConfigurations__en-us_topic_0250674552_p1967181013811">None</p>
<p id="ListInstanceConfigurations__en-us_topic_0250674552_p146711610384"><strong id="ListInstanceConfigurations__en-us_topic_0250674552_b1633915275411">Value range</strong>:</p>
<ul id="ListInstanceConfigurations__en-us_topic_0250674552_ul26711710582"><li id="ListInstanceConfigurations__en-us_topic_0250674552_li126719108818">en-us</li><li id="ListInstanceConfigurations__en-us_topic_0250674552_li1067111102810">zh-cn</li></ul>
<p id="ListInstanceConfigurations__en-us_topic_0250674552_p1367120106817"><strong id="ListInstanceConfigurations__en-us_topic_0250674552_b2037817591736">Default value</strong>:</p>
<p id="ListInstanceConfigurations__en-us_topic_0250674552_p36711210080">en-us</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="20%" id="mcps1.3.4.3.2.4.1.1"><p id="ListInstanceConfigurations__p315141910250">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="ListInstanceConfigurations__p915181915258">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" 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="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListInstanceConfigurations__p14152619162511">configurations</p>
</td>
<td class="cellrowborder" valign="top" width="20%" 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="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListInstanceConfigurations__p1176095714295"><strong id="ListInstanceConfigurations__b7391314984312">Explanation</strong>:</p>
<p id="ListInstanceConfigurations__p376095712919">Instance parameter template information.</p>
</td>
</tr>
<tr id="ListInstanceConfigurations__row1515031917256"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListInstanceConfigurations__p19153111910259">total_count</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListInstanceConfigurations__p6153019172518">Long</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListInstanceConfigurations__p676145722914"><strong id="ListInstanceConfigurations__b14360474774312">Explanation</strong>:</p>
<p id="ListInstanceConfigurations__p17761757112920">Total number of instance parameters.</p>
<p id="ListInstanceConfigurations__p976165722916"><strong id="ListInstanceConfigurations__b9580070334434">Value range</strong>:</p>
<p id="ListInstanceConfigurations__p1676145719295">≥0</p>
</td>
</tr>
<tr id="ListInstanceConfigurations__row915015191252"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListInstanceConfigurations__p181537197259">parameter_values</p>
</td>
<td class="cellrowborder" valign="top" width="20%" 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="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListInstanceConfigurations__p157619579294"><strong id="ListInstanceConfigurations__b21091011404312">Explanation</strong>:</p>
<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="20%" id="mcps1.3.4.4.2.4.1.1"><p id="ListInstanceConfigurations__p515619194258">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="ListInstanceConfigurations__p515691982511">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" 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="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstanceConfigurations__p1615712191251">datastore_version_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstanceConfigurations__p1815701902516">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstanceConfigurations__p3531692307"><strong id="ListInstanceConfigurations__b10588722204312">Explanation</strong>:</p>
<p id="ListInstanceConfigurations__p19531129173016">DB version name.</p>
<p id="ListInstanceConfigurations__p11531129193011"><strong id="ListInstanceConfigurations__b2194113174434">Value range</strong>:</p>
<p id="ListInstanceConfigurations__p1553169113014">2.0</p>
</td>
</tr>
<tr id="ListInstanceConfigurations__row1115511962519"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstanceConfigurations__p11157171962510">datastore_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstanceConfigurations__p4158101922517">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstanceConfigurations__p195315918301"><strong id="ListInstanceConfigurations__b17708787424312">Explanation</strong>:</p>
<p id="ListInstanceConfigurations__p18531119193016">DB engine name in the parameter template.</p>
<p id="ListInstanceConfigurations__p18531694307"><strong id="ListInstanceConfigurations__b9738150464434">Value range</strong>:</p>
<p id="ListInstanceConfigurations__p11531109143013">taurus</p>
</td>
</tr>
<tr id="ListInstanceConfigurations__row1215513199258"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstanceConfigurations__p17159619142519">created</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstanceConfigurations__p1515941902518">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstanceConfigurations__p1953114920304"><strong id="ListInstanceConfigurations__b12174688114312">Explanation</strong>:</p>
<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>
<p id="ListInstanceConfigurations__p18531139133017"><strong id="ListInstanceConfigurations__b20198447734434">Value range</strong>:</p>
<p id="ListInstanceConfigurations__p1853210911309">None</p>
</td>
</tr>
<tr id="ListInstanceConfigurations__row191551196253"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstanceConfigurations__p1116121913250">updated</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstanceConfigurations__p416171912517">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstanceConfigurations__p195321197301"><strong id="ListInstanceConfigurations__b16742215824312">Explanation</strong>:</p>
<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>
<p id="ListInstanceConfigurations__p175321799305"><strong id="ListInstanceConfigurations__b1581091692">Value range</strong>:</p>
<p id="ListInstanceConfigurations__p65328963015">None</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="20%" id="mcps1.3.4.5.2.4.1.1"><p id="ListInstanceConfigurations__p151630197257">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="ListInstanceConfigurations__p121641819142517">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" 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="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListInstanceConfigurations__p1616401942514">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListInstanceConfigurations__p101641219102510">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListInstanceConfigurations__p3970124516301"><strong id="ListInstanceConfigurations__b11522042024312">Explanation</strong>:</p>
<p id="ListInstanceConfigurations__p119716458305">Parameter name.</p>
<p id="ListInstanceConfigurations__p129711345143017"><strong id="ListInstanceConfigurations__b4346665614434">Value range</strong>:</p>
<p id="ListInstanceConfigurations__p149711745143019">None</p>
</td>
</tr>
<tr id="ListInstanceConfigurations__row1216271919254"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListInstanceConfigurations__p1016511917258">value</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListInstanceConfigurations__p13165131913253">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListInstanceConfigurations__p1971645103014"><strong id="ListInstanceConfigurations__b17003189364312">Explanation</strong>:</p>
<p id="ListInstanceConfigurations__p15971184553019">Parameter value.</p>
<p id="ListInstanceConfigurations__p20971124543015"><strong id="ListInstanceConfigurations__b16482561374434">Value range</strong>:</p>
<p id="ListInstanceConfigurations__p69711445173014">None</p>
</td>
</tr>
<tr id="ListInstanceConfigurations__row1816211912258"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListInstanceConfigurations__p3166131916251">restart_required</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListInstanceConfigurations__p11166111992511">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListInstanceConfigurations__p18971194563010"><strong id="ListInstanceConfigurations__b17939703704312">Explanation</strong>:</p>
<p id="ListInstanceConfigurations__p89711345203018">Whether a reboot is required.</p>
<p id="ListInstanceConfigurations__p1397184520309"><strong id="ListInstanceConfigurations__b15642185654434">Value range</strong>:</p>
<ul id="ListInstanceConfigurations__ul49721645193013"><li id="ListInstanceConfigurations__li109721945103012"><strong id="ListInstanceConfigurations__b650514194210">false</strong>: No</li><li id="ListInstanceConfigurations__li189721045163018"><strong id="ListInstanceConfigurations__b1509145012427">true</strong>: Yes</li></ul>
</td>
</tr>
<tr id="ListInstanceConfigurations__row19162161942517"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListInstanceConfigurations__p916781911252">readonly</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListInstanceConfigurations__p18167201919250">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListInstanceConfigurations__p11972164573010"><strong id="ListInstanceConfigurations__b18328311924312">Explanation</strong>:</p>
<p id="ListInstanceConfigurations__p497274553019">Whether the parameter is read-only.</p>
<p id="ListInstanceConfigurations__p1197204516306"><strong id="ListInstanceConfigurations__b17090258584434">Value range</strong>:</p>
<ul id="ListInstanceConfigurations__ul7972745123015"><li id="ListInstanceConfigurations__li1097254510304"><strong id="ListInstanceConfigurations__b1495185585">false</strong>: No</li><li id="ListInstanceConfigurations__li1297210459308"><strong id="ListInstanceConfigurations__b20660855164413">true</strong>: Yes</li></ul>
</td>
</tr>
<tr id="ListInstanceConfigurations__row1216361932517"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListInstanceConfigurations__p7168121942519">value_range</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListInstanceConfigurations__p131691319172516">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListInstanceConfigurations__p2972104516301"><strong id="ListInstanceConfigurations__b8112460624312">Explanation</strong>:</p>
<p id="ListInstanceConfigurations__p1972194520305">Value range.</p>
<p id="ListInstanceConfigurations__p1397224513309"><strong id="ListInstanceConfigurations__b9781529764434">Value range</strong>:</p>
<p id="ListInstanceConfigurations__p99721245203016">None</p>
</td>
</tr>
<tr id="ListInstanceConfigurations__row161636199259"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListInstanceConfigurations__p21699193251">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListInstanceConfigurations__p191701191254">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListInstanceConfigurations__p897294573011"><strong id="ListInstanceConfigurations__b8344107194312">Explanation</strong>:</p>
<p id="ListInstanceConfigurations__p49720458306">Parameter type.</p>
<p id="ListInstanceConfigurations__p5972345103018"><strong id="ListInstanceConfigurations__b17594272184434">Value range</strong>:</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="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListInstanceConfigurations__p16178519182520">description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListInstanceConfigurations__p1178101916253">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListInstanceConfigurations__p69731453308"><strong id="ListInstanceConfigurations__b18433735194312">Explanation</strong>:</p>
<p id="ListInstanceConfigurations__p1497334543019">Parameter description.</p>
<p id="ListInstanceConfigurations__p8973945133017"><strong id="ListInstanceConfigurations__b11297138414434">Value range</strong>:</p>
<p id="ListInstanceConfigurations__p1597354593018">None</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",
"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