forked from docs/doc-exports
Wang , Deng Ke
5208dcae7b
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: Wang , Deng Ke <wangdengke2@huawei.com> Co-committed-by: Wang , Deng Ke <wangdengke2@huawei.com>
144 lines
13 KiB
HTML
144 lines
13 KiB
HTML
<a name="en-us_topic_0056890258"></a><a name="en-us_topic_0056890258"></a>
|
|
|
|
<h1 class="topictitle1">Obtaining Information About Configuration Parameters</h1>
|
|
<div id="body1492603082526"><div class="section" id="en-us_topic_0056890258__section66864413102314"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0056890258__p47308336102314">This API is used to obtain information about parameters that can be modified of a specified database version.</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0056890258__section23121848102314"><h4 class="sectiontitle">URI</h4><ul id="en-us_topic_0056890258__ul60930408102314"><li id="en-us_topic_0056890258__li11502762102314">URI format<p id="en-us_topic_0056890258__p36415996102314"><a name="en-us_topic_0056890258__li11502762102314"></a><a name="li11502762102314"></a>PATH: /v1.0/{project_id}/datastores/versions/{datastore_version_id}/parameters/{parameter_name}</p>
|
|
<p id="en-us_topic_0056890258__p59308511102314">Method: GET</p>
|
|
</li><li id="en-us_topic_0056890258__li64014557102314">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0056890258__table39260101102314" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="en-us_topic_0056890258__row53407996102314"><th align="left" class="cellrowborder" valign="top" width="26.52%" id="mcps1.3.2.2.2.1.2.4.1.1"><p id="en-us_topic_0056890258__p31080435102314"><strong id="en-us_topic_0056890258__b84235270691445_1">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="39.97%" id="mcps1.3.2.2.2.1.2.4.1.2"><p id="en-us_topic_0056890258__p34487335102314"><strong id="en-us_topic_0056890258__b842352706102346_1">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.51%" id="mcps1.3.2.2.2.1.2.4.1.3"><p id="en-us_topic_0056890258__p42010751102314"><strong id="en-us_topic_0056890258__b842352706163417_1">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0056890258__row47427684102314"><td class="cellrowborder" valign="top" width="26.52%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="en-us_topic_0056890258__p16437181102314">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.97%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="en-us_topic_0056890258__p56343283102314">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.51%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="en-us_topic_0056890258__p403181102314">Specifies the project ID of a tenant in a region.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0056890258__row3628631102314"><td class="cellrowborder" valign="top" width="26.52%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="en-us_topic_0056890258__p25483699102314">datastore_version_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.97%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="en-us_topic_0056890258__p50913735102314">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.51%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="en-us_topic_0056890258__p30371900102314">Specifies the database version ID (<strong id="en-us_topic_0056890258__b842352706195851">dataStores.id</strong> in the response message in <a href="en-us_topic_0032347782.html">Database Version Queries</a>).</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0056890258__row4911650102314"><td class="cellrowborder" valign="top" width="26.52%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="en-us_topic_0056890258__p62299403102314">parameter_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.97%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="en-us_topic_0056890258__p13086888102314">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.51%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="en-us_topic_0056890258__p53405026102314">Specifies the parameter name.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="en-us_topic_0056890258__ul30839840102314"><li id="en-us_topic_0056890258__li273646671817">Restrictions<p id="en-us_topic_0056890258__p57152011145532"><a name="en-us_topic_0056890258__li273646671817"></a><a name="li273646671817"></a>Currently, only the DB engines MySQL and PostgreSQL are supported by the API.</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0056890258__section8775048102314"><h4 class="sectiontitle">Request</h4><p id="en-us_topic_0056890258__p39690289102314">None</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0056890258__section21668289102314"><h4 class="sectiontitle">Normal Response</h4><ul id="en-us_topic_0056890258__ul10300970102314"><li id="en-us_topic_0056890258__li25599870102314">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0056890258__table29836925102154" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="en-us_topic_0056890258__row8341487102154"><th align="left" class="cellrowborder" valign="top" width="25.509999999999998%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="en-us_topic_0056890258__p4571867102154"><strong id="en-us_topic_0056890258__b84235270691445_5">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40.82%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="en-us_topic_0056890258__p34776980102154"><strong id="en-us_topic_0056890258__b842352706164541_1">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.67%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="en-us_topic_0056890258__p65472001102154"><strong id="en-us_topic_0056890258__b842352706163417_5">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0056890258__row1631883102154"><td class="cellrowborder" valign="top" width="25.509999999999998%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="en-us_topic_0056890258__p65073689102154">configuration-parameters</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.82%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="en-us_topic_0056890258__p36477460102154">List data structure. For details, see <a href="#en-us_topic_0056890258__table29072240102314">Table 3</a>.</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.67%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="en-us_topic_0056890258__p16958334102154">Indicates all the parameters that can be modified of the database version.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="en-us_topic_0056890258__table29072240102314"></a><a name="table29072240102314"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0056890258__table29072240102314" 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_0056890258__row43813852102314"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="en-us_topic_0056890258__p59261153102314"><strong id="en-us_topic_0056890258__b84235270691445_7">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="en-us_topic_0056890258__p35424111102314"><strong id="en-us_topic_0056890258__b842352706164541_3">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="en-us_topic_0056890258__p50780717102314"><strong id="en-us_topic_0056890258__b842352706163417_7">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0056890258__row19597379102314"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0056890258__p43883866102314">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0056890258__p64932249102314">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0056890258__p25020841102314">Indicates the parameter name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0056890258__row14456442104756"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0056890258__p4894496410489">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0056890258__p511911110489">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0056890258__p1199488410489">Indicates the parameter type, which can be <strong id="en-us_topic_0056890258__b317172548174558">integer</strong>, <strong id="en-us_topic_0056890258__b842352706174612">string</strong>, <strong id="en-us_topic_0056890258__b842352706174617">boolean</strong>, <strong id="en-us_topic_0056890258__b842352706171731">list</strong>, or <strong id="en-us_topic_0056890258__b842352706171734">float</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0056890258__row46156155104849"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0056890258__p1667921104856">max</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0056890258__p883893104856">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0056890258__p4486502104856">Indicates the maximum value of the parameter. Returned only when <strong id="en-us_topic_0056890258__b842352706153657_1">type</strong> is <strong id="en-us_topic_0056890258__b84235270615371_1">integer</strong> or <strong id="en-us_topic_0056890258__b49453009392846_1">float</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0056890258__row23860983102314"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0056890258__p53691459102314">min</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0056890258__p54040883102314">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0056890258__p15235375102314">Indicates the minimum value of the parameter. Returned only when <strong id="en-us_topic_0056890258__b842352706153657_3">type</strong> is <strong id="en-us_topic_0056890258__b84235270615371_3">integer</strong> or <strong id="en-us_topic_0056890258__b49453009392846_3">float</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0056890258__row120052102314"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0056890258__p9724214102314">datastore_version_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0056890258__p49463885102314">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0056890258__p47151777102314">Indicates the database version ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0056890258__row51576887104918"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0056890258__p26569445104925">restart_required</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0056890258__p4641419104925">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0056890258__p40410695104925">Indicates whether the instance needs to reboot for the parameter to take effect. The value is <strong id="en-us_topic_0056890258__b842352706105121">true</strong> or <strong id="en-us_topic_0056890258__b842352706105117">false</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="en-us_topic_0056890258__ul61197593102314"><li id="en-us_topic_0056890258__li13907430102314">Response example<pre class="codeblock" id="en-us_topic_0056890258__codeblock14355873191454">{
|
|
"configuration-parameters": [
|
|
{
|
|
"name": "connect_timeout",
|
|
"type": "integer",
|
|
"max": "31536000",
|
|
"min": "2",
|
|
"datastore_version_id": "e8a8b8cc-63f8-4fb5-8d4a-24c502317a61",
|
|
"restart_required": "false"
|
|
}
|
|
]
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0056890258__section52760080102314"><h4 class="sectiontitle">Abnormal Response</h4><p id="en-us_topic_0056890258__p45708115102314">For details, see <a href="en-us_topic_0032488197.html">Abnormal Request Results</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="rds_06_0022.html">Parameter Configuration</a></div>
|
|
</div>
|
|
</div>
|
|
|