forked from docs/doc-exports
Chen, Junjie
5e34f6ce26
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: Chen, Junjie <chenjunjie@huawei.com> Co-committed-by: Chen, Junjie <chenjunjie@huawei.com>
151 lines
11 KiB
HTML
151 lines
11 KiB
HTML
<a name="dcs-api-0312017"></a><a name="dcs-api-0312017"></a>
|
|
|
|
<h1 class="topictitle1">Modifying Configuration Parameters</h1>
|
|
<div id="body60852964"><div class="section" id="dcs-api-0312017__section529181820420"><h4 class="sectiontitle">Function</h4><p id="dcs-api-0312017__p586511266817">You can modify the configuration parameters of your DCS instance to optimize DCS performance based on your requirements.</p>
|
|
</div>
|
|
<div class="section" id="dcs-api-0312017__section19684271535"><h4 class="sectiontitle">URI</h4><p id="dcs-api-0312017__p176748304618">PUT /v1.0/{project_id}/instances/{instance_id}/configs</p>
|
|
<div class="p" id="dcs-api-0312017__p17796101693718"><a href="#dcs-api-0312017__table139152015133712">Table 1</a> describes the parameters.
|
|
<div class="tablenoborder"><a name="dcs-api-0312017__table139152015133712"></a><a name="table139152015133712"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312017__table139152015133712" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="dcs-api-0312017__row3914171515371"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.3.2.2.5.1.1"><p id="dcs-api-0312017__p8914171523715">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.3.2.2.5.1.2"><p id="dcs-api-0312017__p14914915103717">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.3.2.2.5.1.3"><p id="dcs-api-0312017__p3914111515373">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.3.2.2.5.1.4"><p id="dcs-api-0312017__p19914201519376">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dcs-api-0312017__row109153151378"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dcs-api-0312017__p4914415203712">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dcs-api-0312017__p59141615193712">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dcs-api-0312017__p59141915153719">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dcs-api-0312017__p159151715123717">Project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312017__row1791581520376"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dcs-api-0312017__p9915161523715">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dcs-api-0312017__p7915315203715">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dcs-api-0312017__p19915141513716">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dcs-api-0312017__p119151015183715">ID of the instance to be modified.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dcs-api-0312017__section255981511312"><h4 class="sectiontitle">Request</h4><p id="dcs-api-0312017__p10612123533616"><strong id="dcs-api-0312017__b165319533518">Request parameters</strong></p>
|
|
<div class="p" id="dcs-api-0312017__p683821143714"><a href="#dcs-api-0312017__table16620132063713">Table 2</a> describes the request parameters.
|
|
<div class="tablenoborder"><a name="dcs-api-0312017__table16620132063713"></a><a name="table16620132063713"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312017__table16620132063713" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="dcs-api-0312017__row176191020183713"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.3.2.2.5.1.1"><p id="dcs-api-0312017__p1561942073719">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.3.2.2.5.1.2"><p id="dcs-api-0312017__p1661912013377">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.3.2.2.5.1.3"><p id="dcs-api-0312017__p66191202372">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.3.2.2.5.1.4"><p id="dcs-api-0312017__p161912206371">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dcs-api-0312017__row8620172073712"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.3.2.2.5.1.1 "><p id="dcs-api-0312017__p1762011201378">redis_config</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.3.2.2.5.1.2 "><p id="dcs-api-0312017__p1620182063719">Array</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.3.2.2.5.1.3 "><p id="dcs-api-0312017__p2620420143710">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.3.2.2.5.1.4 "><p id="dcs-api-0312017__p36201420203712">Array of configuration items of the DCS instance.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="dcs-api-0312017__table35215230340"></a><a name="table35215230340"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312017__table35215230340" frame="border" border="1" rules="all"><caption><b>Table 3 </b>redis_config parameter description</caption><thead align="left"><tr id="dcs-api-0312017__row11517152311346"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.4.2.5.1.1"><p id="dcs-api-0312017__p18516112333415">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21%" id="mcps1.3.3.4.2.5.1.2"><p id="dcs-api-0312017__p851613233341">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="11%" id="mcps1.3.3.4.2.5.1.3"><p id="dcs-api-0312017__p85171239347">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="43%" id="mcps1.3.3.4.2.5.1.4"><p id="dcs-api-0312017__p351732393412">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dcs-api-0312017__row1751811236347"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.4.2.5.1.1 "><p id="dcs-api-0312017__p13517323193415">param_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.3.4.2.5.1.2 "><p id="dcs-api-0312017__p651718237346">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.3.4.2.5.1.3 "><p id="dcs-api-0312017__p1351814237341">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43%" headers="mcps1.3.3.4.2.5.1.4 "><p id="dcs-api-0312017__p751818239348">Configuration item ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312017__row1151902315341"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.4.2.5.1.1 "><p id="dcs-api-0312017__p0518923113418">param_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.3.4.2.5.1.2 "><p id="dcs-api-0312017__p165189231344">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.3.4.2.5.1.3 "><p id="dcs-api-0312017__p185191823103416">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43%" headers="mcps1.3.3.4.2.5.1.4 "><p id="dcs-api-0312017__p10519172320343">Configuration item name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312017__row1352013232346"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.4.2.5.1.1 "><p id="dcs-api-0312017__p14519122315343">param_value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.3.4.2.5.1.2 "><p id="dcs-api-0312017__p19519723193413">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.3.4.2.5.1.3 "><p id="dcs-api-0312017__p165201023173419">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43%" headers="mcps1.3.3.4.2.5.1.4 "><p id="dcs-api-0312017__p105201223193414">Value of the configuration item.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="dcs-api-0312017__p1092132234917">For possible values of parameters in <a href="#dcs-api-0312017__table35215230340">Table 3</a>, see <a href="dcs-api-0312015.html#dcs-api-0312015__table1439111281351">Table 4</a>.</p>
|
|
<p id="dcs-api-0312017__p1392774173616"><strong id="dcs-api-0312017__b127551108613">Example request</strong></p>
|
|
<ul id="dcs-api-0312017__ul139851048162511"><li id="dcs-api-0312017__li498554819253">Request URL:<pre class="screen" id="dcs-api-0312017__screen1585014329917">PUT https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/configs</pre>
|
|
</li></ul>
|
|
<ul id="dcs-api-0312017__ul2624251142513"><li id="dcs-api-0312017__li1624195162518">Example:<pre class="screen" id="dcs-api-0312017__screen1028334873614">{
|
|
"redis_config": [
|
|
{
|
|
"param_id": "1",
|
|
"param_name": "timeout",
|
|
"param_value": "100"
|
|
}
|
|
]
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dcs-api-0312017__section125024718"><h4 class="sectiontitle">Response</h4><p class="msonormal" id="dcs-api-0312017__p1458026133713"><strong id="dcs-api-0312017__b121761361262">Response parameters</strong></p>
|
|
<p class="msonormal" id="dcs-api-0312017__p1918914517717">None</p>
|
|
<p class="msonormal" id="dcs-api-0312017__p1972987103715"><strong id="dcs-api-0312017__b115361010668">Example response</strong></p>
|
|
<p id="dcs-api-0312017__p51895518714">None</p>
|
|
</div>
|
|
<div class="section" id="dcs-api-0312017__section174591750151213"><h4 class="sectiontitle">Status Code</h4><p id="dcs-api-0312017__p645975017127"><a href="#dcs-api-0312017__table17459195018122">Table 4</a> describes the status code of successful operations. For details about other status codes, see <a href="dcs-api-0312043.html#dcs-api-0312043__table5210141351517">Table 1</a>.</p>
|
|
|
|
<div class="tablenoborder"><a name="dcs-api-0312017__table17459195018122"></a><a name="table17459195018122"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312017__table17459195018122" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Status code</caption><thead align="left"><tr id="dcs-api-0312017__row9459350171212"><th align="left" class="cellrowborder" valign="top" width="15.98%" id="mcps1.3.5.3.2.3.1.1"><p id="dcs-api-0312017__p20460125021214">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="84.02%" id="mcps1.3.5.3.2.3.1.2"><p id="dcs-api-0312017__p94604504121">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dcs-api-0312017__row1046019506125"><td class="cellrowborder" valign="top" width="15.98%" headers="mcps1.3.5.3.2.3.1.1 "><p id="dcs-api-0312017__p446055021214">204</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="84.02%" headers="mcps1.3.5.3.2.3.1.2 "><p id="dcs-api-0312017__p646055010129">DCS instance configurations modified successfully.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dcs-api-0312013.html">Parameter Management APIs</a></div>
|
|
</div>
|
|
</div>
|
|
|