forked from docs/doc-exports
Wang , Deng Ke
21e968a153
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>
166 lines
13 KiB
HTML
166 lines
13 KiB
HTML
<a name="rds_09_0301"></a><a name="rds_09_0301"></a>
|
|
|
|
<h1 class="topictitle1">Obtaining a Parameter Template List</h1>
|
|
<div id="body1540261086867"><div class="section" id="rds_09_0301__section81771062513"><h4 class="sectiontitle">Function</h4><p id="rds_09_0301__p174911104255">This API is used to obtain the parameter template list, including default parameter templates of all databases and those created by users.</p>
|
|
<ul id="rds_09_0301__ul12259155218373"><li id="rds_09_0301__en-us_topic_0240111818_li836513175363">Before calling an API, you need to understand the API in <a href="rds_03_0001.html">Authentication</a>.</li><li id="rds_09_0301__en-us_topic_0240111818_li1991981933613">Before calling this API, obtain the required <a href="https://docs.otc.t-systems.com/en-us/endpoint/index.html" target="_blank" rel="noopener noreferrer">region and endpoint</a>.</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_09_0301__section017719022520"><h4 class="sectiontitle">URI</h4><ul id="rds_09_0301__ul949116032512"><li id="rds_09_0301__li10491706253">URI format<p id="rds_09_0301__p849120082510"><a name="rds_09_0301__li10491706253"></a><a name="li10491706253"></a>GET https://{<em id="rds_09_0301__i101701508161">Endpoint</em>}/v3/{<em id="rds_09_0301__i94964418507">project_id</em>}/configurations</p>
|
|
</li><li id="rds_09_0301__li349170112515">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_09_0301__table181941109258" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="rds_09_0301__row849117017252"><th align="left" class="cellrowborder" valign="top" width="21.41%" id="mcps1.3.2.2.2.1.2.4.1.1"><p id="rds_09_0301__p54918042519"><strong id="rds_09_0301__b84235270691445">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="29.03%" id="mcps1.3.2.2.2.1.2.4.1.2"><p id="rds_09_0301__p34917019250"><strong id="rds_09_0301__b194243723018">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="49.559999999999995%" id="mcps1.3.2.2.2.1.2.4.1.3"><p id="rds_09_0301__p194916016259"><strong id="rds_09_0301__b842352706163417">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_09_0301__row16491304255"><td class="cellrowborder" valign="top" width="21.41%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="rds_09_0301__p949116015257">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.03%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="rds_09_0301__p949110162516">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.559999999999995%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="rds_09_0301__p149114012257">Specifies the project ID of a tenant in a region.</p>
|
|
<p id="rds_09_0301__p125591943105712">For details about how to obtain the project ID, see <a href="rds_03_0002.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_09_0301__section12251402259"><h4 class="sectiontitle">Request</h4><ul id="rds_09_0301__ul1183180183717"><li id="rds_09_0301__li1283110163719">Request parameters<p id="rds_09_0301__p848415163614"><a name="rds_09_0301__li1283110163719"></a><a name="li1283110163719"></a>None</p>
|
|
</li></ul>
|
|
<ul id="rds_09_0301__ul12456151216558"><li id="rds_09_0301__li4411135064210">Example<p id="rds_09_0301__p1454414211213"><a name="rds_09_0301__li4411135064210"></a><a name="li4411135064210"></a>GET https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/configurations</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_09_0301__section52256012514"><h4 class="sectiontitle">Response</h4><ul id="rds_09_0301__ul114911012513"><li id="rds_09_0301__li174913014258">Normal response
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_09_0301__table3225120142519" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="rds_09_0301__row114911709259"><th align="left" class="cellrowborder" valign="top" width="25.509999999999998%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="rds_09_0301__p74911403256"><strong id="rds_09_0301__b1427920811">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="rds_09_0301__p5491110182515"><strong id="rds_09_0301__b842352706164541">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="rds_09_0301__p164913016250"><strong id="rds_09_0301__b987321903">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_09_0301__row13491305254"><td class="cellrowborder" valign="top" width="25.509999999999998%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="rds_09_0301__p204917011259">configurations</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.82%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="rds_09_0301__p449110202513">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.67%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="rds_09_0301__p449110182519">Indicates the parameter template list.</p>
|
|
<p id="rds_09_0301__p11880165913273">For details, see <a href="#rds_09_0301__table1324110018258">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="rds_09_0301__table1324110018258"></a><a name="table1324110018258"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_09_0301__table1324110018258" frame="border" border="1" rules="all"><caption><b>Table 3 </b>configurations field data structure description</caption><thead align="left"><tr id="rds_09_0301__row124916013259"><th align="left" class="cellrowborder" valign="top" width="17.64%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="rds_09_0301__p64916052515"><strong id="rds_09_0301__b1429650437">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.669999999999998%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="rds_09_0301__p349170142515"><strong id="rds_09_0301__b2133935348">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="61.69%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="rds_09_0301__p94914092513"><strong id="rds_09_0301__b2145610042">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_09_0301__row94919018254"><td class="cellrowborder" valign="top" width="17.64%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_09_0301__p849112018256">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.669999999999998%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_09_0301__p104911706251">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.69%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_09_0301__p34911304253">Specifies the parameter template ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_09_0301__row1549170182513"><td class="cellrowborder" valign="top" width="17.64%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_09_0301__p44910052510">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.669999999999998%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_09_0301__p749110017252">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.69%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_09_0301__p144914015258">Indicates the parameter template name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_09_0301__row1749110019252"><td class="cellrowborder" valign="top" width="17.64%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_09_0301__p154912092512">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.669999999999998%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_09_0301__p849116016259">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.69%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_09_0301__p1649115072512">Indicates the parameter template description.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_09_0301__row1849119013256"><td class="cellrowborder" valign="top" width="17.64%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_09_0301__p24917022510">datastore_version_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.669999999999998%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_09_0301__p154361721193019">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.69%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_09_0301__p549114022515">Indicates the database version name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_09_0301__row94917032517"><td class="cellrowborder" valign="top" width="17.64%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_09_0301__p1949118062513">datastore_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.669999999999998%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_09_0301__p1629515220307">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.69%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_09_0301__p164911809250">Indicates the database name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_09_0301__row849118015255"><td class="cellrowborder" valign="top" width="17.64%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_09_0301__p5491120122513">created</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.669999999999998%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_09_0301__p1449113010256">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.69%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_09_0301__p249113012510">Indicates the creation time in the following format: yyyy-MM-ddTHH:mm:ssZ.</p>
|
|
<p id="rds_09_0301__p6491190182519"><strong id="rds_09_0301__b154329783016">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="rds_09_0301__b18432117203012">Z</strong> indicates the time zone offset. </p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_09_0301__row10491702259"><td class="cellrowborder" valign="top" width="17.64%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_09_0301__p1149115032510">updated</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.669999999999998%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_09_0301__p1749110142518">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.69%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_09_0301__p1249180122519">Indicates the update time in the following format: yyyy-MM-ddTHH:mm:ssZ.</p>
|
|
<p id="rds_09_0301__p0491502251"><strong id="rds_09_0301__b4432778302">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="rds_09_0301__b1943211714303">Z</strong> indicates the time zone offset. </p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_09_0301__row3491102258"><td class="cellrowborder" valign="top" width="17.64%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_09_0301__p74911022518">user_defined</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.669999999999998%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_09_0301__p44913062511">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.69%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_09_0301__p1149116052514">Specifies whether the parameter template is created by users.</p>
|
|
<ul id="rds_09_0301__ul1649170142510"><li id="rds_09_0301__li749115062514"><strong id="rds_09_0301__b842352706171054">false</strong>: The parameter template is a default parameter template.</li><li id="rds_09_0301__li10491105253"><strong id="rds_09_0301__b235592260171138">true</strong>: The parameter template is a custom template.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="rds_09_0301__ul2491807258"><li id="rds_09_0301__li349150102510">Example normal response<pre class="codeblock" id="rds_09_0301__codeblock149004210237">{
|
|
"configurations": [{
|
|
"id": "887ea0d1bb0843c49e8d8e5a09a95652pr01",
|
|
"name": "configuration_test",
|
|
"description": "configuration_test",
|
|
"datastore_version_name": "5.6",
|
|
"datastore_name": "mysql",
|
|
"created": "2019-05-15T11:53:34+0000",
|
|
"updated": "2019-05-15T11:53:34+0000",
|
|
"user_defined": true
|
|
},
|
|
{
|
|
"id": "3bc1e9cc0d34404b9225ed7a58fb284epr01",
|
|
"name": "Default-MySQL-5.7",
|
|
"description": "Default parameter group for MySQL 5.7",
|
|
"datastore_version_name": "5.7",
|
|
"datastore_name": "mysql",
|
|
"created": "2019-05-27T03:38:51+0000",
|
|
"updated": "2019-05-27T03:38:51+0000",
|
|
"user_defined": false
|
|
}
|
|
]
|
|
}</pre>
|
|
</li><li id="rds_09_0301__li89105471217">Abnormal Response<p id="rds_09_0301__p134914014254"><a name="rds_09_0301__li89105471217"></a><a name="li89105471217"></a>For details, see <a href="en-us_topic_0032488197.html">Abnormal Request Results</a>.</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_09_0301__section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="rds_09_0301__en-us_topic_0032347778_ul7858132212142"><li id="rds_09_0301__en-us_topic_0032347778_li58581622171411">Normal<p id="rds_09_0301__en-us_topic_0032347778_p1040982941020"><a name="rds_09_0301__en-us_topic_0032347778_li58581622171411"></a><a name="en-us_topic_0032347778_li58581622171411"></a>200</p>
|
|
</li><li id="rds_09_0301__en-us_topic_0032347778_li11583183218149">Abnormal<p id="rds_09_0301__en-us_topic_0032347778_p0723374409"><a name="rds_09_0301__en-us_topic_0032347778_li11583183218149"></a><a name="en-us_topic_0032347778_li11583183218149"></a>For details, see <a href="en-us_topic_0032488240.html">Status Codes</a>.</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_09_0301__section1183074220016"><h4 class="sectiontitle">Error Code</h4><p id="rds_09_0301__en-us_topic_0032347778_p19357163913406">For details, see <a href="en-us_topic_0032488241.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0056887471.html">Parameter Configuration</a></div>
|
|
</div>
|
|
</div>
|
|
|