forked from docs/doc-exports
wangdengke2
1ddaec1a62
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>
156 lines
15 KiB
HTML
156 lines
15 KiB
HTML
<a name="rds_11_0014"></a><a name="rds_11_0014"></a>
|
|
|
|
<h1 class="topictitle1">Obtaining the Value of a Specified Parameter for an Instance</h1>
|
|
<div id="body0000002462591361"><div class="section" id="rds_11_0014__en-us_topic_0245436637_section4850156117316"><h4 class="sectiontitle">Function</h4><p id="rds_11_0014__en-us_topic_0245436637_p52780252141331">This API is used to obtain the value of a specified parameter for an instance.</p>
|
|
<ul id="rds_11_0014__ul10163594121"><li id="rds_11_0014__en-us_topic_0240111818_li836513175363">Before calling an API, you need to understand the API in <a href="rds_03_0001.html">Authentication</a>.</li><li id="rds_11_0014__en-us_topic_0240111818_li1991981933613">Before calling this API, obtain the required <a href="https://docs.otc.t-systems.com/en-us/endpoint/index.html" target="_blank" rel="noopener noreferrer">region and endpoint</a>.</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_11_0014__en-us_topic_0245436637_section102419107473"><h4 class="sectiontitle">Constraints</h4><ul id="rds_11_0014__ul182851057183112"><li id="rds_11_0014__li17285115714311">This operation cannot be performed when the instance is in the abnormal state.</li><li id="rds_11_0014__li16285657203118">Only the value of <strong id="rds_11_0014__b17129112952011">shared_preload_libraries</strong> can be queried.</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_11_0014__en-us_topic_0245436637_section28961517113719"><h4 class="sectiontitle">URI</h4><ul id="rds_11_0014__en-us_topic_0245436637_ul16391217184115"><li id="rds_11_0014__en-us_topic_0245436637_li363951734111">URI format<p id="rds_11_0014__en-us_topic_0245436637_p1363971724110"><a name="rds_11_0014__en-us_topic_0245436637_li363951734111"></a><a name="en-us_topic_0245436637_li363951734111"></a>GET /v3/{project_id}/instances/{instance_id}/parameter/{name}</p>
|
|
</li><li id="rds_11_0014__li1165156204511">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_11_0014__en-us_topic_0245436637_table4657088" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters</caption><thead align="left"><tr id="rds_11_0014__en-us_topic_0245436637_row60083059"><th align="left" class="cellrowborder" valign="top" width="20.93%" id="mcps1.3.3.2.2.1.2.4.1.1"><p id="rds_11_0014__en-us_topic_0245436637_p34889605"><strong id="rds_11_0014__b1215864516426">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.6%" id="mcps1.3.3.2.2.1.2.4.1.2"><p id="rds_11_0014__en-us_topic_0245436637_p7485743"><strong id="rds_11_0014__b658717142114">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="62.470000000000006%" id="mcps1.3.3.2.2.1.2.4.1.3"><p id="rds_11_0014__en-us_topic_0245436637_p2365466"><strong id="rds_11_0014__b2865929214">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_11_0014__en-us_topic_0245436637_row57385070"><td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.3.2.2.1.2.4.1.1 "><p id="rds_11_0014__en-us_topic_0245436637_p17679057">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.6%" headers="mcps1.3.3.2.2.1.2.4.1.2 "><p id="rds_11_0014__en-us_topic_0245436637_p22717550">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="62.470000000000006%" headers="mcps1.3.3.2.2.1.2.4.1.3 "><p id="rds_11_0014__en-us_topic_0285677743_en-us_topic_0144420999_p28182251">Specifies the project ID of a tenant in a region.</p>
|
|
<p id="rds_11_0014__en-us_topic_0285677743_en-us_topic_0144420999_p27281110194">For details about how to obtain the project ID, see <a href="rds_03_0002.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_11_0014__en-us_topic_0245436637_row2864326155157"><td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.3.2.2.1.2.4.1.1 "><p id="rds_11_0014__en-us_topic_0245436637_p41557789155220">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.6%" headers="mcps1.3.3.2.2.1.2.4.1.2 "><p id="rds_11_0014__en-us_topic_0245436637_p10737742155220">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="62.470000000000006%" headers="mcps1.3.3.2.2.1.2.4.1.3 "><p id="rds_11_0014__en-us_topic_0285677743_en-us_topic_0144420999_p64450739155220">Specifies the DB instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_11_0014__row1380322317343"><td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.3.2.2.1.2.4.1.1 "><p id="rds_11_0014__p188174353414">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.6%" headers="mcps1.3.3.2.2.1.2.4.1.2 "><p id="rds_11_0014__p988843153413">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="62.470000000000006%" headers="mcps1.3.3.2.2.1.2.4.1.3 "><p id="rds_11_0014__p654613108402">Parameter name.</p>
|
|
<p id="rds_11_0014__p10691102654010">Only the <strong id="rds_11_0014__b10300165515417">shared_preload_libraries</strong> parameter can be modified.</p>
|
|
<p id="rds_11_0014__p72931151193516">The default value is <strong id="rds_11_0014__b1319123145910">shared_preload_libraries</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_11_0014__en-us_topic_0245436637_section3074340117316"><h4 class="sectiontitle">Request</h4><ul id="rds_11_0014__en-us_topic_0245436637_ul5099287616954"><li id="rds_11_0014__en-us_topic_0245436637_li5628270116954">Request parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_11_0014__table12536623333" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="rds_11_0014__row153612211337"><th align="left" class="cellrowborder" valign="top" width="19.7%" id="mcps1.3.4.2.1.1.2.5.1.1"><p id="rds_11_0014__p95111733143318">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.780000000000001%" id="mcps1.3.4.2.1.1.2.5.1.2"><p id="rds_11_0014__p13511123373311">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.959999999999999%" id="mcps1.3.4.2.1.1.2.5.1.3"><p id="rds_11_0014__p125111433133312">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53.559999999999995%" id="mcps1.3.4.2.1.1.2.5.1.4"><p id="rds_11_0014__p551110331335">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_11_0014__row05378213331"><td class="cellrowborder" valign="top" width="19.7%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="rds_11_0014__p1163015550331">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.780000000000001%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="rds_11_0014__p1963035563316">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.959999999999999%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="rds_11_0014__p1630105520331">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.559999999999995%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="rds_11_0014__p1086851153317">Specifies the user token.</p>
|
|
<p id="rds_11_0014__p1057635831">The user token is a response to the API used to <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">obtain a user token</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="rds_11_0014__en-us_topic_0245436637_li4411135064210">Example<p id="rds_11_0014__en-us_topic_0245436637_p1454414211213"><a name="rds_11_0014__en-us_topic_0245436637_li4411135064210"></a><a name="en-us_topic_0245436637_li4411135064210"></a>GET https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/f569f1358436479dbcba8603c32cc4aein03/parameter/shared_preload_libraries</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_11_0014__en-us_topic_0245436637_section28521534113742"><h4 class="sectiontitle">Response</h4><ul id="rds_11_0014__en-us_topic_0245436637_ul12573920"><li id="rds_11_0014__en-us_topic_0245436637_li46056421">Normal response
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_11_0014__en-us_topic_0245436637_table32267243" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameters</caption><thead align="left"><tr id="rds_11_0014__en-us_topic_0245436637_row9230088"><th align="left" class="cellrowborder" valign="top" width="27.382738273827385%" id="mcps1.3.5.2.1.1.2.4.1.1"><p id="rds_11_0014__en-us_topic_0245436637_p9439626"><strong id="rds_11_0014__b851853119430">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="27.122712271227122%" id="mcps1.3.5.2.1.1.2.4.1.2"><p id="rds_11_0014__en-us_topic_0245436637_p26412257"><strong id="rds_11_0014__b090470182211">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="45.4945494549455%" id="mcps1.3.5.2.1.1.2.4.1.3"><p id="rds_11_0014__en-us_topic_0245436637_p59018101"><strong id="rds_11_0014__b204816222215">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_11_0014__row15224185985013"><td class="cellrowborder" valign="top" width="27.382738273827385%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="rds_11_0014__p8306920155116">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.122712271227122%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="rds_11_0014__p93060205515">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.4945494549455%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="rds_11_0014__p651345563416">Parameter name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_11_0014__row9727125675014"><td class="cellrowborder" valign="top" width="27.382738273827385%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="rds_11_0014__p3306320135119">value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.122712271227122%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="rds_11_0014__p5306520175110">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.4945494549455%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="rds_11_0014__p1104175893411">Parameter value.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_11_0014__row169617545501"><td class="cellrowborder" valign="top" width="27.382738273827385%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="rds_11_0014__p030618202518">restart_required</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.122712271227122%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="rds_11_0014__p730610207514">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.4945494549455%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="rds_11_0014__p16428144213516">Whether a reboot is required.</p>
|
|
<ul id="rds_11_0014__ul8428114235119"><li id="rds_11_0014__li114291442135116"><strong id="rds_11_0014__b640291642216">true</strong>: A reboot is required.</li><li id="rds_11_0014__li1342918425512"><strong id="rds_11_0014__b1919117181222">false</strong>: A reboot is not required.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_11_0014__row157132529502"><td class="cellrowborder" valign="top" width="27.382738273827385%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="rds_11_0014__p8307132085115">value_range</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.122712271227122%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="rds_11_0014__p630702015514">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.4945494549455%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="rds_11_0014__p1462735515416">Parameter value range.</p>
|
|
<p id="rds_11_0014__p18307142035113">If the parameter type is <strong id="rds_11_0014__b552104193518">integer</strong>, the value is <strong id="rds_11_0014__b25316423518">0</strong> or <strong id="rds_11_0014__b19531142359">1</strong>. If the type is <strong id="rds_11_0014__b85319493513">boolean</strong>, the value is <strong id="rds_11_0014__b453047355">true</strong> or <strong id="rds_11_0014__b145314417358">false</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_11_0014__row184363503505"><td class="cellrowborder" valign="top" width="27.382738273827385%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="rds_11_0014__p1530782095116">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.122712271227122%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="rds_11_0014__p53071620145113">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.4945494549455%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="rds_11_0014__p93768104215">Parameter type.</p>
|
|
<p id="rds_11_0014__p830718207514">The value can be <strong id="rds_11_0014__b17514164343513">string</strong>, <strong id="rds_11_0014__b1251424316351">integer</strong>, <strong id="rds_11_0014__b851434310356">boolean</strong>, <strong id="rds_11_0014__b16514143143510">list</strong>, or <strong id="rds_11_0014__b115141143133519">float</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_11_0014__en-us_topic_0245436637_row15736877"><td class="cellrowborder" valign="top" width="27.382738273827385%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="rds_11_0014__p5307192045117">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.122712271227122%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="rds_11_0014__p16307920125110">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.4945494549455%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="rds_11_0014__p15307020185113">Parameter description.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="rds_11_0014__li10521103115432">Example normal response<pre class="screen" id="rds_11_0014__screen1710262635614">{
|
|
"name" : "shared_preload_libraries",
|
|
"value" : "passwordcheck.so,pg_sql_history",
|
|
"restart_required" : true,
|
|
"value_range" : "passwordcheck.so,pg_stat_statements,pg_sql_history",
|
|
"type" : "list",
|
|
"description" : "Lists shared libraries to preload into server."
|
|
}</pre>
|
|
</li><li id="rds_11_0014__li1930710290432">Abnormal response<p id="rds_11_0014__p46896054"><a name="rds_11_0014__li1930710290432"></a><a name="li1930710290432"></a>For details, see <a href="en-us_topic_0032488197.html">Abnormal Request Results</a>.</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_11_0014__section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="rds_11_0014__en-us_topic_0032347778_ul7858132212142"><li id="rds_11_0014__en-us_topic_0032347778_li58581622171411">Normal<p id="rds_11_0014__en-us_topic_0032347778_p1040982941020"><a name="rds_11_0014__en-us_topic_0032347778_li58581622171411"></a><a name="en-us_topic_0032347778_li58581622171411"></a>200</p>
|
|
</li><li id="rds_11_0014__en-us_topic_0032347778_li11583183218149">Abnormal<p id="rds_11_0014__en-us_topic_0032347778_p0723374409"><a name="rds_11_0014__en-us_topic_0032347778_li11583183218149"></a><a name="en-us_topic_0032347778_li11583183218149"></a>For details, see <a href="en-us_topic_0032488240.html">Status Codes</a>.</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_11_0014__section1183074220016"><h4 class="sectiontitle">Error Code</h4><p id="rds_11_0014__en-us_topic_0032347778_p19357163913406">For details, see <a href="en-us_topic_0032488241.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="rds_11_0025.html">Extension Management (RDS for PostgreSQL)</a></div>
|
|
</div>
|
|
</div>
|
|
|