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>
129 lines
10 KiB
HTML
129 lines
10 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__section812211273289"><h4 class="sectiontitle">Function</h4><p id="css_03_0118__p11123162742814">This API is used to obtain the parameter configuration list of the current cluster.</p>
|
|
</div>
|
|
<div class="section" id="css_03_0118__section1912732713288"><h4 class="sectiontitle">URI</h4><p id="css_03_0118__p4128192792814">GET /v1.0/{project_id}/clusters/{cluster_id}/ymls/template</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0118__table1613162710281" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="css_03_0118__row1213032722810"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="css_03_0118__p131323277281">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_0118__p121331827142817">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_0118__p1913482719286">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_0118__p41366278288">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0118__row213018270283"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0118__p161371827182817">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="css_03_0118__p1013912275281">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0118__p1214002713285">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0118__p214118271280">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_0118__row213012715289"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0118__p414216271289">cluster_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="css_03_0118__p41437275287">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0118__p1114562717286">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0118__p18146627132813">ID of the cluster you want to query.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="css_03_0118__section1214782712819"><h4 class="sectiontitle">Request Parameters</h4><p id="css_03_0118__p71481927162819">None</p>
|
|
</div>
|
|
<div class="section" id="css_03_0118__section5150227152814"><h4 class="sectiontitle">Response Parameters</h4><p id="css_03_0118__p11152172711287"><strong id="css_03_0118__b215202716289">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 parameters</caption><thead align="left"><tr id="css_03_0118__row131531627132819"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="css_03_0118__p12156162712280">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_0118__p6157182711284">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_0118__p141581127122814">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0118__row13154182772814"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0118__p7159152772816">configurations</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0118__p15160132712282">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0118__p81621027142810">Cluster parameter configuration list. The <strong id="css_03_0118__b18162182752816">key</strong> value in the object is subject to the actual situation. The <strong id="css_03_0118__b61621827172817">value</strong> has the following attributes:</p>
|
|
<ul id="css_03_0118__ul216592711280"><li id="css_03_0118__li216510277288"><strong id="css_03_0118__b016713279282">id</strong>: parameter ID.</li><li id="css_03_0118__li5167112716285"><strong id="css_03_0118__b181689272289">key</strong>: parameter name.</li><li id="css_03_0118__li1416862792817"><strong id="css_03_0118__b19169627192811">value</strong>: parameter value.</li><li id="css_03_0118__li41701427182812"><strong id="css_03_0118__b717111275286">defaultValue</strong>: parameter default value.</li><li id="css_03_0118__li117102714283"><strong id="css_03_0118__b817218273285">regex</strong>: parameter constraint.</li><li id="css_03_0118__li13173172711282"><strong id="css_03_0118__b17175112782810">desc</strong>: parameter description.</li><li id="css_03_0118__li31793279286"><strong id="css_03_0118__b17180627172812">type</strong>: parameter type description.</li><li id="css_03_0118__li1518032719281"><strong id="css_03_0118__b12182132718288">moduleDesc</strong>: parameter function description.</li><li id="css_03_0118__li618252702814"><strong id="css_03_0118__b1118462712813">modifyEnable</strong>: whether a parameter can be modified. <strong id="css_03_0118__b21841527132812">true</strong>: The value can be changed. <strong id="css_03_0118__b18184727112812">false</strong>: The value cannot be changed.</li><li id="css_03_0118__li1818582732820"><strong id="css_03_0118__b1018632762815">enableValue</strong>: parameter value that can be changed.</li><li id="css_03_0118__li191864270282"><strong id="css_03_0118__b12187027192815">fileName</strong>: name of the file where parameters exist. The default value is <strong id="css_03_0118__b9187102710281">elasticsearch.yml</strong>.</li><li id="css_03_0118__li1718872742816"><strong id="css_03_0118__b618902718288">version</strong>: version information.</li><li id="css_03_0118__li1190927182815"><strong id="css_03_0118__b319112715286">descENG</strong>: parameter description.</li><li id="css_03_0118__li101911527182815"><strong id="css_03_0118__b819222752819">moduleDescENG</strong>: parameter function description.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="css_03_0118__section13193127122813"><h4 class="sectiontitle">Example Requests</h4><p id="css_03_0118__p17194102714283">None</p>
|
|
</div>
|
|
<div class="section" id="css_03_0118__section1019522722810"><h4 class="sectiontitle">Example Responses</h4><p id="css_03_0118__p171961327142810"><strong id="css_03_0118__b17197112711281">Status code: 200</strong></p>
|
|
<p id="css_03_0118__p2197182713286">Request succeeded.</p>
|
|
<pre class="screen" id="css_03_0118__screen1220162722816">{
|
|
"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 **Access-Control-Allow-Credentials** in the header during cross-domain access. The value is of the Boolean type and can be **true** or **false**.",
|
|
"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__section8223102712288"><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__row0225927112814"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="css_03_0118__p11227132762819">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_0118__p122281727142811">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0118__row1225142742820"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0118__p1229427172817">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0118__p1323113277288">Request succeeded.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0118__row202251827202811"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0118__p1923212278286">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0118__p17233527182812">Invalid request.</p>
|
|
<p id="css_03_0118__p122345277288">Modify the request before retry.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0118__row132251827112816"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0118__p12351927182817">409</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0118__p3236192717289">The request could not be completed due to a conflict with the current state of the resource.</p>
|
|
<p id="css_03_0118__p1223715275281">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_0118__row1922542716289"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0118__p1423852717289">412</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0118__p1424082782810">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>
|
|
|