Files
doc-exports/docs/cce/api-ref/ShowClusterConfigurationDetails.html
qiujiandong1 5d711fd34a CCE API 20250311 version
Reviewed-by: Eotvos, Oliver <oliver.eotvos@t-systems.com>
Co-authored-by: qiujiandong1 <qiujiandong1@huawei.com>
Co-committed-by: qiujiandong1 <qiujiandong1@huawei.com>
2025-07-17 10:46:59 +00:00

226 lines
21 KiB
HTML

<a name="ShowClusterConfigurationDetails"></a><a name="ShowClusterConfigurationDetails"></a>
<h1 class="topictitle1">Obtaining the List of Parameters That Can Be Configured for a Cluster</h1>
<div id="body32001227"><div class="section" id="ShowClusterConfigurationDetails__section13296315151619"><h4 class="sectiontitle">Function</h4><p id="ShowClusterConfigurationDetails__p162961815121618">This API is used to obtain the list of parameters that can be configured for a CCE cluster.</p>
</div>
<div class="section" id="ShowClusterConfigurationDetails__en-us_topic_0000002284800664_atuogenerate_1"><h4 class="sectiontitle">URI</h4><p id="ShowClusterConfigurationDetails__p72971315151620">GET /api/v3/projects/{project_id}/clusters/{cluster_id}/configuration/detail</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowClusterConfigurationDetails__table15298171591615" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="ShowClusterConfigurationDetails__row9298191501617"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ShowClusterConfigurationDetails__p3298101517167">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ShowClusterConfigurationDetails__p182981915161612">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="ShowClusterConfigurationDetails__p7298115121611">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="ShowClusterConfigurationDetails__p12298161518164">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowClusterConfigurationDetails__row15298181531620"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ShowClusterConfigurationDetails__p2298115111616">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ShowClusterConfigurationDetails__p162982153164">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ShowClusterConfigurationDetails__p10299141517161">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ShowClusterConfigurationDetails__p11299181519167"><strong id="ShowClusterConfigurationDetails__b1529915155169">Details</strong>:</p>
<p id="ShowClusterConfigurationDetails__p7299121571615">Project ID. For details about how to obtain the value, see <a href="cce_02_0271.html">How to Obtain Parameters in the API URI</a>.</p>
<p id="ShowClusterConfigurationDetails__p92994159162"><strong id="ShowClusterConfigurationDetails__b22993155166">Constraints</strong>:</p>
<p id="ShowClusterConfigurationDetails__p929916152161">None</p>
<p id="ShowClusterConfigurationDetails__p112992015151611"><strong id="ShowClusterConfigurationDetails__b152993150165">Options</strong>:</p>
<p id="ShowClusterConfigurationDetails__p129911571614">Project IDs of the account</p>
<p id="ShowClusterConfigurationDetails__p1029911521611"><strong id="ShowClusterConfigurationDetails__b1629916159160">Default value</strong>:</p>
<p id="ShowClusterConfigurationDetails__p1229913158163">N/A</p>
</td>
</tr>
<tr id="ShowClusterConfigurationDetails__row13298215151611"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ShowClusterConfigurationDetails__p72991415191614">cluster_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ShowClusterConfigurationDetails__p62995157160">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ShowClusterConfigurationDetails__p1299201591616">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ShowClusterConfigurationDetails__p17299131514161"><strong id="ShowClusterConfigurationDetails__b629910153160">Details</strong>:</p>
<p id="ShowClusterConfigurationDetails__p13299515171616">Cluster ID. For details about how to obtain the value, see <a href="cce_02_0271.html">How to Obtain Parameters in the API URI</a>.</p>
<p id="ShowClusterConfigurationDetails__p42995157166"><strong id="ShowClusterConfigurationDetails__b8299101520165">Constraints</strong>:</p>
<p id="ShowClusterConfigurationDetails__p12299121531615">None</p>
<p id="ShowClusterConfigurationDetails__p10299015111615"><strong id="ShowClusterConfigurationDetails__b122992159165">Options</strong>:</p>
<p id="ShowClusterConfigurationDetails__p529911157163">Cluster IDs</p>
<p id="ShowClusterConfigurationDetails__p1299121515161"><strong id="ShowClusterConfigurationDetails__b129920150165">Default value</strong>:</p>
<p id="ShowClusterConfigurationDetails__p1929951515164">N/A</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ShowClusterConfigurationDetails__section182996151162"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowClusterConfigurationDetails__en-us_topic_0000002284800664_HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="ShowClusterConfigurationDetails__row530071514168"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="ShowClusterConfigurationDetails__p1300815111615">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="ShowClusterConfigurationDetails__p8300315151619">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="ShowClusterConfigurationDetails__p1300121541611">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="ShowClusterConfigurationDetails__p7300141591616">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowClusterConfigurationDetails__row19300815161614"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ShowClusterConfigurationDetails__p330031541619">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ShowClusterConfigurationDetails__p7300131511163">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ShowClusterConfigurationDetails__p17300151519161">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ShowClusterConfigurationDetails__p10300315101611"><strong id="ShowClusterConfigurationDetails__b330091591618">Details</strong>:</p>
<p id="ShowClusterConfigurationDetails__p93001215131619">The request body type or format</p>
<p id="ShowClusterConfigurationDetails__p1630051511616"><strong id="ShowClusterConfigurationDetails__b0301315111612">Constraints</strong>:</p>
<p id="ShowClusterConfigurationDetails__p17301111520164">The GET method is not verified.</p>
<p id="ShowClusterConfigurationDetails__p830181511167"><strong id="ShowClusterConfigurationDetails__b730101501610">Options</strong>:</p>
<ul id="ShowClusterConfigurationDetails__ul1930114158167"><li id="ShowClusterConfigurationDetails__li8301515171610"><p id="ShowClusterConfigurationDetails__p5301201514168"><a name="ShowClusterConfigurationDetails__li8301515171610"></a><a name="li8301515171610"></a>application/json</p>
</li><li id="ShowClusterConfigurationDetails__li1130121541613"><p id="ShowClusterConfigurationDetails__p530116159162"><a name="ShowClusterConfigurationDetails__li1130121541613"></a><a name="li1130121541613"></a>application/json;charset=utf-8</p>
</li><li id="ShowClusterConfigurationDetails__li16301141520162"><p id="ShowClusterConfigurationDetails__p6301215161616"><a name="ShowClusterConfigurationDetails__li16301141520162"></a><a name="li16301141520162"></a>application/x-pem-file</p>
</li><li id="ShowClusterConfigurationDetails__li63018155166"><p id="ShowClusterConfigurationDetails__p1301151591613"><a name="ShowClusterConfigurationDetails__li63018155166"></a><a name="li63018155166"></a>multipart/form-data (used when the <strong id="ShowClusterConfigurationDetails__b193015153167">FormData</strong> parameter is present)</p>
</li></ul>
<p id="ShowClusterConfigurationDetails__p1230181517161"><strong id="ShowClusterConfigurationDetails__b8301111561619">Default value</strong>:</p>
<p id="ShowClusterConfigurationDetails__p13301115131617">N/A</p>
</td>
</tr>
<tr id="ShowClusterConfigurationDetails__row6300131512161"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ShowClusterConfigurationDetails__p1130191510160">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ShowClusterConfigurationDetails__p330151518165">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ShowClusterConfigurationDetails__p1630117153167">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ShowClusterConfigurationDetails__p330171518164"><strong id="ShowClusterConfigurationDetails__b6301151516167">Details</strong>:</p>
<p id="ShowClusterConfigurationDetails__p130171518163">Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token. For details, see <a href="cce_02_0004.html">Obtaining a User Token</a>.</p>
<p id="ShowClusterConfigurationDetails__p830118154160"><strong id="ShowClusterConfigurationDetails__b2301191515167">Constraints</strong>:</p>
<p id="ShowClusterConfigurationDetails__p1301181561613">None</p>
<p id="ShowClusterConfigurationDetails__p1830119150165"><strong id="ShowClusterConfigurationDetails__b1301171513166">Options</strong>:</p>
<p id="ShowClusterConfigurationDetails__p5301151541620">N/A</p>
<p id="ShowClusterConfigurationDetails__p4301615111617"><strong id="ShowClusterConfigurationDetails__b10301615181615">Default value</strong>:</p>
<p id="ShowClusterConfigurationDetails__p1830131510164">N/A</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ShowClusterConfigurationDetails__section14302201514169"><h4 class="sectiontitle">Response Parameters</h4><p id="ShowClusterConfigurationDetails__p18302015131611"><strong id="ShowClusterConfigurationDetails__b53022153163">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowClusterConfigurationDetails__en-us_topic_0000002284800664_response_ClusterConfigDetailRespBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="ShowClusterConfigurationDetails__row0302915111613"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.1"><p id="ShowClusterConfigurationDetails__p1230281511613">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.2"><p id="ShowClusterConfigurationDetails__p03021215121615">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.4.1.3"><p id="ShowClusterConfigurationDetails__p1630211541612">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowClusterConfigurationDetails__row20302101571616"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowClusterConfigurationDetails__p1130221561612">{User defined key}</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowClusterConfigurationDetails__p18302151521619">Map&lt;String,Array&lt;<a href="#ShowClusterConfigurationDetails__en-us_topic_0000002284800664_response_PackageOptions">PackageOptions</a>&gt;&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowClusterConfigurationDetails__p17302915131612">Response body for obtaining the parameter configuration list of a cluster</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ShowClusterConfigurationDetails__en-us_topic_0000002284800664_response_PackageOptions"></a><a name="en-us_topic_0000002284800664_response_PackageOptions"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowClusterConfigurationDetails__en-us_topic_0000002284800664_response_PackageOptions" frame="border" border="1" rules="all"><caption><b>Table 4 </b>PackageOptions</caption><thead align="left"><tr id="ShowClusterConfigurationDetails__row630318155163"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.1"><p id="ShowClusterConfigurationDetails__p5303215181612">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.2"><p id="ShowClusterConfigurationDetails__p230361518168">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.4.2.4.1.3"><p id="ShowClusterConfigurationDetails__p18303215131618">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowClusterConfigurationDetails__row630318152165"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowClusterConfigurationDetails__p1030311511611">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowClusterConfigurationDetails__p1030317151162">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowClusterConfigurationDetails__p53031815191613">Parameter name</p>
</td>
</tr>
<tr id="ShowClusterConfigurationDetails__row17303181519164"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowClusterConfigurationDetails__p23031615161611">default</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowClusterConfigurationDetails__p1530491561615">Object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowClusterConfigurationDetails__p16304111541617">Default parameter value. If this parameter is not specified, the default value will take effect. The returned parameter can be of integer, string, or Boolean type.</p>
</td>
</tr>
<tr id="ShowClusterConfigurationDetails__row3303715191614"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowClusterConfigurationDetails__p2304915141612">validAt</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowClusterConfigurationDetails__p1530417155167">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowClusterConfigurationDetails__p230410159164">How parameters will take effect.</p>
<ul id="ShowClusterConfigurationDetails__ul4304201515167"><li id="ShowClusterConfigurationDetails__li1304111510162"><p id="ShowClusterConfigurationDetails__p17304415191613"><a name="ShowClusterConfigurationDetails__li1304111510162"></a><a name="li1304111510162"></a><strong id="ShowClusterConfigurationDetails__b630491512169">static</strong>: The parameters take effect when the cluster or node pool is being created and cannot be changed later.</p>
</li><li id="ShowClusterConfigurationDetails__li1030415157161"><p id="ShowClusterConfigurationDetails__p530411158161"><a name="ShowClusterConfigurationDetails__li1030415157161"></a><a name="li1030415157161"></a><strong id="ShowClusterConfigurationDetails__b6304191517162">immediately</strong>: The parameters can be modified when the cluster or node pool is running, and the modification takes effect immediately.</p>
</li></ul>
</td>
</tr>
<tr id="ShowClusterConfigurationDetails__row5303181512162"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowClusterConfigurationDetails__p17304151518167">empty</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowClusterConfigurationDetails__p8304215181617">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowClusterConfigurationDetails__p63041515111610">Whether the configuration item can be empty. Options:</p>
<ul id="ShowClusterConfigurationDetails__ul230471511611"><li id="ShowClusterConfigurationDetails__li15304115151619"><p id="ShowClusterConfigurationDetails__p17304115201612"><a name="ShowClusterConfigurationDetails__li15304115151619"></a><a name="li15304115151619"></a><strong id="ShowClusterConfigurationDetails__b1630421521614">true</strong>: If this parameter is set to <strong id="ShowClusterConfigurationDetails__b19304191516169">true</strong>, no value will take effect.</p>
</li><li id="ShowClusterConfigurationDetails__li3304111571619"><p id="ShowClusterConfigurationDetails__p19304151520166"><a name="ShowClusterConfigurationDetails__li3304111571619"></a><a name="li3304111571619"></a><strong id="ShowClusterConfigurationDetails__b83047158162">false</strong>: If this parameter is set to <strong id="ShowClusterConfigurationDetails__b193041715131616">false</strong>, the default value will take effect.</p>
</li></ul>
</td>
</tr>
<tr id="ShowClusterConfigurationDetails__row1230391571614"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowClusterConfigurationDetails__p19304151581617">schema</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowClusterConfigurationDetails__p2304191551620">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowClusterConfigurationDetails__p1430471511613">Parameter category</p>
</td>
</tr>
<tr id="ShowClusterConfigurationDetails__row14303151512167"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowClusterConfigurationDetails__p16304181591617">type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowClusterConfigurationDetails__p1330571501617">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowClusterConfigurationDetails__p13051215101611">Parameter type</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ShowClusterConfigurationDetails__section103058155165"><h4 class="sectiontitle">Example Requests</h4><p id="ShowClusterConfigurationDetails__p13305151551612">None</p>
</div>
<div class="section" id="ShowClusterConfigurationDetails__section1030510153165"><h4 class="sectiontitle">Example Responses</h4><p id="ShowClusterConfigurationDetails__p1830551519169"><strong id="ShowClusterConfigurationDetails__b930541591614">Status code: 200</strong></p>
<p id="ShowClusterConfigurationDetails__p130551531611">A list of parameters that can be configured for a cluster is obtained successfully.</p>
<pre class="screen" id="ShowClusterConfigurationDetails__screen830517159165">{
"kube-apiserver" : [ {
"name" : "default-not-ready-toleration-seconds",
"default" : 300,
"validAt" : "immediately",
"empty" : true,
"schema" : "kubernetes",
"type" : "int"
} ]
}</pre>
</div>
<div class="section" id="ShowClusterConfigurationDetails__section1630541551610"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowClusterConfigurationDetails__en-us_topic_0000002284800664_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="ShowClusterConfigurationDetails__row18305161512165"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="ShowClusterConfigurationDetails__p193061156160">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="ShowClusterConfigurationDetails__p123061157162">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowClusterConfigurationDetails__row18305515101611"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ShowClusterConfigurationDetails__p18306201551617">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ShowClusterConfigurationDetails__p63060150165">A list of parameters that can be configured for a cluster is obtained successfully.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ShowClusterConfigurationDetails__section1230615152163"><h4 class="sectiontitle">Error Codes</h4><p id="ShowClusterConfigurationDetails__p1730661591612">See <a href="cce_02_0250.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="configuration_lifecycle_management.html">Configuration Management</a></div>
</div>
</div>