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>
154 lines
13 KiB
HTML
154 lines
13 KiB
HTML
<a name="en-us_topic_0056890257"></a><a name="en-us_topic_0056890257"></a>
|
|
|
|
<h1 class="topictitle1">Obtaining a Parameter List</h1>
|
|
<div id="body1492603082526"><div class="section" id="en-us_topic_0056890257__section6944811102154"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0056890257__p25658833102154">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_0056890257__section29602910102154"><h4 class="sectiontitle">URI</h4><ul id="en-us_topic_0056890257__ul49025487102154"><li id="en-us_topic_0056890257__li38576206102154">URI format<p id="en-us_topic_0056890257__p11641542102154"><a name="en-us_topic_0056890257__li38576206102154"></a><a name="li38576206102154"></a>PATH: /v1.0/{project_id}/datastores/versions/{datastore_version_id}/parameters</p>
|
|
<p id="en-us_topic_0056890257__p37665014102154">Method: GET</p>
|
|
</li><li id="en-us_topic_0056890257__li3440808102154">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0056890257__table30967278102154" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="en-us_topic_0056890257__row27696912102154"><th align="left" class="cellrowborder" valign="top" width="25.759999999999998%" id="mcps1.3.2.2.2.1.2.4.1.1"><p id="en-us_topic_0056890257__p28857385102154"><strong id="en-us_topic_0056890257__b84235270691445_1">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40.97%" id="mcps1.3.2.2.2.1.2.4.1.2"><p id="en-us_topic_0056890257__p55746847102154"><strong id="en-us_topic_0056890257__b842352706102346_1">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.269999999999996%" id="mcps1.3.2.2.2.1.2.4.1.3"><p id="en-us_topic_0056890257__p19200729102154"><strong id="en-us_topic_0056890257__b842352706163417_1">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0056890257__row11755199102154"><td class="cellrowborder" valign="top" width="25.759999999999998%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="en-us_topic_0056890257__p12647099102154">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.97%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="en-us_topic_0056890257__p17782066102154">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.269999999999996%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="en-us_topic_0056890257__p31061262102154">Specifies the project ID of a tenant in a region.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0056890257__row11115910102154"><td class="cellrowborder" valign="top" width="25.759999999999998%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="en-us_topic_0056890257__p27973492102154">datastore_version_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.97%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="en-us_topic_0056890257__p51260346102154">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.269999999999996%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="en-us_topic_0056890257__p58447361102154">Specifies the database version ID (<strong id="en-us_topic_0056890257__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>
|
|
<ul id="en-us_topic_0056890257__ul36615792102154"><li id="en-us_topic_0056890257__li273646671817">Restrictions<p id="en-us_topic_0056890257__p57152011145532"><a name="en-us_topic_0056890257__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_0056890257__section1633976102154"><h4 class="sectiontitle">Request</h4><p id="en-us_topic_0056890257__p65243245102154">None</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0056890257__section50318295102154"><h4 class="sectiontitle">Normal Response</h4><ul id="en-us_topic_0056890257__ul49250122102154"><li id="en-us_topic_0056890257__li40597916102154">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0056890257__table29836925102154" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="en-us_topic_0056890257__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_0056890257__p4571867102154"><strong id="en-us_topic_0056890257__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_0056890257__p34776980102154"><strong id="en-us_topic_0056890257__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_0056890257__p65472001102154"><strong id="en-us_topic_0056890257__b842352706163417_5">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0056890257__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_0056890257__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_0056890257__p36477460102154">List data structure. For details, see <a href="#en-us_topic_0056890257__table31447783102154">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_0056890257__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_0056890257__table31447783102154"></a><a name="table31447783102154"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0056890257__table31447783102154" 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_0056890257__row57162906102154"><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_0056890257__p66792684102154"><strong id="en-us_topic_0056890257__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_0056890257__p41498347102154"><strong id="en-us_topic_0056890257__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_0056890257__p5922942102154"><strong id="en-us_topic_0056890257__b842352706163417_7">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0056890257__row9996302102154"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0056890257__p4394114102154">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_0056890257__p20378947102154">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_0056890257__p40081976102154">Indicates the parameter name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0056890257__row25193465102154"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0056890257__p27404824102154">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_0056890257__p5198304102154">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_0056890257__p18409464102154">Indicates the minimum value. Returned only when <strong id="en-us_topic_0056890257__b842352706153531">type</strong> is <strong id="en-us_topic_0056890257__b842352706153537">integer</strong> or <strong id="en-us_topic_0056890257__b84235270692552">float</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0056890257__row31467449102154"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0056890257__p65835469102154">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_0056890257__p31072773102154">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_0056890257__p33866698102154">Indicates the maximum value. Returned only when <strong id="en-us_topic_0056890257__b842352706153556">type</strong> is <strong id="en-us_topic_0056890257__b842352706153319">integer</strong> or <strong id="en-us_topic_0056890257__b119659312492627">float</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0056890257__row36364828102154"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0056890257__p59869983102154">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_0056890257__p17630434102154">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_0056890257__p18779021102154">Indicates the parameter type, which can be <strong id="en-us_topic_0056890257__b317172548174558">integer</strong>, <strong id="en-us_topic_0056890257__b842352706174612">string</strong>, <strong id="en-us_topic_0056890257__b842352706174617">boolean</strong>, <strong id="en-us_topic_0056890257__b842352706171731">list</strong>, or <strong id="en-us_topic_0056890257__b842352706171734">float</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0056890257__row34793465102154"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0056890257__p66807317102154">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_0056890257__p42683564102154">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_0056890257__p34816680102154">Indicates whether the instance needs to reboot for the parameter to take effect. The value is <strong id="en-us_topic_0056890257__b842352706105121">true</strong> or <strong id="en-us_topic_0056890257__b842352706105117">false</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0056890257__row44914672102154"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0056890257__p14209790102154">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_0056890257__p10142308102154">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_0056890257__p16220619102154">Indicates the database version ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="en-us_topic_0056890257__ul38801754102154"><li id="en-us_topic_0056890257__li13671473102154">Response example<pre class="codeblock" id="en-us_topic_0056890257__codeblock16061582102221">{
|
|
"configuration-parameters" : [ {
|
|
"name" : "autocommit",
|
|
"type" : "boolean",
|
|
"restart_required" : false,
|
|
"datastore_version_id" : "e8a8b8cc-63f8-4fb5-8d4a-24c502317a61"
|
|
}, {
|
|
"name" : "auto_increment_increment",
|
|
"min" : "1",
|
|
"max" : "65535",
|
|
"type" : "integer",
|
|
"restart_required" : false,
|
|
"datastore_version_id" : "e8a8b8cc-63f8-4fb5-8d4a-24c502317a61"
|
|
}, {
|
|
"name" : "auto_increment_offset",
|
|
"min" : "1",
|
|
"max" : "65535",
|
|
"type" : "integer",
|
|
"restart_required" : false,
|
|
"datastore_version_id" : "e8a8b8cc-63f8-4fb5-8d4a-24c502317a61"
|
|
}, {
|
|
"name" : "back_log",
|
|
"min" : "1",
|
|
"max" : "65535",
|
|
"type" : "integer",
|
|
"restart_required" : true,
|
|
"datastore_version_id" : "e8a8b8cc-63f8-4fb5-8d4a-24c502317a61"
|
|
} ]
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0056890257__section33647504102154"><h4 class="sectiontitle">Abnormal Response</h4><p id="en-us_topic_0056890257__p41093292102154">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>
|
|
|