forked from docs/doc-exports
Zheng, Xiu
99a2d77599
Reviewed-by: Kacur, Michal <michal.kacur@t-systems.com> Co-authored-by: Zheng, Xiu <zhengxiu@huawei.com> Co-committed-by: Zheng, Xiu <zhengxiu@huawei.com>
207 lines
14 KiB
HTML
207 lines
14 KiB
HTML
<a name="css_03_0116"></a><a name="css_03_0116"></a>
|
|
|
|
<h1 class="topictitle1">Modifying Parameter Configurations</h1>
|
|
<div id="body0000001475571094"><div class="section" id="css_03_0116__section71991441162219"><h4 class="sectiontitle">Function</h4><p id="css_03_0116__p72001641142213">This API is used to modify parameter configurations.</p>
|
|
</div>
|
|
<div class="section" id="css_03_0116__section120094111229"><h4 class="sectiontitle">Debugging</h4><p id="css_03_0116__p52021641142219">You can debug this API in . Automatic authentication is supported.</p>
|
|
</div>
|
|
<div class="section" id="css_03_0116__section5203124110220"><h4 class="sectiontitle">URI</h4><p id="css_03_0116__p020454116226">POST /v1.0/{project_id}/clusters/{cluster_id}/ymls/update</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0116__table1420718412224" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="css_03_0116__row1205124152211"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="css_03_0116__p2020804132211">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="css_03_0116__p1120919411228">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="css_03_0116__p221011418225">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="css_03_0116__p13211194142210">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0116__row1620616414225"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="css_03_0116__p621234112226">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="css_03_0116__p172131741162212">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="css_03_0116__p16214124113228">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="css_03_0116__p42155411229">Project ID. For details, see <a href="css_03_0071.html">Obtaining a Project ID and Name</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0116__row16206124112210"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="css_03_0116__p621654110229">cluster_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="css_03_0116__p22171841112215">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="css_03_0116__p7218441112219">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="css_03_0116__p421917413222">ID of the cluster that you want to modify the parameter configurations</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="css_03_0116__section182208419224"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0116__request_UpdateYmlsReq" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request body parameter</caption><thead align="left"><tr id="css_03_0116__row122114412223"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="css_03_0116__p1222374182214">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="css_03_0116__p722412418221">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="css_03_0116__p1022634142210">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="css_03_0116__p3227841162214">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0116__row142211541132220"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="css_03_0116__p3228184162213">edit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="css_03_0116__p7228144115224">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="css_03_0116__p1123014419227"><a href="#css_03_0116__request_UpdateYmlsReqEdit">UpdateYmlsReqEdit</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="css_03_0116__p102315414229">Configuration file information</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="css_03_0116__request_UpdateYmlsReqEdit"></a><a name="request_UpdateYmlsReqEdit"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0116__request_UpdateYmlsReqEdit" frame="border" border="1" rules="all"><caption><b>Table 3 </b>UpdateYmlsReqEdit</caption><thead align="left"><tr id="css_03_0116__row62331241192220"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.1"><p id="css_03_0116__p18235641122215">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.2"><p id="css_03_0116__p9236194132213">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.3"><p id="css_03_0116__p20236104119222">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.3.2.5.1.4"><p id="css_03_0116__p523819410227">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0116__row9233104142214"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="css_03_0116__p9239184111226">modify</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="css_03_0116__p924084122216">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="css_03_0116__p72421441182218"><a href="#css_03_0116__request_UpdateYmlsReqEditModify">UpdateYmlsReqEditModify</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="css_03_0116__p224411411228">Operations performed on parameter configurations. The value can be:</p>
|
|
<ul id="css_03_0116__ul9245134132210"><li id="css_03_0116__li122468414225"><strong id="css_03_0116__b167311189596">modify</strong></li><li id="css_03_0116__li1624774111228"><strong id="css_03_0116__b1428795617016">delete</strong></li><li id="css_03_0116__li92481341202218"><strong id="css_03_0116__b164307129116">reset</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="css_03_0116__request_UpdateYmlsReqEditModify"></a><a name="request_UpdateYmlsReqEditModify"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0116__request_UpdateYmlsReqEditModify" frame="border" border="1" rules="all"><caption><b>Table 4 </b>UpdateYmlsReqEditModify</caption><thead align="left"><tr id="css_03_0116__row1125084152219"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.1"><p id="css_03_0116__p625217416229">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.2"><p id="css_03_0116__p142531041192216">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.3"><p id="css_03_0116__p10254144122210">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.4.2.5.1.4"><p id="css_03_0116__p1225519419228">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0116__row1525014416229"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="css_03_0116__p1125774119222">elasticsearch.yml</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="css_03_0116__p325844132216">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="css_03_0116__p18260194132214">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="css_03_0116__p526174152212">Parameter configuration list. The value is the JSON data you want to modify.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="css_03_0116__section526312414222"><h4 class="sectiontitle">Response Parameters</h4><p id="css_03_0116__p12264741162218"><strong id="css_03_0116__b2052583699113037">Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0116__response_UpdateYmlsResponseBody" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameter</caption><thead align="left"><tr id="css_03_0116__row1526544132219"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="css_03_0116__p13268204115220">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.2"><p id="css_03_0116__p132691641162216">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.3.2.4.1.3"><p id="css_03_0116__p16270144152210">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0116__row1926564117228"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="css_03_0116__p1227154115227">acknowledged</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="css_03_0116__p927364162211">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="css_03_0116__p7274841152213">Indicates whether the modification is successful.</p>
|
|
<ul id="css_03_0116__ul14274124116222"><li id="css_03_0116__li182751419221"><strong id="css_03_0116__b16675261212">true</strong>: The modification is successful.</li><li id="css_03_0116__li1127514142211"><strong id="css_03_0116__b993683117213">false</strong>: The modification failed.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0116__row1826624152215"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="css_03_0116__p6277154112216">externalMessage</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="css_03_0116__p72771141162216">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="css_03_0116__p4278041172211">Error message. If <strong id="css_03_0116__b1632515241149">acknowledged</strong> is set to <strong id="css_03_0116__b1179913311413">true</strong>, <strong id="css_03_0116__b175790361245">null</strong> is returned for this field.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0116__row1326644111220"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="css_03_0116__p15279541192216">httpErrorResponse</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="css_03_0116__p92801841142216">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="css_03_0116__p162815415220">HTTP error information. The default value is <strong id="css_03_0116__b108993369054934">null</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="css_03_0116__section5282184113225"><h4 class="sectiontitle">Request Example</h4><pre class="screen" id="css_03_0116__screen928312412221">{
|
|
"edit" : {
|
|
"modify" : {
|
|
"elasticsearch.yml" : {
|
|
"thread_pool.force_merge.size" : 1
|
|
}
|
|
}
|
|
}
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="css_03_0116__section1929194192210"><h4 class="sectiontitle">Response Example</h4><p id="css_03_0116__p10293741162210"><strong id="css_03_0116__b853530718113037">Status code: 200</strong></p>
|
|
<p id="css_03_0116__p129324111226">The request is processed successfully.</p>
|
|
<pre class="screen" id="css_03_0116__screen162959414225">{
|
|
"acknowledged" : true,
|
|
"externalMessage" : null,
|
|
"httpErrorResponse" : null
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="css_03_0116__section192997417221"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0116__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="css_03_0116__row14300194118226"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="css_03_0116__p230218419228">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.8.2.1.3.1.2"><p id="css_03_0116__p730244142220">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0116__row203004416226"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="css_03_0116__p8303841162213">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="css_03_0116__p1130474110220">The request is processed successfully.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0116__row1630017414222"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="css_03_0116__p153051041202210">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="css_03_0116__p93071941172212">Invalid request.</p>
|
|
<p id="css_03_0116__p730814152212">Modify the request instead of retrying.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0116__row13300441112210"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="css_03_0116__p1830912415225">409</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="css_03_0116__p18311174152217">The request cannot be processed due to a conflict.</p>
|
|
<p id="css_03_0116__p431124192219">This status code indicates that the resource that the client attempts to create already exists, or the request fails to be processed because of the update of the conflict request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0116__row8300194152216"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="css_03_0116__p831244116220">412</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="css_03_0116__p13139414222">The server does not meet one of the requirements that the requester puts on the request.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="css_03_0115.html">Parameter Configuration</a></div>
|
|
</div>
|
|
</div>
|
|
|