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>
135 lines
12 KiB
HTML
135 lines
12 KiB
HTML
<a name="en-us_topic_0034943370"></a><a name="en-us_topic_0034943370"></a>
|
|
|
|
<h1 class="topictitle1">Obtaining Information About Configuration Parameters</h1>
|
|
<div id="body1470368157652"><div class="section" id="en-us_topic_0034943370__section4850156117316"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0034943370__p52523082175530">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_0034943370__section28961517113719"><h4 class="sectiontitle">URI</h4><ul id="en-us_topic_0034943370__ul3084351717316"><li id="en-us_topic_0034943370__li915620217316">URI format<p id="en-us_topic_0034943370__p41017923141816"><a name="en-us_topic_0034943370__li915620217316"></a><a name="li915620217316"></a>PATH: /rds/v1/{project_id}/datastores/versions/{datastore_version_id}/parameters/{parameter_name}</p>
|
|
<p id="en-us_topic_0034943370__p597222615483">Method: GET</p>
|
|
</li><li id="en-us_topic_0034943370__li15430535">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0034943370__table4657088" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="en-us_topic_0034943370__row60083059"><th align="left" class="cellrowborder" valign="top" width="21.86%" id="mcps1.3.2.2.2.1.2.4.1.1"><p id="en-us_topic_0034943370__p34889605"><strong id="en-us_topic_0034943370__b84235270691445_1">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="27.700000000000003%" id="mcps1.3.2.2.2.1.2.4.1.2"><p id="en-us_topic_0034943370__p7485743"><strong id="en-us_topic_0034943370__b842352706102346_1">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50.44%" id="mcps1.3.2.2.2.1.2.4.1.3"><p id="en-us_topic_0034943370__p2365466"><strong id="en-us_topic_0034943370__b842352706163417_1">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0034943370__row57385070"><td class="cellrowborder" valign="top" width="21.86%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="en-us_topic_0034943370__p17679057">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.700000000000003%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="en-us_topic_0034943370__p22717550">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.44%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="en-us_topic_0034943370__p28182251">Specifies the project ID of a tenant in a region.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0034943370__row2864326155157"><td class="cellrowborder" valign="top" width="21.86%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="en-us_topic_0034943370__p41557789155220">datastore_version_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.700000000000003%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="en-us_topic_0034943370__p10737742155220">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.44%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="en-us_topic_0034943370__p64450739155220">Specifies the database version ID (<strong id="en-us_topic_0034943370__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_0034943370__row2966082217239"><td class="cellrowborder" valign="top" width="21.86%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="en-us_topic_0034943370__p5371637317239">parameter_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.700000000000003%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="en-us_topic_0034943370__p5605898117239">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.44%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="en-us_topic_0034943370__p4448363017239">Specifies the parameter name.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0034943370__section3074340117316"><h4 class="sectiontitle">Request</h4><p id="en-us_topic_0034943370__p718753317316">None</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0034943370__section28521534113742"><h4 class="sectiontitle">Normal Response</h4><ul id="en-us_topic_0034943370__ul43449544"><li id="en-us_topic_0034943370__li55501577">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0034943370__table34207804" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="en-us_topic_0034943370__row41360766"><th align="left" class="cellrowborder" valign="top" width="33.33%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="en-us_topic_0034943370__p61887768"><strong id="en-us_topic_0034943370__b84235270691445_5">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="29.2%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="en-us_topic_0034943370__p46853302"><strong id="en-us_topic_0034943370__b842352706164541">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="37.47%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="en-us_topic_0034943370__p37021121"><strong id="en-us_topic_0034943370__b842352706163417_5">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0034943370__row45920800"><td class="cellrowborder" valign="top" width="33.33%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="en-us_topic_0034943370__p45484399163245">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.2%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="en-us_topic_0034943370__p60357736163245">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="37.47%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="en-us_topic_0034943370__p57138453163245">Indicates the parameter name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0034943370__row49204239"><td class="cellrowborder" valign="top" width="33.33%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="en-us_topic_0034943370__p26120409">min</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.2%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="en-us_topic_0034943370__p35378404">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="37.47%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="en-us_topic_0034943370__p47078488">Indicates the minimum value of the parameter. Returned only when <strong id="en-us_topic_0034943370__b842352706153657_1">type</strong> is <strong id="en-us_topic_0034943370__b84235270615371_1">integer</strong> or <strong id="en-us_topic_0034943370__b84235270692829">float</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0034943370__row21053208"><td class="cellrowborder" valign="top" width="33.33%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="en-us_topic_0034943370__p27588283">max</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.2%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="en-us_topic_0034943370__p20058459">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="37.47%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="en-us_topic_0034943370__p14122463">Indicates the maximum value of the parameter. Returned only when <strong id="en-us_topic_0034943370__b842352706153657_3">type</strong> is <strong id="en-us_topic_0034943370__b84235270615371_3">integer</strong> or <strong id="en-us_topic_0034943370__b49453009392846">float</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0034943370__row23955898163837"><td class="cellrowborder" valign="top" width="33.33%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="en-us_topic_0034943370__p14276497163837">restart_required</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.2%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="en-us_topic_0034943370__p15545572163837">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="37.47%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="en-us_topic_0034943370__p51231857163837">Indicates whether the instance needs to reboot for the parameter to take effect. The value is <strong id="en-us_topic_0034943370__b842352706105121">true</strong> or <strong id="en-us_topic_0034943370__b842352706105117">false</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0034943370__row66492344163847"><td class="cellrowborder" valign="top" width="33.33%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="en-us_topic_0034943370__p61560188163847">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.2%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="en-us_topic_0034943370__p20319368163847">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="37.47%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="en-us_topic_0034943370__p235445291837">Indicates the parameter type. The value can be <strong id="en-us_topic_0034943370__b84235270620120">integer</strong>, <strong id="en-us_topic_0034943370__b84235270620129">string</strong>, <strong id="en-us_topic_0034943370__b842352706201217">boolean</strong>, <strong id="en-us_topic_0034943370__b842352706201226">float</strong>, or <strong id="en-us_topic_0034943370__b842352706201235">list</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0034943370__row56101210165444"><td class="cellrowborder" valign="top" width="33.33%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="en-us_topic_0034943370__p35148844165444">value_range</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.2%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="en-us_topic_0034943370__p28484120165444">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="37.47%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="en-us_topic_0034943370__p35363391145846">Specifies the parameter value range and enumerated value.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0034943370__row2371826316552"><td class="cellrowborder" valign="top" width="33.33%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="en-us_topic_0034943370__p1213778316552">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.2%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="en-us_topic_0034943370__p4363632916552">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="37.47%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="en-us_topic_0034943370__p4488177616552">Indicates the parameter description.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0034943370__row19561357163847"><td class="cellrowborder" valign="top" width="33.33%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="en-us_topic_0034943370__p41834487163847">datastore_version_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.2%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="en-us_topic_0034943370__p33150314163847">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="37.47%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="en-us_topic_0034943370__p820893163847">Indicates the database version ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="en-us_topic_0034943370__ul1479504017450"><li id="en-us_topic_0034943370__li6604649817450">Response example<pre class="codeblock" id="en-us_topic_0034943370__codeblock41224388175544">{
|
|
"name": "connect_timeout",
|
|
"min": "2",
|
|
"max": "31536000",
|
|
"restart_required": false,
|
|
"type": "integer",
|
|
"value_range": "2-31536000",
|
|
"description": " <em id="en-us_topic_0034943370__i84235269717457">Number of seconds that the mysqld server waits for a connect packet before responding with "Bad handshake".</em>
|
|
"datastore_version_id": "f8e67741-e767-4137-b394-3fb8a3fafd2f"
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0034943370__section51597550"><h4 class="sectiontitle">Abnormal Response</h4><p id="en-us_topic_0034943370__p28475059">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_0017.html">Parameter Configuration</a></div>
|
|
</div>
|
|
</div>
|
|
|