forked from laiweijian4/doc-exports
Ru, Li Yi
a6e39ff5b3
Reviewed-by: Boka, Ladislav <ladislav.boka@t-systems.com> Co-authored-by: Ru, Li Yi <liyiru7@huawei.com> Co-committed-by: Ru, Li Yi <liyiru7@huawei.com>
120 lines
9.4 KiB
HTML
120 lines
9.4 KiB
HTML
<a name="dds_api_0107"></a><a name="dds_api_0107"></a>
|
|
|
|
<h1 class="topictitle1">Applying a Parameter Template</h1>
|
|
<div id="body0000001803371868"><div class="section" id="dds_api_0107__section10861819134713"><h4 class="sectiontitle">Description</h4><p id="dds_api_0107__p7925259155617">This API is used to change a parameter template for a specified DB instance.</p>
|
|
</div>
|
|
<div class="section" id="dds_api_0107__section47568069103438"><h4 class="sectiontitle">URI</h4><ul id="dds_api_0107__ul27808384103438"><li id="dds_api_0107__li48948865103438">URI format<p id="dds_api_0107__p1052915415827"><a name="dds_api_0107__li48948865103438"></a><a name="li48948865103438"></a>PUT https://{Endpoint}/v3/{project_id}/configurations/{config_id}/apply</p>
|
|
</li></ul>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0107__table03619411436" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Request parameters</caption><thead align="left"><tr id="dds_api_0107__en-us_topic_0000001444290078_row1936154118319"><th align="left" class="cellrowborder" valign="top" width="19.81801819818018%" id="mcps1.3.3.2.5.1.1"><p id="dds_api_0107__en-us_topic_0000001444290078_p39908856103714">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.127987201279872%" id="mcps1.3.3.2.5.1.2"><p id="dds_api_0107__en-us_topic_0000001444290078_p11391927103714">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.928007199280074%" id="mcps1.3.3.2.5.1.3"><p id="dds_api_0107__en-us_topic_0000001444290078_p164691370227">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40.12598740125987%" id="mcps1.3.3.2.5.1.4"><p id="dds_api_0107__en-us_topic_0000001444290078_p50330890103714">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0107__en-us_topic_0000001444290078_row94099518410"><td class="cellrowborder" valign="top" width="19.81801819818018%" headers="mcps1.3.3.2.5.1.1 "><p id="dds_api_0107__en-us_topic_0000001444290078_p12641444155011">x-auth-token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.127987201279872%" headers="mcps1.3.3.2.5.1.2 "><p id="dds_api_0107__en-us_topic_0000001444290078_p201393327416">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.928007199280074%" headers="mcps1.3.3.2.5.1.3 "><p id="dds_api_0107__en-us_topic_0000001444290078_p204090517412">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.12598740125987%" headers="mcps1.3.3.2.5.1.4 "><p id="dds_api_0107__p911494112324">User token.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0107__en-us_topic_0000001444290078_row10371141739"><td class="cellrowborder" valign="top" width="19.81801819818018%" headers="mcps1.3.3.2.5.1.1 "><p id="dds_api_0107__en-us_topic_0000001444290078_p12131101217518">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.127987201279872%" headers="mcps1.3.3.2.5.1.2 "><p id="dds_api_0107__en-us_topic_0000001444290078_p1125163318414">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.928007199280074%" headers="mcps1.3.3.2.5.1.3 "><p id="dds_api_0107__en-us_topic_0000001444290078_p154701279220">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.12598740125987%" headers="mcps1.3.3.2.5.1.4 "><p id="dds_api_0107__p57877484163525">Specifies the project ID of a tenant in a region.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0107__en-us_topic_0000001444290078_row183715411231"><td class="cellrowborder" valign="top" width="19.81801819818018%" headers="mcps1.3.3.2.5.1.1 "><p id="dds_api_0107__en-us_topic_0000001444290078_p161311712115113">config_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.127987201279872%" headers="mcps1.3.3.2.5.1.2 "><p id="dds_api_0107__en-us_topic_0000001444290078_p21257332048">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.928007199280074%" headers="mcps1.3.3.2.5.1.3 "><p id="dds_api_0107__en-us_topic_0000001444290078_p174701071226">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.12598740125987%" headers="mcps1.3.3.2.5.1.4 "><p id="dds_api_0107__en-us_topic_0000001444290078_p44083492103714">Parameter template ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="section" id="dds_api_0107__section1117919174713"><h4 class="sectiontitle">Requests</h4><ul id="dds_api_0107__ul32633191478"><li id="dds_api_0107__li1326321919475">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0107__table184635231521" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request body parameters</caption><thead align="left"><tr id="dds_api_0107__row134631223329"><th align="left" class="cellrowborder" valign="top" width="16.259999999999998%" id="mcps1.3.4.2.1.1.2.5.1.1"><p id="dds_api_0107__p1146352312216">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="11.86%" id="mcps1.3.4.2.1.1.2.5.1.2"><p id="dds_api_0107__p7463123929">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.5%" id="mcps1.3.4.2.1.1.2.5.1.3"><p id="dds_api_0107__p184635231026">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="52.38%" id="mcps1.3.4.2.1.1.2.5.1.4"><p id="dds_api_0107__p646310239217">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0107__row746372313213"><td class="cellrowborder" valign="top" width="16.259999999999998%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="dds_api_0107__p946332317218">entity_ids</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.86%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="dds_api_0107__p1646317234218">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.5%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="dds_api_0107__p1346312231621">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.38%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><div class="p" id="dds_api_0107__p10404215832">Instance IDs, group IDs, or node IDs. You can call the API used for querying instances and details to obtain the value. If you do not have an instance, you can call the API used for creating an instance.<ul id="dds_api_0107__ul5123281835"><li id="dds_api_0107__li01231881232">If the DB instance type is cluster and the shard or config parameter template is to be changed, the value is the group ID. If the parameter template of the mongos node is changed, the value is the node ID.</li></ul>
|
|
</div>
|
|
<ul id="dds_api_0107__ul771722238"><li id="dds_api_0107__li1471522630">If the DB instance to be changed is a replica set instance or a single node instance, the value is the instance ID.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_api_0107__section84391318145310"><h4 class="sectiontitle">Example Request</h4><div class="p" id="dds_api_0107__p53371904017">Applying a parameter template whose <strong id="dds_api_0107__b1072814114392">entity_ids</strong> is <strong id="dds_api_0107__b14399550394">73ea2bf70c73497f89ee0ad4ee008aa2no02</strong> to a specified DB instance<pre class="screen" id="dds_api_0107__screen183975554400">{
|
|
"entity_ids": [
|
|
"73ea2bf70c73497f89ee0ad4ee008aa2no02"
|
|
]
|
|
}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dds_api_0107__section4132161915479"><h4 class="sectiontitle">Responses</h4><ul id="dds_api_0107__ul18264201913476"><li id="dds_api_0107__li1017112432161">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0107__table95652589427" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="dds_api_0107__row156422058114212"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.6.2.1.1.2.4.1.1"><p id="dds_api_0107__p1664285804216">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.6.2.1.1.2.4.1.2"><p id="dds_api_0107__p36421585425">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.6.2.1.1.2.4.1.3"><p id="dds_api_0107__p1364217588428">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0107__row364225874211"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.1.2.4.1.1 "><p id="dds_api_0107__p1564215583422">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.1.2.4.1.2 "><p id="dds_api_0107__p4642458174212">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.1.1.2.4.1.3 "><p id="dds_api_0107__p13643195819424">Indicates the ID of the asynchronous task for applying a parameter template.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="dds_api_0107__li1126471904712">Response example<pre class="codeblock" id="dds_api_0107__codeblock1666716296610">{
|
|
"job_id" : "bf26cf3c-d046-4080-bb45-f114be7afa5f"
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_api_0107__section53417451356"><h4 class="sectiontitle">Status Code</h4><p id="dds_api_0107__dds_api_0018_p16131712193312">Status Code:200.</p>
|
|
<p id="dds_api_0107__dds_api_0018_p480617135329">For more information, see <a href="dds_status_code.html">Status Code</a>.</p>
|
|
</div>
|
|
<div class="section" id="dds_api_0107__section1234110455513"><h4 class="sectiontitle">Error Code</h4><p id="dds_api_0107__dds_api_0018_p20466124120334">For more information, see <a href="dds_error_code.html">Error Code</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dds_api_0085.html">Parameter Configuration</a></div>
|
|
</div>
|
|
</div>
|
|
|