forked from docs/doc-exports
Zheng, Xiu
bf0cbd66f9
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>
205 lines
14 KiB
HTML
205 lines
14 KiB
HTML
<a name="css_03_0116"></a><a name="css_03_0116"></a>
|
|
|
|
<h1 class="topictitle1">Modifying Cluster Parameters</h1>
|
|
<div id="body0000001475571094"><div class="section" id="css_03_0116__section1118562122812"><h4 class="sectiontitle">Function</h4><p id="css_03_0116__p121865202815">This API is used to modify the parameter settings of a cluster.</p>
|
|
</div>
|
|
<div class="section" id="css_03_0116__section1619011214288"><h4 class="sectiontitle">URI</h4><p id="css_03_0116__p16191122132816">POST /v1.0/{project_id}/clusters/{cluster_id}/ymls/update</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0116__table101950214282" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="css_03_0116__row1119362112811"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="css_03_0116__p151953210284">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="css_03_0116__p519710216284">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="css_03_0116__p201988217284">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="css_03_0116__p3200142112816">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0116__row019332132813"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0116__p62016213288">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="css_03_0116__p42028222810">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0116__p320311262820">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0116__p52049219288">Project ID. For details about how to obtain the project ID and name, see <a href="css_03_0071.html">Obtaining the Project ID and Name</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0116__row1519313242817"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0116__p3205424282">cluster_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="css_03_0116__p020642122816">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0116__p12207192142811">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0116__p22087219283">ID of the cluster whose parameter settings you want to be modify.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="css_03_0116__section5209024286"><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 parameters</caption><thead align="left"><tr id="css_03_0116__row15211828284"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="css_03_0116__p2214729288">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="css_03_0116__p621542152817">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="css_03_0116__p1321618222811">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="css_03_0116__p1321712210289">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0116__row421272152811"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="css_03_0116__p1421862162814">edit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="css_03_0116__p1621932142814">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="css_03_0116__p102213211284"><a href="#css_03_0116__request_UpdateYmlsReqEdit">UpdateYmlsReqEdit</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="css_03_0116__p022210262817">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__row1722332152814"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="css_03_0116__p622652142816">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__p8227328281">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__p15228182142811">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__p2022942122810">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0116__row162237222813"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="css_03_0116__p823192152818">modify</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="css_03_0116__p623316292812">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="css_03_0116__p12348218285"><a href="#css_03_0116__request_UpdateYmlsReqEditModify">UpdateYmlsReqEditModify</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="css_03_0116__p82352216283">Operations on the configuration file.</p>
|
|
<ul id="css_03_0116__ul1923614242819"><li id="css_03_0116__li1236828282"><strong id="css_03_0116__b3237172172818">modify</strong>: Modify parameter settings.</li><li id="css_03_0116__li923717232813"><strong id="css_03_0116__b823812218284">delete</strong>: Delete parameter settings.</li><li id="css_03_0116__li62381725285"><strong id="css_03_0116__b1023918222819">reset</strong>: Reset parameter settings.</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__row172406202812"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="css_03_0116__p162421923280">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.2"><p id="css_03_0116__p22441725283">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.3"><p id="css_03_0116__p124602152812">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.4.2.5.1.4"><p id="css_03_0116__p172475242814">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0116__row112403215289"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="css_03_0116__p9248132152816">elasticsearch.yml</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="css_03_0116__p122509262819">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="css_03_0116__p6251162182813">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="css_03_0116__p82529218284">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__section18253192182818"><h4 class="sectiontitle">Response Parameters</h4><p id="css_03_0116__p8254826282"><strong id="css_03_0116__b1225419215287">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 parameters</caption><thead align="left"><tr id="css_03_0116__row52551420284"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="css_03_0116__p102586222818">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="css_03_0116__p12594242814">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="css_03_0116__p42601232819">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0116__row325592182819"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0116__p12261162152811">acknowledged</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0116__p12627282818">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0116__p5263182102815">Whether the modification is successful.</p>
|
|
<ul id="css_03_0116__ul17264192172814"><li id="css_03_0116__li1426414213282"><strong id="css_03_0116__b2265132122810">true</strong>: The modification succeeded.</li><li id="css_03_0116__li122663262812"><strong id="css_03_0116__b1926632152818">false</strong>: The modification failed.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0116__row825582162814"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0116__p12671028282">externalMessage</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0116__p132681026286">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0116__p2269323287">Error message. If <strong id="css_03_0116__b162703212285">acknowledged</strong> was set to <strong id="css_03_0116__b12703222817">true</strong>, <strong id="css_03_0116__b10270526282">null</strong> is returned for this field.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0116__row025592112816"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0116__p1827122182813">httpErrorResponse</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0116__p192726217286">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0116__p327402122817">HTTP error information. The default value is <strong id="css_03_0116__b52751420281">null</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="css_03_0116__section027610242814"><h4 class="sectiontitle">Example Requests</h4><pre class="screen" id="css_03_0116__screen72781213286">{
|
|
"edit" : {
|
|
"modify" : {
|
|
"elasticsearch.yml" : {
|
|
"thread_pool.force_merge.size" : 1
|
|
}
|
|
}
|
|
}
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="css_03_0116__section228672142815"><h4 class="sectiontitle">Example Responses</h4><p id="css_03_0116__p162872216287"><strong id="css_03_0116__b1328710272816">Status code: 200</strong></p>
|
|
<p id="css_03_0116__p228718211287">Request succeeded.</p>
|
|
<pre class="screen" id="css_03_0116__screen142891528287">{
|
|
"acknowledged" : true,
|
|
"externalMessage" : null,
|
|
"httpErrorResponse" : null
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="css_03_0116__section929412162816"><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__row529512232814"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="css_03_0116__p12972027280">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="css_03_0116__p62981724284">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0116__row1429515216284"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0116__p12299320281">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0116__p1030017242811">Request succeeded.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0116__row16296525283"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0116__p1830112282818">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0116__p143021629288">Invalid request.</p>
|
|
<p id="css_03_0116__p43031029282">Modify the request before retry.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0116__row32963242815"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0116__p930482142816">409</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0116__p13053219289">The request could not be completed due to a conflict with the current state of the resource.</p>
|
|
<p id="css_03_0116__p1330613282820">The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0116__row1729622112820"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0116__p1530816215289">412</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0116__p193108216282">The server did not meet one of the preconditions contained in 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>
|
|
|