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>
175 lines
14 KiB
HTML
175 lines
14 KiB
HTML
<a name="en-us_topic_0034943369"></a><a name="en-us_topic_0034943369"></a>
|
|
|
|
<h1 class="topictitle1">Obtaining a Parameter List</h1>
|
|
<div id="body1470368157651"><div class="section" id="en-us_topic_0034943369__section4850156117316"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0034943369__p3631239417316">This API is used to obtain all the parameters that can be modified of the current database version.</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0034943369__section28961517113719"><h4 class="sectiontitle">URI</h4><ul id="en-us_topic_0034943369__ul3084351717316"><li id="en-us_topic_0034943369__li915620217316">URI format<p id="en-us_topic_0034943369__p27453176141627"><a name="en-us_topic_0034943369__li915620217316"></a><a name="li915620217316"></a>PATH: /rds/v1/{project_id}/datastores/versions/{datastore_version_id}/parameters</p>
|
|
<p id="en-us_topic_0034943369__p21415589154754">Method: GET</p>
|
|
</li><li id="en-us_topic_0034943369__li15430535">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0034943369__table4657088" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="en-us_topic_0034943369__row60083059"><th align="left" class="cellrowborder" valign="top" width="20.93%" id="mcps1.3.2.2.2.1.2.4.1.1"><p id="en-us_topic_0034943369__p34889605"><strong id="en-us_topic_0034943369__b84235270691445_1">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="28.439999999999998%" id="mcps1.3.2.2.2.1.2.4.1.2"><p id="en-us_topic_0034943369__p7485743"><strong id="en-us_topic_0034943369__b842352706102346_1">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50.629999999999995%" id="mcps1.3.2.2.2.1.2.4.1.3"><p id="en-us_topic_0034943369__p2365466"><strong id="en-us_topic_0034943369__b842352706163417_1">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0034943369__row57385070"><td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="en-us_topic_0034943369__p17679057">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.439999999999998%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="en-us_topic_0034943369__p22717550">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.629999999999995%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="en-us_topic_0034943369__p48030001163437">Specifies the project ID of a tenant in a region.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0034943369__row2864326155157"><td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="en-us_topic_0034943369__p41557789155220">datastore_version_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.439999999999998%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="en-us_topic_0034943369__p10737742155220">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.629999999999995%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="en-us_topic_0034943369__p64450739155220">Specifies the database version ID (<strong id="en-us_topic_0034943369__b842352706195851">dataStores.id</strong> in the response message in <a href="en-us_topic_0032347782.html">Database Version Queries</a>).</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0034943369__section3074340117316"><h4 class="sectiontitle">Request</h4><p id="en-us_topic_0034943369__p718753317316">None</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0034943369__section28521534113742"><h4 class="sectiontitle">Normal Response</h4><ul id="en-us_topic_0034943369__ul43449544"><li id="en-us_topic_0034943369__li55501577">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0034943369__table29752153" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="en-us_topic_0034943369__row62070345"><th align="left" class="cellrowborder" valign="top" width="21.3%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="en-us_topic_0034943369__p61642077"><strong id="en-us_topic_0034943369__b84235270691445_5">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="28.26%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="en-us_topic_0034943369__p26952341"><strong id="en-us_topic_0034943369__b842352706164541_1">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50.44%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="en-us_topic_0034943369__p35656026"><strong id="en-us_topic_0034943369__b842352706163417_5">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0034943369__row2456979"><td class="cellrowborder" valign="top" width="21.3%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="en-us_topic_0034943369__p64797609">configuration-parameters</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.26%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="en-us_topic_0034943369__p14114947">List data structure. For details, see <a href="#en-us_topic_0034943369__table34207804">Table 3</a>.</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.44%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="en-us_topic_0034943369__p22140377">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_0034943369__table34207804"></a><a name="table34207804"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0034943369__table34207804" 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_0034943369__row41360766"><th align="left" class="cellrowborder" valign="top" width="21.3%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="en-us_topic_0034943369__p61887768"><strong id="en-us_topic_0034943369__b84235270691445_7">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="28.07%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="en-us_topic_0034943369__p46853302"><strong id="en-us_topic_0034943369__b842352706164541_3">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50.629999999999995%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="en-us_topic_0034943369__p37021121"><strong id="en-us_topic_0034943369__b842352706163417_7">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0034943369__row45920800"><td class="cellrowborder" valign="top" width="21.3%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0034943369__p45484399163245">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.07%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0034943369__p60357736163245">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.629999999999995%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0034943369__p57138453163245">Indicates the parameter name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0034943369__row49204239"><td class="cellrowborder" valign="top" width="21.3%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0034943369__p26120409">min</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.07%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0034943369__p35378404">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.629999999999995%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0034943369__p47078488">Indicates the minimum value. Returned only when <strong id="en-us_topic_0034943369__b842352706153531">type</strong> is <strong id="en-us_topic_0034943369__b842352706153537">integer</strong> or <strong id="en-us_topic_0034943369__b84235270692552">float</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0034943369__row21053208"><td class="cellrowborder" valign="top" width="21.3%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0034943369__p27588283">max</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.07%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0034943369__p20058459">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.629999999999995%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0034943369__p14122463">Indicates the maximum value. Returned only when <strong id="en-us_topic_0034943369__b842352706153556">type</strong> is <strong id="en-us_topic_0034943369__b842352706153319">integer</strong> or <strong id="en-us_topic_0034943369__b119659312492627">float</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0034943369__row66492344163847"><td class="cellrowborder" valign="top" width="21.3%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0034943369__p61560188163847">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.07%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0034943369__p20319368163847">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.629999999999995%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0034943369__p35256079163847">Indicates the parameter type. The value can be <strong id="en-us_topic_0034943369__b84235270620120">integer</strong>, <strong id="en-us_topic_0034943369__b84235270620129">string</strong>, <strong id="en-us_topic_0034943369__b842352706201217">boolean</strong>, <strong id="en-us_topic_0034943369__b842352706201226">float</strong>, or <strong id="en-us_topic_0034943369__b842352706201235">list</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0034943369__row18311707165752"><td class="cellrowborder" valign="top" width="21.3%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0034943369__p7200466165951">value_range</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.07%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0034943369__p14648596165951">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.629999999999995%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0034943369__p45685652165951">Specifies the parameter value range and enumerated value.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0034943369__row24783327165741"><td class="cellrowborder" valign="top" width="21.3%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0034943369__p18844278165951">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.07%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0034943369__p47270407165951">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.629999999999995%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0034943369__p3697753165951">Indicates the parameter description.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0034943369__row3494747312729"><td class="cellrowborder" valign="top" width="21.3%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0034943369__p6084539712735">restart_required</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.07%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0034943369__p2953011612735">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.629999999999995%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0034943369__p4312922012735">Indicates whether the instance needs to reboot for the parameter to take effect. The value is <strong id="en-us_topic_0034943369__b842352706105121">true</strong> or <strong id="en-us_topic_0034943369__b842352706105117">false</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0034943369__row19561357163847"><td class="cellrowborder" valign="top" width="21.3%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0034943369__p41834487163847">datastore_version_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.07%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0034943369__p33150314163847">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.629999999999995%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0034943369__p820893163847">Indicates the database version ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="en-us_topic_0034943369__ul3068848"><li id="en-us_topic_0034943369__li27619632">Response example<pre class="codeblock" id="en-us_topic_0034943369__codeblock15980834175238">{
|
|
"configuration-parameters" : [ {
|
|
"name" : "autocommit",
|
|
"type" : "boolean",
|
|
"value_range" : "ON|OFF",
|
|
"description" : "The autocommit mode. If set to ON, all changes to a table take effect immediately. If set to OFF, you must use COMMIT to accept a transaction or ROLLBACK to cancel it. ",
|
|
"restart_required" : false,
|
|
"datastore_version_id" : "e8a8b8cc-63f8-4fb5-8d4a-24c502317a61"
|
|
}, {
|
|
"name" : "auto_increment_increment",
|
|
"min" : "1",
|
|
"max" : "65535",
|
|
"type" : "integer",
|
|
"value_range": "1-65535",
|
|
"description" : "auto_increment_increment and auto_increment_offset are intended for use with master-to-master replication, and can be used to control the operation of AUTO_INCREMENT columns.",
|
|
"restart_required" : false,
|
|
"datastore_version_id" : "e8a8b8cc-63f8-4fb5-8d4a-24c502317a61"
|
|
}, {
|
|
"name" : "auto_increment_offset",
|
|
"min" : "1",
|
|
"max" : "65535",
|
|
"type" : "integer",
|
|
"value_range": "1-65535",
|
|
"description" : "auto_increment_increment and auto_increment_offset are intended for use with master-to-master replication, and can be used to control the operation of AUTO_INCREMENT columns. ",
|
|
"restart_required" : false,
|
|
"datastore_version_id" : "e8a8b8cc-63f8-4fb5-8d4a-24c502317a61"
|
|
}, {
|
|
"name" : "back_log",
|
|
"min" : "1",
|
|
"max" : "65535",
|
|
"type" : "integer",
|
|
"value_range": "1-65535",
|
|
"description" : "The number of outstanding connection requests MySQL can have. This comes into play when the main MySQL thread gets very many connection requests in a very short time. It then takes some time (although very little) for the main thread to check the connection and start a new thread. The back_log value indicates how many requests can be stacked during this short time before MySQL momentarily stops answering new requests. The default value depends on system architecture.",
|
|
"restart_required" : true,
|
|
"datastore_version_id" : "e8a8b8cc-63f8-4fb5-8d4a-24c502317a61"
|
|
}
|
|
]
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0034943369__section51597550"><h4 class="sectiontitle">Abnormal Response</h4><p id="en-us_topic_0034943369__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>
|
|
|