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>
187 lines
16 KiB
HTML
187 lines
16 KiB
HTML
<a name="rds_09_0306"></a><a name="rds_09_0306"></a>
|
|
|
|
<h1 class="topictitle1">Obtaining the Parameter Template of a Specified DB Instance</h1>
|
|
<div id="body1540261086867"><div class="section" id="rds_09_0306__section8137930122719"><h4 class="sectiontitle">Function</h4><p id="rds_09_0306__p73551830192710">This API is used to obtain information about the parameter template of a specified DB instance.</p>
|
|
<ul id="rds_09_0306__ul12259155218373"><li id="rds_09_0306__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_0306__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_0306__section1013703014278"><h4 class="sectiontitle">URI</h4><ul id="rds_09_0306__ul1135593016276"><li id="rds_09_0306__li5948150163815">URI format<p id="rds_09_0306__p494814063811"><a name="rds_09_0306__li5948150163815"></a><a name="li5948150163815"></a>GET https://{<em id="rds_09_0306__i14131613101615">Endpoint</em>}/v3/{project_id}/instances/{instance_id}/configurations</p>
|
|
</li><li id="rds_09_0306__li33551302274">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_09_0306__table11137330152717" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="rds_09_0306__row6355630152713"><th align="left" class="cellrowborder" valign="top" width="21.14%" id="mcps1.3.2.2.2.1.2.4.1.1"><p id="rds_09_0306__p17355143011279"><strong id="rds_09_0306__b84235270691445">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="29.23%" id="mcps1.3.2.2.2.1.2.4.1.2"><p id="rds_09_0306__p435563012275"><strong id="rds_09_0306__b98616151212">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="49.63%" id="mcps1.3.2.2.2.1.2.4.1.3"><p id="rds_09_0306__p635513013278"><strong id="rds_09_0306__b842352706163417">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_09_0306__row1235520308278"><td class="cellrowborder" valign="top" width="21.14%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="rds_09_0306__p0355130202712">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.23%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="rds_09_0306__p1735511302279">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.63%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="rds_09_0306__p5355183014275">Specifies the project ID of a tenant in a region.</p>
|
|
<p id="rds_09_0306__p10290162519612">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_0306__row335573052719"><td class="cellrowborder" valign="top" width="21.14%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="rds_09_0306__p143551530112714">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.23%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="rds_09_0306__p163551830202719">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.63%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="rds_09_0306__p735515304272">Specifies the DB instance ID compliant with the UUID format.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_09_0306__section20152163016277"><h4 class="sectiontitle">Request</h4><ul id="rds_09_0306__ul1183180183717"><li id="rds_09_0306__li1283110163719">Request parameters<p id="rds_09_0306__p848415163614"><a name="rds_09_0306__li1283110163719"></a><a name="li1283110163719"></a>None</p>
|
|
</li></ul>
|
|
<ul id="rds_09_0306__ul24283435447"><li id="rds_09_0306__li4411135064210">Example<p id="rds_09_0306__p1454414211213"><a name="rds_09_0306__li4411135064210"></a><a name="li4411135064210"></a>GET https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/configurations</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_09_0306__section14152103042715"><h4 class="sectiontitle">Response</h4><ul id="rds_09_0306__ul1835543022715"><li id="rds_09_0306__li13355143052719">Normal response
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_09_0306__table71681830152719" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="rds_09_0306__row133554304277"><th align="left" class="cellrowborder" valign="top" width="23.01%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="rds_09_0306__p1235583052717"><strong id="rds_09_0306__b1402756775">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="23.3%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="rds_09_0306__p1735523017272"><strong id="rds_09_0306__b842352706164541">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53.690000000000005%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="rds_09_0306__p193551030132710"><strong id="rds_09_0306__b1393831383">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_09_0306__row735515304278"><td class="cellrowborder" valign="top" width="23.01%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="rds_09_0306__p1535518301272">datastore_version_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.3%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="rds_09_0306__p1535511303279">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.690000000000005%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="rds_09_0306__p1835516301278">Indicates the database version name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_09_0306__row123556307271"><td class="cellrowborder" valign="top" width="23.01%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="rds_09_0306__p113551630112710">datastore_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.3%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="rds_09_0306__p2035583016274">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.690000000000005%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="rds_09_0306__p1435553062714">Indicates the database name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_09_0306__row163551230122718"><td class="cellrowborder" valign="top" width="23.01%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="rds_09_0306__p133555309277">created</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.3%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="rds_09_0306__p14355143016275">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.690000000000005%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="rds_09_0306__p20355830172718">Indicates the creation time in the following format: yyyy-MM-ddTHH:mm:ssZ.</p>
|
|
<p id="rds_09_0306__p15355193018279"><strong id="rds_09_0306__b6865415162112">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="rds_09_0306__b16865015152115">Z</strong> indicates the time zone offset. </p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_09_0306__row17355123011278"><td class="cellrowborder" valign="top" width="23.01%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="rds_09_0306__p11355123016277">updated</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.3%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="rds_09_0306__p1355183013273">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.690000000000005%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="rds_09_0306__p15355133016272">Indicates the update time in the following format: yyyy-MM-ddTHH:mm:ssZ.</p>
|
|
<p id="rds_09_0306__p53551930182720"><strong id="rds_09_0306__b17866121552114">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="rds_09_0306__b11866115122120">Z</strong> indicates the time zone offset. </p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_09_0306__row2355730152716"><td class="cellrowborder" valign="top" width="23.01%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="rds_09_0306__p8355133002719">configuration_parameters</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.3%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="rds_09_0306__p135518306279">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.690000000000005%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="rds_09_0306__p435512305278">Indicates the parameters defined by users based on the default parameter templates.</p>
|
|
<p id="rds_09_0306__p425083010377">For details, see <a href="#rds_09_0306__table19183193052719">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="rds_09_0306__table19183193052719"></a><a name="table19183193052719"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_09_0306__table19183193052719" 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_0306__row13355163082719"><th align="left" class="cellrowborder" valign="top" width="23.18%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="rds_09_0306__p1635513305278"><strong id="rds_09_0306__b1578335060">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="22.95%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="rds_09_0306__p635593015275"><strong id="rds_09_0306__b562952166">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53.87%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="rds_09_0306__p13551230172713"><strong id="rds_09_0306__b881355960">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_09_0306__row13355530172712"><td class="cellrowborder" valign="top" width="23.18%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_09_0306__p14355123062711">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.95%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_09_0306__p16355123016276">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.87%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_09_0306__p73553306270">Indicates the parameter name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_09_0306__row135573012271"><td class="cellrowborder" valign="top" width="23.18%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_09_0306__p11355133018273">value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.95%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_09_0306__p13355030112715">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.87%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_09_0306__p1135553014273">Indicates the parameter value.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_09_0306__row8355203012713"><td class="cellrowborder" valign="top" width="23.18%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_09_0306__p1335583012277">restart_required</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.95%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_09_0306__p103554302274">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.87%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_09_0306__p335516303270">Indicates whether a reboot is required.</p>
|
|
<ul id="rds_09_0306__ul1035593019278"><li id="rds_09_0306__li7355153017278"><strong id="rds_09_0306__b842352706214352_1">false</strong>: A reboot is not required.</li><li id="rds_09_0306__li18355030162718"><strong id="rds_09_0306__b84235270621449_1">true</strong>: A reboot is required.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_09_0306__row237116301277"><td class="cellrowborder" valign="top" width="23.18%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_09_0306__p4371133042719">readonly</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.95%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_09_0306__p73719303277">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.87%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_09_0306__p1637110308275">Indicates whether the parameter is read-only.</p>
|
|
<ul id="rds_09_0306__ul8371730172718"><li id="rds_09_0306__li3371143014277"><strong id="rds_09_0306__b1465513757">false</strong>: The parameter is not read-only.</li><li id="rds_09_0306__li13371153014272"><strong id="rds_09_0306__b88350933">true</strong>: The parameter is read-only.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_09_0306__row93711530122714"><td class="cellrowborder" valign="top" width="23.18%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_09_0306__p537163015278">value_range</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.95%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_09_0306__p1837112307275">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.87%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_09_0306__p4371103013276">Indicates the parameter value range. If the type is Integer, the value is <strong id="rds_09_0306__b9300328153312">0</strong> or <strong id="rds_09_0306__b523003053313">1</strong>. If the type is Boolean, the value is <strong id="rds_09_0306__b76791938103315">true</strong> or <strong id="rds_09_0306__b850694112333">false</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_09_0306__row1437143042719"><td class="cellrowborder" valign="top" width="23.18%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_09_0306__p5371173042710">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.95%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_09_0306__p143711730172715">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.87%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_09_0306__p18371930192720">Indicates the parameter type, which can be <strong id="rds_09_0306__b317172548174558">integer</strong>, <strong id="rds_09_0306__b842352706174612">string</strong>, <strong id="rds_09_0306__b842352706174617">boolean</strong>, <strong id="rds_09_0306__b842352706171731">list</strong>, or <strong id="rds_09_0306__b842352706171734">float</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_09_0306__row103711330162711"><td class="cellrowborder" valign="top" width="23.18%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_09_0306__p17371143022711">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.95%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_09_0306__p1537123019272">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.87%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_09_0306__p8371123082715">Indicates the parameter description.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="rds_09_0306__ul5371730172712"><li id="rds_09_0306__li337183092719">Example normal response<pre class="codeblock" id="rds_09_0306__codeblock5371203017272">{
|
|
"datastore_version_name": "5.7",
|
|
"datastore_name": "mysql",
|
|
"created": "2018-10-11 11:40:44",
|
|
"updated": "2018-10-11 11:40:44",
|
|
"configuration_parameters": [{
|
|
"name": "auto_increment_increment",
|
|
"value": "1",
|
|
"restart_required": false,
|
|
"readonly": false,
|
|
"value_range": "1-65535",
|
|
"type": "integer",
|
|
"description": <strong id="rds_09_0306__b842352706212626">"auto_increment_increment</strong> and <strong id="rds_09_0306__b842352706212629">auto_increment_offset</strong> are used for master-to-master replication and to control the operations of the AUTO_INCREMENT column."
|
|
}]
|
|
}</pre>
|
|
</li><li id="rds_09_0306__li544805316332">Abnormal Response<p id="rds_09_0306__p134914014254"><a name="rds_09_0306__li544805316332"></a><a name="li544805316332"></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_0306__section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="rds_09_0306__en-us_topic_0032347778_ul7858132212142"><li id="rds_09_0306__en-us_topic_0032347778_li58581622171411">Normal<p id="rds_09_0306__en-us_topic_0032347778_p1040982941020"><a name="rds_09_0306__en-us_topic_0032347778_li58581622171411"></a><a name="en-us_topic_0032347778_li58581622171411"></a>200</p>
|
|
</li><li id="rds_09_0306__en-us_topic_0032347778_li11583183218149">Abnormal<p id="rds_09_0306__en-us_topic_0032347778_p0723374409"><a name="rds_09_0306__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_0306__section1183074220016"><h4 class="sectiontitle">Error Code</h4><p id="rds_09_0306__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>
|
|
|