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>
193 lines
16 KiB
HTML
193 lines
16 KiB
HTML
<a name="rds_09_0304"></a><a name="rds_09_0304"></a>
|
|
|
|
<h1 class="topictitle1">Applying a Parameter Template</h1>
|
|
<div id="body1540261086867"><div class="section" id="rds_09_0304__section34921715163618"><h4 class="sectiontitle">Function</h4><p id="rds_09_0304__p17788191513366">This API is used to apply a parameter template to one or more DB instances.</p>
|
|
<ul id="rds_09_0304__ul12259155218373"><li id="rds_09_0304__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_0304__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_0304__section349221518369"><h4 class="sectiontitle">URI</h4><ul id="rds_09_0304__ul5788171512366"><li id="rds_09_0304__li187887157365">URI format<p id="rds_09_0304__p107889155367"><a name="rds_09_0304__li187887157365"></a><a name="li187887157365"></a>PUT https://{<em id="rds_09_0304__i426828201615">Endpoint</em>}/v3/{<em id="rds_09_0304__i94964418507">project_id</em>}/configurations/{config_id}/apply</p>
|
|
</li><li id="rds_09_0304__li57880154363">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_09_0304__table350771512364" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="rds_09_0304__row178891510369"><th align="left" class="cellrowborder" valign="top" width="21.21%" id="mcps1.3.2.2.2.1.2.4.1.1"><p id="rds_09_0304__p2078801512364"><strong id="rds_09_0304__b84235270691445">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="28.610000000000003%" id="mcps1.3.2.2.2.1.2.4.1.2"><p id="rds_09_0304__p1778841553610"><strong id="rds_09_0304__b6911841153320">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50.18%" id="mcps1.3.2.2.2.1.2.4.1.3"><p id="rds_09_0304__p0788171593617"><strong id="rds_09_0304__b842352706163417">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_09_0304__row16788161516363"><td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="rds_09_0304__p1478816159368">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.610000000000003%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="rds_09_0304__p77882156369">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.18%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="rds_09_0304__p107881159368">Specifies the project ID of a tenant in a region.</p>
|
|
<p id="rds_09_0304__p1955917142067">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_0304__row14788171523612"><td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="rds_09_0304__p107881815193611">config_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.610000000000003%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="rds_09_0304__p157881915113616">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.18%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="rds_09_0304__p77882015143610">Specifies the parameter template ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_09_0304__section15386150366"><h4 class="sectiontitle">Request</h4><ul id="rds_09_0304__ul207881915183612"><li id="rds_09_0304__li16788121519369">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_09_0304__table05381415103619" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="rds_09_0304__row97881015193611"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.2.1.1.2.5.1.1"><p id="rds_09_0304__p778891543617"><strong id="rds_09_0304__b1501362188">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.2.1.1.2.5.1.2"><p id="rds_09_0304__p10788141533620"><strong id="rds_09_0304__b1119184114332">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.2.1.1.2.5.1.3"><p id="rds_09_0304__p167880155368"><strong id="rds_09_0304__b842352706164541">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.2.1.1.2.5.1.4"><p id="rds_09_0304__p147881915193611"><strong id="rds_09_0304__b314512256">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_09_0304__row5788121519368"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="rds_09_0304__p16788415133610">instance_ids</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="rds_09_0304__p127881615133611">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="rds_09_0304__p189001836124616">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="rds_09_0304__p1078813155365">Specifies the DB instance ID list object.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="rds_09_0304__ul656761919434"><li id="rds_09_0304__li4411135064210">Example<p id="rds_09_0304__p1454414211213"><a name="rds_09_0304__li4411135064210"></a><a name="li4411135064210"></a>PUT https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/configurations/463b4b58-d0e8-4e2b-9560-5dea4552fde9/apply</p>
|
|
</li></ul>
|
|
<ul id="rds_09_0304__ul18788415153618"><li id="rds_09_0304__li18788111516366">Request example</li></ul>
|
|
<pre class="codeblock" id="rds_09_0304__codeblock15788161543615">{
|
|
"instance_ids": ["73ea2bf70c73497f89ee0ad4ee008aa2in01", "fe5f5a07539c431181fc78220713aebein01"]
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="rds_09_0304__section8569161515366"><h4 class="sectiontitle">Response</h4><ul id="rds_09_0304__ul1578821563619"><li id="rds_09_0304__li17788151583618">Normal response
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_09_0304__table1056917157367" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameter description</caption><thead align="left"><tr id="rds_09_0304__row97881615113617"><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_0304__p13788715133620"><strong id="rds_09_0304__b969820788">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_0304__p978811516362"><strong id="rds_09_0304__b970759315">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_0304__p177889156366"><strong id="rds_09_0304__b2037165250">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_09_0304__row1378819159369"><td class="cellrowborder" valign="top" width="25.509999999999998%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="rds_09_0304__p17788121516366">configuration_id</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_0304__p7788131520367">String</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_0304__p8788151563617">Specifies the parameter template ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_09_0304__row178810158365"><td class="cellrowborder" valign="top" width="25.509999999999998%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="rds_09_0304__p4788101519365">configuration_name</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_0304__p978821573620">String</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_0304__p19788815123616">Specifies the parameter template name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_09_0304__row8788715153611"><td class="cellrowborder" valign="top" width="25.509999999999998%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="rds_09_0304__p18788131511368">apply_results</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_0304__p6301203614332">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_0304__p20788181510366">Specifies the result of applying the parameter template.</p>
|
|
<p id="rds_09_0304__p11498115753016">For details, see <a href="#rds_09_0304__table19602151563612">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_09_0304__row10788161543616"><td class="cellrowborder" valign="top" width="25.509999999999998%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="rds_09_0304__p7788111517367">success</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_0304__p16788171593618">Boolean</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_0304__p14788181583618">Specifies whether each parameter template is applied to DB instances successfully.</p>
|
|
<ul id="rds_09_0304__ul07881715103618"><li id="rds_09_0304__li12788111533619"><strong id="rds_09_0304__b842352706174048">true</strong>: Each parameter template is applied to DB instances successfully.</li><li id="rds_09_0304__li278831513611"><span class="parmvalue" id="rds_09_0304__parmvalue8230132315317"><b>false</b></span>: One or more parameter templates failed to be applied.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_09_0304__row124241638115214"><td class="cellrowborder" valign="top" width="25.509999999999998%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="rds_09_0304__p911404113216">job_id</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_0304__p12114941162119">String</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_0304__p1511414113218">Job ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="rds_09_0304__table19602151563612"></a><a name="table19602151563612"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_09_0304__table19602151563612" frame="border" border="1" rules="all"><caption><b>Table 4 </b>apply_results field data structure description</caption><thead align="left"><tr id="rds_09_0304__row157887151363"><th align="left" class="cellrowborder" valign="top" width="24.942494249424943%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="rds_09_0304__p9788151517364"><strong id="rds_09_0304__b918271699">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="39.653965396539654%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="rds_09_0304__p678811533611"><strong id="rds_09_0304__b1127238380">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="35.4035403540354%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="rds_09_0304__p1580411515361"><strong id="rds_09_0304__b1633770565">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_09_0304__row13804315143614"><td class="cellrowborder" valign="top" width="24.942494249424943%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_09_0304__p18042157360">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.653965396539654%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_09_0304__p7804615203619">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="35.4035403540354%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_09_0304__p18804191518362">Indicates the DB instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_09_0304__row16804161523613"><td class="cellrowborder" valign="top" width="24.942494249424943%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_09_0304__p12804715163614">instance_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.653965396539654%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_09_0304__p6804191513611">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="35.4035403540354%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_09_0304__p1180413153362">Indicates the DB instance name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_09_0304__row3804101543618"><td class="cellrowborder" valign="top" width="24.942494249424943%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_09_0304__p280414153361">restart_required</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.653965396539654%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_09_0304__p16804181512367">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="35.4035403540354%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_09_0304__p8804181593615">Indicates whether a reboot is required.</p>
|
|
<ul id="rds_09_0304__ul15804161503611"><li id="rds_09_0304__li180411514368"><strong id="rds_09_0304__b842352706174226">true</strong>: A reboot is required.</li><li id="rds_09_0304__li1580471510362"><strong id="rds_09_0304__b842352706174241">false</strong>: A reboot is not required.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_09_0304__row108041215133614"><td class="cellrowborder" valign="top" width="24.942494249424943%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_09_0304__p15804315103616">success</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.653965396539654%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_09_0304__p880491514363">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="35.4035403540354%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_09_0304__p680412152366">Indicates whether each parameter template is applied to DB instances successfully.</p>
|
|
<ul id="rds_09_0304__ul1680413151367"><li id="rds_09_0304__li580471512362"><strong id="rds_09_0304__b1257071618">true</strong>: The application is successful.</li><li id="rds_09_0304__li108042015173612"><strong id="rds_09_0304__b842352706174059">false</strong>: The application failed.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="rds_09_0304__ul68041615123617"><li id="rds_09_0304__li1280471518366">Example normal response<pre class="codeblock" id="rds_09_0304__codeblock14804101519368">{
|
|
"configuration_id": "cf49bbd7d2384878bc3808733c9e9d8bpr01",
|
|
"configuration_name": "paramsGroup-bcf9",
|
|
"apply_results": [{
|
|
"instance_id": "fe5f5a07539c431181fc78220713aebein01",
|
|
"instance_name": "zyy1",
|
|
"restart_required": false,
|
|
"success": false
|
|
}, {
|
|
"instance_id": "73ea2bf70c73497f89ee0ad4ee008aa2in01",
|
|
"instance_name": "zyy2",
|
|
"restart_required": false,
|
|
"success": false
|
|
}],
|
|
"success": false,
|
|
"job_id":"3b5ddc07-a230-46e5-bBc9-6e76526cbb3e"
|
|
}</pre>
|
|
</li><li id="rds_09_0304__li19251126312">Abnormal response<p id="rds_09_0304__p14804191573611"><a name="rds_09_0304__li19251126312"></a><a name="li19251126312"></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_0304__section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="rds_09_0304__en-us_topic_0032347778_ul7858132212142"><li id="rds_09_0304__en-us_topic_0032347778_li58581622171411">Normal<p id="rds_09_0304__en-us_topic_0032347778_p1040982941020"><a name="rds_09_0304__en-us_topic_0032347778_li58581622171411"></a><a name="en-us_topic_0032347778_li58581622171411"></a>200</p>
|
|
</li><li id="rds_09_0304__en-us_topic_0032347778_li11583183218149">Abnormal<p id="rds_09_0304__en-us_topic_0032347778_p0723374409"><a name="rds_09_0304__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_0304__section1183074220016"><h4 class="sectiontitle">Error Code</h4><p id="rds_09_0304__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>
|
|
|