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>
132 lines
11 KiB
HTML
132 lines
11 KiB
HTML
<a name="css_03_0118"></a><a name="css_03_0118"></a>
|
|
|
|
<h1 class="topictitle1">Obtaining the Parameter Configuration List</h1>
|
|
<div id="body0000001526730573"><div class="section" id="css_03_0118__section1892719501243"><h4 class="sectiontitle">Function</h4><p id="css_03_0118__p2928165082412">This API is used to obtain the parameter configuration list of the current cluster.</p>
|
|
</div>
|
|
<div class="section" id="css_03_0118__section2928250202410"><h4 class="sectiontitle">Debugging</h4><p id="css_03_0118__p19929750162417">You can debug this API in . Automatic authentication is supported.</p>
|
|
</div>
|
|
<div class="section" id="css_03_0118__section12929950172418"><h4 class="sectiontitle">URI</h4><p id="css_03_0118__p1592975022413">GET /v1.0/{project_id}/clusters/{cluster_id}/ymls/template</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0118__table1993114508248" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="css_03_0118__row9930185012243"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="css_03_0118__p189311950172416">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_0118__p16932450192420">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_0118__p189321050202419">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_0118__p12933155022412">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0118__row18930950102414"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="css_03_0118__p593385042413">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="css_03_0118__p1393415072417">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="css_03_0118__p14934155082416">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="css_03_0118__p149351550102413">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_0118__row4930175014248"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="css_03_0118__p0935105017247">cluster_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="css_03_0118__p129355501242">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="css_03_0118__p1593685092416">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="css_03_0118__p793655062417">ID of the cluster to be queried</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="css_03_0118__section693665013247"><h4 class="sectiontitle">Request Parameters</h4><p id="css_03_0118__p9936125020246">None</p>
|
|
</div>
|
|
<div class="section" id="css_03_0118__section4937195017241"><h4 class="sectiontitle">Response Parameters</h4><p id="css_03_0118__p393725022414"><strong id="css_03_0118__b18920177262383">Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0118__response_ListYmlConfigurationResponseBody" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response body parameter</caption><thead align="left"><tr id="css_03_0118__row7937165062415"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="css_03_0118__p149381550142416">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_0118__p49381250182419">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_0118__p1939155013242">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0118__row793745016244"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="css_03_0118__p793935042417">configurations</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="css_03_0118__p12939175052417">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="css_03_0118__p59400509246">Cluster parameter configuration list. The <strong id="css_03_0118__b132730551316">key</strong> value in the object is subject to the actual situation. The <strong id="css_03_0118__b19897182112139">value</strong> has the following attributes:</p>
|
|
<ul id="css_03_0118__ul3940185092413"><li id="css_03_0118__li8940850192411"><strong id="css_03_0118__b1544823531312">id</strong>: parameter ID.</li><li id="css_03_0118__li594011505249"><strong id="css_03_0118__b1711934017132">key</strong>: parameter name.</li><li id="css_03_0118__li17940195032419"><strong id="css_03_0118__b114341542131320">value</strong>: parameter value.</li><li id="css_03_0118__li1941125022414"><strong id="css_03_0118__b2901347161317">defaultValue</strong>: parameter default value.</li><li id="css_03_0118__li194115012412"><strong id="css_03_0118__b1935175018138">regex</strong>: parameter constraint.</li><li id="css_03_0118__li194185012241"><strong id="css_03_0118__b335615341318">desc</strong>: parameter description in Chinese.</li><li id="css_03_0118__li1194115509242"><strong id="css_03_0118__b6547115631314">type</strong>: parameter type description.</li><li id="css_03_0118__li494295017244"><strong id="css_03_0118__b88945011415">moduleDesc</strong>: parameter function description in Chinese.</li><li id="css_03_0118__li49421950142415"><strong id="css_03_0118__b2074219461417">modifyEnable</strong>: indicates whether a parameter can be modified. The value can be <strong id="css_03_0118__b714122417178">true</strong> (parameter value can be changed) and <strong id="css_03_0118__b151315141163">false</strong> (parameter value cannot be changed).</li><li id="css_03_0118__li5942145015243"><strong id="css_03_0118__b1439920171716">enableValue</strong>: parameter value that can be changed.</li><li id="css_03_0118__li14942155062413"><strong id="css_03_0118__b11319948164">fileName</strong>: name of the file where parameters exist. The default value is <strong id="css_03_0118__b788116185155">elasticsearch.yml</strong>.</li><li id="css_03_0118__li7943550202414"><strong id="css_03_0118__b141901224131515">version</strong>: version information.</li><li id="css_03_0118__li12943450152420"><strong id="css_03_0118__b1630573413154">descENG</strong>: parameter description in English.</li><li id="css_03_0118__li5944125019249"><strong id="css_03_0118__b2302491152">moduleDescENG</strong>: parameter function description in English.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="css_03_0118__section14945350182417"><h4 class="sectiontitle">Request Example</h4><p id="css_03_0118__p894525042419">None</p>
|
|
</div>
|
|
<div class="section" id="css_03_0118__section1594665012241"><h4 class="sectiontitle">Response Example</h4><p id="css_03_0118__p1794615018249"><strong id="css_03_0118__b6458038662383">Status code: 200</strong></p>
|
|
<p id="css_03_0118__p18947195062418">The request is processed successfully.</p>
|
|
<pre class="screen" id="css_03_0118__screen5948250162413">{
|
|
"configurations" : {
|
|
"http.cors.allow-credentials" : {
|
|
"id" : "b462d13c-294b-4e0f-91d3-58be2ad02b99",
|
|
"key" : "http.cors.allow-credentials",
|
|
"value" : "false",
|
|
"defaultValue" : "false",
|
|
"regex" : "^(true|false)$",
|
|
"desc" : "Indicates whether to return <strong id="css_03_0118__b6919727182015">Access-Control-Allow-Credentials</strong> in the header during cross-domain access. The value is of the Boolean type and can be <strong id="css_03_0118__b292018274209">true</strong> or <strong id="css_03_0118__b992110278202">false</strong>.
|
|
"type" : "Boolean",
|
|
"moduleDesc" : "Cross-domain access",
|
|
"modifyEnable" : "true",
|
|
"enableValue" : "true,false",
|
|
"fileName" : "elasticsearch.yml",
|
|
"version" : null,
|
|
"descENG" : "Whether to return the Access-Control-Allow-Credentials of the header during cross-domain access. The value is a Boolean value and the options are true and false.",
|
|
"moduleDescENG" : "Cross-domain Access"
|
|
}
|
|
}
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="css_03_0118__section295135042410"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0118__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="css_03_0118__row169525502241"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="css_03_0118__p4953950102415">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_0118__p895315012410">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0118__row9952450102414"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="css_03_0118__p149531150142413">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="css_03_0118__p1895411507242">The request is processed successfully.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0118__row17952135002411"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="css_03_0118__p209549506242">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="css_03_0118__p8954650202415">Invalid request.</p>
|
|
<p id="css_03_0118__p29543501244">Modify the request instead of retrying.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0118__row149521150102420"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="css_03_0118__p1095513504249">409</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="css_03_0118__p9955250102413">The request cannot be processed due to a conflict.</p>
|
|
<p id="css_03_0118__p795511508242">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_0118__row179525508249"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="css_03_0118__p995655032411">412</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="css_03_0118__p995613509247">The server does not meet one of the requirements that the requester puts on the request.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<p id="css_03_0118__p8060118"></p>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="css_03_0115.html">Parameter Configuration</a></div>
|
|
</div>
|
|
</div>
|
|
|