doc-exports/docs/rds/api-ref/rds_09_0307.html
Wang , Deng Ke 21e968a153 rds api 2.0.38sp24 version
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>
2023-01-12 13:50:31 +00:00

223 lines
19 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<a name="rds_09_0307"></a><a name="rds_09_0307"></a>
<h1 class="topictitle1">Obtaining Parameters in a Specified Parameter Template</h1>
<div id="body1540261086867"><div class="section" id="rds_09_0307__section5782830193116"><h4 class="sectiontitle">Function</h4><p id="rds_09_0307__p3985163017316">This API is used to obtain parameters of a specified parameter template.</p>
<ul id="rds_09_0307__ul12259155218373"><li id="rds_09_0307__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_0307__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_0307__section27821830203110"><h4 class="sectiontitle">URI</h4><ul id="rds_09_0307__ul2985130103113"><li id="rds_09_0307__li5948150163815">URI format<p id="rds_09_0307__p494814063811"><a name="rds_09_0307__li5948150163815"></a><a name="li5948150163815"></a>GET https://{<em id="rds_09_0307__i6259141616163">Endpoint</em>}/v3/{project_id}/configurations/{config_id}</p>
</li><li id="rds_09_0307__li16985163019315">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_09_0307__table18782130193120" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="rds_09_0307__row3985193020313"><th align="left" class="cellrowborder" valign="top" width="18.68%" id="mcps1.3.2.2.2.1.2.4.1.1"><p id="rds_09_0307__p498543073117"><strong id="rds_09_0307__b84235270691445">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="28.189999999999998%" id="mcps1.3.2.2.2.1.2.4.1.2"><p id="rds_09_0307__p19985203016315"><strong id="rds_09_0307__b173761618132115">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.13%" id="mcps1.3.2.2.2.1.2.4.1.3"><p id="rds_09_0307__p59850301315"><strong id="rds_09_0307__b842352706163417">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="rds_09_0307__row19985123013319"><td class="cellrowborder" valign="top" width="18.68%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="rds_09_0307__p198514306315">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="28.189999999999998%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="rds_09_0307__p2098523018318">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="53.13%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="rds_09_0307__p4985143012313">Specifies the project ID of a tenant in a region.</p>
<p id="rds_09_0307__p4574330362">For details about how to obtain the project ID, see <a href="rds_03_0002.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
<tr id="rds_09_0307__row9985133018318"><td class="cellrowborder" valign="top" width="18.68%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="rds_09_0307__p15985330173118">config_id</p>
</td>
<td class="cellrowborder" valign="top" width="28.189999999999998%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="rds_09_0307__p19985530113119">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="53.13%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="rds_09_0307__p12985163015311">Specifies the parameter template ID.</p>
<p id="rds_09_0307__p169856302315">When this parameter is empty (not space), the URL of the parameter template list is obtained. For details, see <a href="rds_09_0301.html">Obtaining a Parameter Template List</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="rds_09_0307__section1579853020319"><h4 class="sectiontitle">Request</h4><ul id="rds_09_0307__ul1183180183717"><li id="rds_09_0307__li1283110163719">Request parameters<p id="rds_09_0307__p848415163614"><a name="rds_09_0307__li1283110163719"></a><a name="li1283110163719"></a>None</p>
</li></ul>
<ul id="rds_09_0307__ul12980152374619"><li id="rds_09_0307__li1123012571519">Example<p id="rds_09_0307__p13230157154"><a name="rds_09_0307__li1123012571519"></a><a name="li1123012571519"></a>GET https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/configurations/463b4b58-d0e8-4e2b-9560-5dea4552fde9</p>
</li></ul>
</div>
<div class="section" id="rds_09_0307__section47981430203118"><h4 class="sectiontitle">Response</h4><ul id="rds_09_0307__ul598573093111"><li id="rds_09_0307__li998511306314">Normal response
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_09_0307__table11813930113110" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="rds_09_0307__row7985143017311"><th align="left" class="cellrowborder" valign="top" width="22.992299229922992%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="rds_09_0307__p6985203063120"><strong id="rds_09_0307__b1474399876">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.21332133213321%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="rds_09_0307__p798533073112"><strong id="rds_09_0307__b842352706164541">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="43.79437943794379%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="rds_09_0307__p1498593083118"><strong id="rds_09_0307__b1131643128">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="rds_09_0307__row2985193019314"><td class="cellrowborder" valign="top" width="22.992299229922992%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="rds_09_0307__p29859308311">id</p>
</td>
<td class="cellrowborder" valign="top" width="33.21332133213321%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="rds_09_0307__p898543003115">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.79437943794379%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="rds_09_0307__p179856307312">Indicates the parameter template ID.</p>
</td>
</tr>
<tr id="rds_09_0307__row298563013117"><td class="cellrowborder" valign="top" width="22.992299229922992%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="rds_09_0307__p1098533063111">name</p>
</td>
<td class="cellrowborder" valign="top" width="33.21332133213321%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="rds_09_0307__p29855306312">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.79437943794379%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="rds_09_0307__p169851303312">Indicates the parameter template name.</p>
</td>
</tr>
<tr id="rds_09_0307__row17985103073115"><td class="cellrowborder" valign="top" width="22.992299229922992%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="rds_09_0307__p12985130103115">datastore_version_name</p>
</td>
<td class="cellrowborder" valign="top" width="33.21332133213321%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="rds_09_0307__p1398503063118">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.79437943794379%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="rds_09_0307__p398511301312">Indicates the database version name.</p>
</td>
</tr>
<tr id="rds_09_0307__row69855304315"><td class="cellrowborder" valign="top" width="22.992299229922992%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="rds_09_0307__p9985183033112">datastore_name</p>
</td>
<td class="cellrowborder" valign="top" width="33.21332133213321%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="rds_09_0307__p898583033110">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.79437943794379%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="rds_09_0307__p798519306319">Indicates the database name.</p>
</td>
</tr>
<tr id="rds_09_0307__row151123173111"><td class="cellrowborder" valign="top" width="22.992299229922992%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="rds_09_0307__p911931113119">description</p>
</td>
<td class="cellrowborder" valign="top" width="33.21332133213321%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="rds_09_0307__p6143113313">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.79437943794379%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="rds_09_0307__p13111312314">Indicates the parameter template description.</p>
</td>
</tr>
<tr id="rds_09_0307__row1011231173117"><td class="cellrowborder" valign="top" width="22.992299229922992%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="rds_09_0307__p411131103118">created</p>
</td>
<td class="cellrowborder" valign="top" width="33.21332133213321%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="rds_09_0307__p1410316319">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.79437943794379%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="rds_09_0307__p151331103117">Indicates the creation time in the following format: yyyy-MM-ddTHH:mm:ssZ.</p>
<p id="rds_09_0307__p5133143114"><strong id="rds_09_0307__b238820183211">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="rds_09_0307__b14388101872119">Z</strong> indicates the time zone offset. </p>
</td>
</tr>
<tr id="rds_09_0307__row1311931103118"><td class="cellrowborder" valign="top" width="22.992299229922992%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="rds_09_0307__p17163113113">updated</p>
</td>
<td class="cellrowborder" valign="top" width="33.21332133213321%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="rds_09_0307__p201831203110">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.79437943794379%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="rds_09_0307__p81103193116">Indicates the update time in the following format: yyyy-MM-ddTHH:mm:ssZ.</p>
<p id="rds_09_0307__p211831173119"><strong id="rds_09_0307__b13891918192115">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="rds_09_0307__b738919185212">Z</strong> indicates the time zone offset. </p>
</td>
</tr>
<tr id="rds_09_0307__row71193183116"><td class="cellrowborder" valign="top" width="22.992299229922992%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="rds_09_0307__p31731193114">configuration_parameters</p>
</td>
<td class="cellrowborder" valign="top" width="33.21332133213321%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="rds_09_0307__p295463213214">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="43.79437943794379%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="rds_09_0307__p14115316313">Indicates the parameters defined by users based on the default parameter templates.</p>
<p id="rds_09_0307__p16101710385">For details, see <a href="#rds_09_0307__table082923016312">Table 3</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="rds_09_0307__table082923016312"></a><a name="table082923016312"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_09_0307__table082923016312" frame="border" border="1" rules="all"><caption><b>Table 3 </b>configuration_parameters field data structure description</caption><thead align="left"><tr id="rds_09_0307__row21193111315"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="rds_09_0307__p71203111314"><strong id="rds_09_0307__b1378187054">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="rds_09_0307__p16111316315"><strong id="rds_09_0307__b818260000">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="rds_09_0307__p111203123114"><strong id="rds_09_0307__b1954961654">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="rds_09_0307__row111143115316"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_09_0307__p15193113119">name</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_09_0307__p15133143116">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_09_0307__p1911631113116">Indicates the parameter name.</p>
</td>
</tr>
<tr id="rds_09_0307__row21631123112"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_09_0307__p41131113118">value</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_09_0307__p3143163120">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_09_0307__p101173163114">Indicates the parameter value.</p>
</td>
</tr>
<tr id="rds_09_0307__row181103123113"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_09_0307__p1611531103116">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="rds_09_0307__p1173112316">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_09_0307__p912312316">Indicates whether a restart is required.</p>
<ul id="rds_09_0307__ul5163173111"><li id="rds_09_0307__li6113103110"><strong id="rds_09_0307__b842352706214352_1">false</strong> indicates that a restart is not required.</li><li id="rds_09_0307__li111316314"><strong id="rds_09_0307__b84235270621449_1">true</strong> indicates that a restart is required.</li></ul>
</td>
</tr>
<tr id="rds_09_0307__row19143133112"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_09_0307__p61123173117">readonly</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_09_0307__p01173117316">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_09_0307__p141531103113">Indicates whether the parameter is read-only.</p>
<ul id="rds_09_0307__ul17119318311"><li id="rds_09_0307__li13119319319"><strong id="rds_09_0307__b1411252830">false</strong>: The parameter is not read-only.</li><li id="rds_09_0307__li01143113312"><strong id="rds_09_0307__b10906738997">true</strong>: The parameter is read-only.</li></ul>
</td>
</tr>
<tr id="rds_09_0307__row7123117315"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_09_0307__p1611431113120">value_range</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_09_0307__p91131133112">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_09_0307__p16111312319">Indicates the parameter value range. For example, the value of <strong id="rds_09_0307__b842352706163858">integer</strong> is 01, and the value of <strong id="rds_09_0307__b842352706163915">boolean</strong> is <strong id="rds_09_0307__b842352706163917">true</strong> or <strong id="rds_09_0307__b842352706163919">false</strong>.</p>
</td>
</tr>
<tr id="rds_09_0307__row13173119316"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_09_0307__p411231173116">type</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_09_0307__p41193103117">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_09_0307__p4120314313">Indicates the parameter type, which can be <strong id="rds_09_0307__b317172548174558">integer</strong>, <strong id="rds_09_0307__b842352706174612">string</strong>, <strong id="rds_09_0307__b842352706174617">boolean</strong>, <strong id="rds_09_0307__b842352706171731">list</strong>, or <strong id="rds_09_0307__b842352706171734">float</strong>.</p>
</td>
</tr>
<tr id="rds_09_0307__row161113143113"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_09_0307__p1911312314">description</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_09_0307__p17110317319">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_09_0307__p1215315318">Indicates the parameter description.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="rds_09_0307__ul16133133118"><li id="rds_09_0307__li6123112319">Example normal response<pre class="codeblock" id="rds_09_0307__codeblock51103118317">{
"id": "07fc12a8e0e94df7a3fcf53d0b5e1605pr01",
"name": "default-mysql-5.6",
"datastore_version_name": "5.6",
"datastore_name": "mysql",
"description": "Default parameter group for mysql 5.6",
"created": "2017-05-05T04:40:51+0800",
"updated": "2017-05-05T04:40:51+0800",
"configuration_parameters": [
{
"name": "auto_increment_increment",
"value": "1",
"restart_required": false,
"readonly": true,
"value_range": "1-65535",
"type": "integer",
"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."
},
{
"name": "autocommit",
"value": "ON",
"restart_required": false,
"readonly": true,
"value_range": "ON|OFF",
"type": "boolean",
"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. "
}
]
}</pre>
</li><li id="rds_09_0307__li116807505345">Abnormal response<p id="rds_09_0307__p10183112317"><a name="rds_09_0307__li116807505345"></a><a name="li116807505345"></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_0307__section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="rds_09_0307__en-us_topic_0032347778_ul7858132212142"><li id="rds_09_0307__en-us_topic_0032347778_li58581622171411">Normal<p id="rds_09_0307__en-us_topic_0032347778_p1040982941020"><a name="rds_09_0307__en-us_topic_0032347778_li58581622171411"></a><a name="en-us_topic_0032347778_li58581622171411"></a>200</p>
</li><li id="rds_09_0307__en-us_topic_0032347778_li11583183218149">Abnormal<p id="rds_09_0307__en-us_topic_0032347778_p0723374409"><a name="rds_09_0307__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_0307__section1183074220016"><h4 class="sectiontitle">Error Code</h4><p id="rds_09_0307__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>