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>
222 lines
18 KiB
HTML
222 lines
18 KiB
HTML
<a name="en-us_topic_0056890260"></a><a name="en-us_topic_0056890260"></a>
|
|
|
|
<h1 class="topictitle1">Obtaining a Parameter Template List</h1>
|
|
<div id="body1492603082526"><div class="section" id="en-us_topic_0056890260__section43822836102534"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0056890260__p59988804102534">This API is used to obtain a parameter template list, including all databases' default and custom parameter templates.</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0056890260__section3028329102534"><h4 class="sectiontitle">URI</h4><ul id="en-us_topic_0056890260__ul43968097102534"><li id="en-us_topic_0056890260__li60168558102534">URI format<p id="en-us_topic_0056890260__p66392350144331"><a name="en-us_topic_0056890260__li60168558102534"></a><a name="li60168558102534"></a>PATH: /v1.0/{project_id}/configurations</p>
|
|
<p id="en-us_topic_0056890260__p41815064102534">Method: GET</p>
|
|
</li><li id="en-us_topic_0056890260__li40791263102534">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0056890260__table31577051102534" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="en-us_topic_0056890260__row1972977102534"><th align="left" class="cellrowborder" valign="top" width="22.38%" id="mcps1.3.2.2.2.1.2.4.1.1"><p id="en-us_topic_0056890260__p25593416102534"><strong id="en-us_topic_0056890260__b84235270691445_1">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="27.62%" id="mcps1.3.2.2.2.1.2.4.1.2"><p id="en-us_topic_0056890260__p59800836102534"><strong id="en-us_topic_0056890260__b842352706102346_1">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.2.2.2.1.2.4.1.3"><p id="en-us_topic_0056890260__p12029581102534"><strong id="en-us_topic_0056890260__b842352706163417_1">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0056890260__row34872010102534"><td class="cellrowborder" valign="top" width="22.38%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="en-us_topic_0056890260__p6060580102534">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.62%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="en-us_topic_0056890260__p21144962102534">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="en-us_topic_0056890260__p35020365102534">Specifies the project ID of a tenant in a region.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="en-us_topic_0056890260__ul18077292102534"><li id="en-us_topic_0056890260__li23037766111332">Restrictions<p id="en-us_topic_0056890260__p61576232111335"><a name="en-us_topic_0056890260__li23037766111332"></a><a name="li23037766111332"></a>Currently, the DB engines MySQL and PostgreSQL support obtaining parameter template lists.</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0056890260__section5119069102534"><h4 class="sectiontitle">Request</h4><p id="en-us_topic_0056890260__p11991472102534">None</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0056890260__section40814386102534"><h4 class="sectiontitle">Normal Response</h4><ul id="en-us_topic_0056890260__ul17630940102534"><li id="en-us_topic_0056890260__li24460734102534">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0056890260__table18820018102534" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="en-us_topic_0056890260__row31964513102534"><th align="left" class="cellrowborder" valign="top" width="23.82%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="en-us_topic_0056890260__p38988735102534"><strong id="en-us_topic_0056890260__b84235270691445_5">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="31.61%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="en-us_topic_0056890260__p3970933102534"><strong id="en-us_topic_0056890260__b842352706164541_1">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="44.57%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="en-us_topic_0056890260__p53210156102534"><strong id="en-us_topic_0056890260__b842352706163417_5">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0056890260__row15055371102534"><td class="cellrowborder" valign="top" width="23.82%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="en-us_topic_0056890260__p11525563102534">configurations</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="31.61%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="en-us_topic_0056890260__p61155428102534">List data structure. For details, see <a href="#en-us_topic_0056890260__table2172481102534">Table 3</a>.</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.57%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="en-us_topic_0056890260__p22021397102534">Indicates the parameter template list.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0056890260__row63974846102534"><td class="cellrowborder" valign="top" width="23.82%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="en-us_topic_0056890260__p14580032102534">links</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="31.61%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="en-us_topic_0056890260__p40131930102534">List data structure. For details, see <a href="#en-us_topic_0056890260__table29317924102534">Table 4</a>.</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.57%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="en-us_topic_0056890260__p63821666102534">Indicates the link compatible with OpenStack. Currently, this parameter functions as a placeholder.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0056890260__row64526335143431"><td class="cellrowborder" valign="top" width="23.82%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="en-us_topic_0056890260__p59250621143431">maxgrouplimit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="31.61%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="en-us_topic_0056890260__p34570963143431">Int</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.57%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="en-us_topic_0056890260__p48784618143431">Indicates the maximum quota of custom parameter templates. All DB engines share this quota. Its default value is <strong id="en-us_topic_0056890260__b84235270617243">1000</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="en-us_topic_0056890260__table2172481102534"></a><a name="table2172481102534"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0056890260__table2172481102534" frame="border" border="1" rules="all"><caption><b>Table 3 </b>configurations field data structure description</caption><thead align="left"><tr id="en-us_topic_0056890260__row43311675102534"><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_0056890260__p18584801102534"><strong id="en-us_topic_0056890260__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_0056890260__p28973919102534"><strong id="en-us_topic_0056890260__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_0056890260__p65186142102534"><strong id="en-us_topic_0056890260__b842352706163417_7">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0056890260__row45586182102534"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0056890260__p1493246102534">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_0056890260__p53844078102534">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_0056890260__p66403071102534">Indicates the parameter template ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0056890260__row60756731102534"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0056890260__p22348192102534">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_0056890260__p65373113102534">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_0056890260__p60730799102534">Indicates the parameter template name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0056890260__row44743265175923"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0056890260__p55904883175924">description</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_0056890260__p32001680175924">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_0056890260__p41999306175924">Specifies the parameter template description.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0056890260__row9706280102534"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0056890260__p48011187102534">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_0056890260__p63700943102534">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_0056890260__p59502755102534">Indicates the database version ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0056890260__row65762754102534"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0056890260__p25182878102534">datastore_version_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_0056890260__p26547271102534">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_0056890260__p2845348102534">Indicates the database version name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0056890260__row25608138102534"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0056890260__p60993297102534">datastore_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_0056890260__p41510016102534">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_0056890260__p6868160102534">Indicates the database name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0056890260__row593206131809"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0056890260__p6477101718017">created</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_0056890260__p1196099118017">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_0056890260__p2931621418017">Indicates the parameter template creation time in the following format: yyyy-MM-ddTHH:mm:ss.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0056890260__row682502118015"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0056890260__p3090154018017">updated</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_0056890260__p1999678718017">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_0056890260__p912703918017">Indicates the parameter template updated time in the following format: yyyy-MM-ddTHH:mm:ss.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0056890260__row6315141102534"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0056890260__p41764399102534">allowed_updated</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_0056890260__p27473178102534">Int</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_0056890260__p54172888194540">Indicates whether the parameters in the obtained parameter template can be modified.</p>
|
|
<ul id="en-us_topic_0056890260__ul29769253194627"><li id="en-us_topic_0056890260__li35078356194627"><strong id="en-us_topic_0056890260__b84235270693047">0</strong>: indicates the parameters cannot be modified. When a default parameter template is obtained, this parameter value is <strong id="en-us_topic_0056890260__b842352706213339">0</strong>.</li><li id="en-us_topic_0056890260__li14794903194639"><strong id="en-us_topic_0056890260__b2671175116415">1</strong>: indicates the parameters can be modified.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0056890260__row29505758102534"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0056890260__p41156193102534">instance_count</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_0056890260__p45317345102534">Int</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_0056890260__p46826309102534">Indicates the number of associated DB instances.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="en-us_topic_0056890260__table29317924102534"></a><a name="table29317924102534"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0056890260__table29317924102534" frame="border" border="1" rules="all"><caption><b>Table 4 </b>links field data structure description</caption><thead align="left"><tr id="en-us_topic_0056890260__row1320492102534"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.3.2.4.1.1"><p id="en-us_topic_0056890260__p39850998102534"><strong id="en-us_topic_0056890260__b84235270691445_9">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.3.2.4.1.2"><p id="en-us_topic_0056890260__p6705388102534"><strong id="en-us_topic_0056890260__b842352706164541_5">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.3.2.4.1.3"><p id="en-us_topic_0056890260__p6265592102534"><strong id="en-us_topic_0056890260__b842352706163417_9">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0056890260__row37750911102534"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="en-us_topic_0056890260__p37924971102534">href</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="en-us_topic_0056890260__p52023844102534">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="en-us_topic_0056890260__p51734292145223">Indicates the link URL. Currently, this parameter functions as a placeholder and its value is <strong id="en-us_topic_0056890260__b84235270619145">""</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0056890260__row8874527102534"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="en-us_topic_0056890260__p47748086102534">rel</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="en-us_topic_0056890260__p42389749102534">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="en-us_topic_0056890260__p13067152145223">Indicates the link redirection. Currently, this parameter functions as a placeholder and its default value is <strong id="en-us_topic_0056890260__b842352706213853">next</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="en-us_topic_0056890260__ul20016014102534"><li id="en-us_topic_0056890260__li45926399102534">Response example<pre class="codeblock" id="en-us_topic_0056890260__codeblock7148779102559">{
|
|
"configurations": [
|
|
{
|
|
"id": "07fc12a8e0e94df7a3fcf53d0b5e1605pr01",
|
|
"name": "default-mysql-5.6",
|
|
"description": "Default parameter group for mysql 5.6",
|
|
"datastore_version_id": "",
|
|
"datastore_version_name": "5.6",
|
|
"datastore_name": "mysql",
|
|
"created": "2017-01-01T10:00:00",
|
|
"updated": "2017-01-01T10:00:00",
|
|
"allowed_updated": 0,
|
|
"instance_count": 0
|
|
},
|
|
{
|
|
"id": "3bc1e9cc0d34404b9225ed7a58fb284epr01",
|
|
"name": "test-mysql-5.6",
|
|
"description": "test-mysql-5.6",
|
|
"datastore_version_id": "",
|
|
"datastore_version_name": "5.6",
|
|
"datastore_name": "mysql",
|
|
"created": "2017-02-01T10:00:00",
|
|
"updated": "2017-02-01T10:00:00",
|
|
"allowed_updated": 1,
|
|
"instance_count": 2
|
|
}
|
|
],
|
|
"links": [
|
|
{
|
|
"href": "",
|
|
"rel": "next"
|
|
}
|
|
],
|
|
"maxgrouplimit": 100
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0056890260__section34751554102534"><h4 class="sectiontitle">Abnormal Response</h4><p id="en-us_topic_0056890260__p63412524102534">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>
|
|
|