forked from docs/doc-exports
Ru, Li Yi
d97aea4dd2
Reviewed-by: Boka, Ladislav <ladislav.boka@t-systems.com> Co-authored-by: Ru, Li Yi <liyiru7@huawei.com> Co-committed-by: Ru, Li Yi <liyiru7@huawei.com>
186 lines
17 KiB
HTML
186 lines
17 KiB
HTML
<a name="EN-US_TOPIC_0000001947569493"></a><a name="EN-US_TOPIC_0000001947569493"></a>
|
|
|
|
<h1 class="topictitle1">Obtaining the Parameters of a Specified DB Instance</h1>
|
|
<div id="body0000001222085664"><div class="section" id="EN-US_TOPIC_0000001947569493__section12668113135415"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001947569493__p1666812313549">This API is used to obtain parameters of a specified DB instance. Before calling this API:</p>
|
|
<ul id="EN-US_TOPIC_0000001947569493__en-us_topic_0128427213_ul12259155218373"><li id="EN-US_TOPIC_0000001947569493__en-us_topic_0000001917290508_en-us_topic_0000001791349281_li3231171417412">Learn how to <a href="opengauss_api_0010.html">authenticate</a> this API.</li><li id="EN-US_TOPIC_0000001947569493__en-us_topic_0000001917290508_en-us_topic_0000001791349281_li41227910453">Understand the API in <a href="opengauss_api_0012.html">Using APIs</a>.</li><li id="EN-US_TOPIC_0000001947569493__en-us_topic_0000001917290508_en-us_topic_0000001791349281_en-us_topic_0110967248_li1991981933613">Obtain the required <a href="https://docs.otc.t-systems.com/regions-and-endpoints/index.html" target="_blank" rel="noopener noreferrer">region and endpoint</a>.</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001947569493__section13668123145413"><h4 class="sectiontitle">URI</h4><ul id="EN-US_TOPIC_0000001947569493__ul3242510151211"><li id="EN-US_TOPIC_0000001947569493__li224201018124">URI format<p id="EN-US_TOPIC_0000001947569493__p1566812375412"><a name="EN-US_TOPIC_0000001947569493__li224201018124"></a><a name="li224201018124"></a>GET https://{<em id="EN-US_TOPIC_0000001947569493__en-us_topic_0128427213_i1958383021511">Endpoint</em>}/v3/{project_id}/instances/{instance_id}/configurations</p>
|
|
</li></ul>
|
|
<ul id="EN-US_TOPIC_0000001947569493__ul88621256125"><li id="EN-US_TOPIC_0000001947569493__li1286272571211">Example<p id="EN-US_TOPIC_0000001947569493__en-us_topic_0128427213_p1454414211213"><a name="EN-US_TOPIC_0000001947569493__li1286272571211"></a><a name="li1286272571211"></a>https://gaussdb.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/configurations</p>
|
|
</li></ul>
|
|
<ul id="EN-US_TOPIC_0000001947569493__ul3577742191518"><li id="EN-US_TOPIC_0000001947569493__li55771842161516">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001947569493__table176691638549" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001947569493__row106681139548"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.1.1.2.5.1.1"><p id="EN-US_TOPIC_0000001947569493__p4669183205414">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.1.1.2.5.1.2"><p id="EN-US_TOPIC_0000001947569493__p16698395419">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.1.1.2.5.1.3"><p id="EN-US_TOPIC_0000001947569493__p266911312549">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.1.1.2.5.1.4"><p id="EN-US_TOPIC_0000001947569493__p466918312542">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001947569493__row16695385411"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.1.1.2.5.1.1 "><p id="EN-US_TOPIC_0000001947569493__p4669432543">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.1.1.2.5.1.2 "><p id="EN-US_TOPIC_0000001947569493__p14670183155419">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.1.1.2.5.1.3 "><p id="EN-US_TOPIC_0000001947569493__p11670173195419">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.1.1.2.5.1.4 "><p id="EN-US_TOPIC_0000001947569493__p1136115342816">Project ID of a tenant in a region.</p>
|
|
<p id="EN-US_TOPIC_0000001947569493__p8544202712219">To obtain this value, see <a href="opengauss_api_0034.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001947569493__row166912375413"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.1.1.2.5.1.1 "><p id="EN-US_TOPIC_0000001947569493__p767017314541">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.1.1.2.5.1.2 "><p id="EN-US_TOPIC_0000001947569493__p1367013310549">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.1.1.2.5.1.3 "><p id="EN-US_TOPIC_0000001947569493__p667011345414">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.1.1.2.5.1.4 "><p id="EN-US_TOPIC_0000001947569493__p66701538545">DB instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001947569493__section55111622204012"><h4 class="sectiontitle">Request</h4><p id="EN-US_TOPIC_0000001947569493__p580213132162">None</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001947569493__section06732355411"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0000001947569493__ul131292916173"><li id="EN-US_TOPIC_0000001947569493__li11312142901720">Normal response
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001947569493__response_ConfigurationDetailForInstance" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001947569493__row967417395415"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="EN-US_TOPIC_0000001947569493__p106741836543">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="EN-US_TOPIC_0000001947569493__p156741355410">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="EN-US_TOPIC_0000001947569493__p4674533542">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001947569493__row196741634542"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="EN-US_TOPIC_0000001947569493__p126746311544">datastore_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="EN-US_TOPIC_0000001947569493__p167515315548">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="EN-US_TOPIC_0000001947569493__p5675331542">Engine version.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001947569493__row166744310548"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="EN-US_TOPIC_0000001947569493__p56752385413">datastore_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="EN-US_TOPIC_0000001947569493__p146752316548">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="EN-US_TOPIC_0000001947569493__p19675193125411">Engine name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001947569493__row1367413365412"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="EN-US_TOPIC_0000001947569493__p1967510317541">created</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="EN-US_TOPIC_0000001947569493__p8675236541">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="EN-US_TOPIC_0000001947569493__p3676163165418">Creation time in the "yyyy-MM-dd HH:mm:ss" format.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001947569493__row367419312545"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="EN-US_TOPIC_0000001947569493__p206761639549">updated</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="EN-US_TOPIC_0000001947569493__p56761738549">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="EN-US_TOPIC_0000001947569493__p967616325417">Update time in the "yyyy-MM-ddHH:mm:ss" format.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001947569493__row5674538548"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="EN-US_TOPIC_0000001947569493__p36765355415">configuration_parameters</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="EN-US_TOPIC_0000001947569493__p26761237549">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="EN-US_TOPIC_0000001947569493__p166779319549">Parameters defined by users based on the default parameter templates. For details, see <a href="#EN-US_TOPIC_0000001947569493__response_ConfigurationParameter">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001947569493__response_ConfigurationParameter"></a><a name="response_ConfigurationParameter"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001947569493__response_ConfigurationParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>configuration_parameters field data structure description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001947569493__row206779315420"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="EN-US_TOPIC_0000001947569493__p1167773125417">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="EN-US_TOPIC_0000001947569493__p567812320548">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="EN-US_TOPIC_0000001947569493__p186781439543">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001947569493__row167718317547"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001947569493__p19678234547">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001947569493__p6678163125417">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001947569493__p96784315416">Parameter name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001947569493__row176771836546"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001947569493__p106784313545">value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001947569493__p146784317549">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001947569493__p46791637541">Parameter value.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001947569493__row4677635541"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001947569493__p96799312543">restart_required</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001947569493__p1867919313543">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001947569493__p17679139546">Whether a reboot is required after the parameter is modified.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001947569493__row4677153115415"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001947569493__p10679139543">value_range</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001947569493__p106791034544">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001947569493__p3679735549">Parameter value range.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001947569493__row96771339544"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001947569493__p16801933544">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001947569493__p668010325419">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001947569493__p106809314548">Parameter type. The value can be <strong id="EN-US_TOPIC_0000001947569493__b71460328410647">string</strong>, <strong id="EN-US_TOPIC_0000001947569493__b147782669810647">integer</strong>, <strong id="EN-US_TOPIC_0000001947569493__b110461157010647">boolean</strong>, <strong id="EN-US_TOPIC_0000001947569493__b194890340110647">list</strong>, or <strong id="EN-US_TOPIC_0000001947569493__b164338000310647">float</strong>.</p>
|
|
<p id="EN-US_TOPIC_0000001947569493__p11680173105418">Value:</p>
|
|
<ul id="EN-US_TOPIC_0000001947569493__ul4680734548"><li id="EN-US_TOPIC_0000001947569493__li36803318543"><strong id="EN-US_TOPIC_0000001947569493__b2068016315545">string</strong></li><li id="EN-US_TOPIC_0000001947569493__li176809325415"><strong id="EN-US_TOPIC_0000001947569493__b196809365410">integer</strong></li><li id="EN-US_TOPIC_0000001947569493__li3680438544"><strong id="EN-US_TOPIC_0000001947569493__b116809315419">boolean</strong></li><li id="EN-US_TOPIC_0000001947569493__li96802345411"><strong id="EN-US_TOPIC_0000001947569493__b11681113155419">list</strong></li><li id="EN-US_TOPIC_0000001947569493__li36818335418"><strong id="EN-US_TOPIC_0000001947569493__b1768110375414">float</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001947569493__row36771833549"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001947569493__p16811737543">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001947569493__p46811634541">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001947569493__p1668118395413">Parameter description.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001947569493__section106841036544"><h4 class="sectiontitle">Example Response</h4><ul id="EN-US_TOPIC_0000001947569493__ul178871044102018"><li id="EN-US_TOPIC_0000001947569493__li588734462014">Normal response<pre class="codeblock" id="EN-US_TOPIC_0000001947569493__codeblock12027109481">{
|
|
"created": "2022-04-11 10:46:59",
|
|
"updated": "2022-04-11 10:46:59",
|
|
"datastore_version": "2.0",
|
|
"datastore_name": "<span id="EN-US_TOPIC_0000001947569493__text522679429">GaussDB</span>(for openGauss)",
|
|
"configuration_parameters": [
|
|
{
|
|
"name": "audit_system_object",
|
|
"value": "12295",
|
|
"type": "integer",
|
|
"description": "Whether to audit the CREATE, DROP, and ALTER operations on database objects",
|
|
"restart_required": false,
|
|
"value_range": "0-2097151"
|
|
}
|
|
]
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<ul id="EN-US_TOPIC_0000001947569493__en-us_topic_0248254028_ul1135712981319"><li id="EN-US_TOPIC_0000001947569493__en-us_topic_0248254028_li2072718551485">Abnormal response<p id="EN-US_TOPIC_0000001947569493__en-us_topic_0000001704033841_en-us_topic_0128427213_p29415884"><a name="EN-US_TOPIC_0000001947569493__en-us_topic_0248254028_li2072718551485"></a><a name="en-us_topic_0248254028_li2072718551485"></a>For details, see <a href="opengauss_api_0031.html">Abnormal Request Results</a>.</p>
|
|
</li></ul>
|
|
<div class="section" id="EN-US_TOPIC_0000001947569493__en-us_topic_0128427213_section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="EN-US_TOPIC_0000001947569493__en-us_topic_0110967248_ul7858132212142"><li id="EN-US_TOPIC_0000001947569493__en-us_topic_0110967248_li58581622171411">Normal<p id="EN-US_TOPIC_0000001947569493__en-us_topic_0110967248_p1040982941020"><a name="EN-US_TOPIC_0000001947569493__en-us_topic_0110967248_li58581622171411"></a><a name="en-us_topic_0110967248_li58581622171411"></a>200</p>
|
|
</li><li id="EN-US_TOPIC_0000001947569493__en-us_topic_0110967248_li11583183218149">Abnormal<p id="EN-US_TOPIC_0000001947569493__en-us_topic_0110967248_p65078394148"><a name="EN-US_TOPIC_0000001947569493__en-us_topic_0110967248_li11583183218149"></a><a name="en-us_topic_0110967248_li11583183218149"></a>For details, see <a href="opengauss_api_0032.html">Status Codes</a>.</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001947569493__en-us_topic_0248254028_section946032144017"><h4 class="sectiontitle">Error Code</h4><p id="EN-US_TOPIC_0000001947569493__en-us_topic_0000001704033841_en-us_topic_0110967248_p19357163913406">For details, see <a href="opengauss_api_0033.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="opengauss_api_0023.html">Parameter Configuration</a></div>
|
|
</div>
|
|
</div>
|
|
|