vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/cce/api-ref/cce_02_0238.html
Dong, Qiu Jian 11d29221d4 CCE API: Updated the ipv6enable field - 20240524 version 
Reviewed-by: Eotvos, Oliver <oliver.eotvos@t-systems.com>
Co-authored-by: Dong, Qiu Jian <qiujiandong1@huawei.com>
Co-committed-by: Dong, Qiu Jian <qiujiandong1@huawei.com>
2024-06-07 15:48:26 +00:00

626 lines
53 KiB
HTML
Raw Blame History

<a name="cce_02_0238"></a><a name="cce_02_0238"></a>
<h1 class="topictitle1">Reading a Specified Cluster</h1>
<div id="body1521448221833"><div class="section" id="cce_02_0238__section1686113493165"><h4 class="sectiontitle">Function</h4><p id="cce_02_0238__p209621357141610">This API is used to obtain details about a specified cluster.</p>
</div>
<div class="section" id="cce_02_0238__section8403243161416"><h4 class="sectiontitle">URI</h4><p id="cce_02_0238__p23575517439">GET /api/v3/projects/{project_id}/clusters/{cluster_id}</p>
<p id="cce_02_0238__p2037362514220"><a href="#cce_02_0238__table2027961241820">Table 1</a> describes the parameters of this API.</p>
<div class="tablenoborder"><a name="cce_02_0238__table2027961241820"></a><a name="table2027961241820"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0238__table2027961241820" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="cce_02_0238__row122809120186"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.4.1.1"><p id="cce_02_0238__p91421758131813">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12%" id="mcps1.3.2.4.2.4.1.2"><p id="cce_02_0238__p101421758131816">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="68%" id="mcps1.3.2.4.2.4.1.3"><p id="cce_02_0238__p19143115818187">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cce_02_0238__row32801312121810"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.4.1.1 "><p id="cce_02_0238__p1714415589184">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.2.4.2.4.1.2 "><p id="cce_02_0238__p814518580186">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="68%" headers="mcps1.3.2.4.2.4.1.3 "><p id="cce_02_0238__p5145175891811">Project ID. For details about how to obtain the project ID, see <a href="cce_02_0271.html">How to Obtain Parameters in the API URI</a>.</p>
</td>
</tr>
<tr id="cce_02_0238__row126417469411"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.4.1.1 "><p id="cce_02_0238__p5642046194113">cluster_id</p>
</td>
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.2.4.2.4.1.2 "><p id="cce_02_0238__p146484634113">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="68%" headers="mcps1.3.2.4.2.4.1.3 "><p id="cce_02_0238__p664164613418">Cluster ID. For details about how to obtain the cluster ID, see <a href="cce_02_0271.html">How to Obtain Parameters in the API URI</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="cce_02_0238__section947084713911"><h4 class="sectiontitle">Request</h4><p id="cce_02_0238__p10314164115415"><strong id="cce_02_0238__b162259487412">Request parameters</strong>:</p>
<p id="cce_02_0238__p7105145203655"><a href="#cce_02_0238__table538113720514">Table 2</a> lists the request parameters.</p>
<div class="tablenoborder"><a name="cce_02_0238__table538113720514"></a><a name="table538113720514"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0238__table538113720514" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters in the request header</caption><thead align="left"><tr id="cce_02_0238__en-us_topic_0199164459_row55001954122614"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.4.1.1"><p id="cce_02_0238__en-us_topic_0199164459_p115009545264">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19%" id="mcps1.3.3.4.2.4.1.2"><p id="cce_02_0238__en-us_topic_0199164459_p175001547265">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="61%" id="mcps1.3.3.4.2.4.1.3"><p id="cce_02_0238__en-us_topic_0199164459_p16500154162611">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cce_02_0238__en-us_topic_0199164459_row199801811203412"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.4.1.1 "><p id="cce_02_0238__en-us_topic_0199164459_p69808112344">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.3.4.2.4.1.2 "><p id="cce_02_0238__en-us_topic_0199164459_p3980111103414">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="61%" headers="mcps1.3.3.4.2.4.1.3 "><p id="cce_02_0238__en-us_topic_0199164459_p169801011203416">Message body type (format). Possible values:</p>
<ul id="cce_02_0238__en-us_topic_0199164459_ul7385444163617"><li id="cce_02_0238__en-us_topic_0199164459_li18385114483612">application/json;charset=utf-8</li><li id="cce_02_0238__en-us_topic_0199164459_li3516132853714">application/json</li></ul>
</td>
</tr>
<tr id="cce_02_0238__en-us_topic_0199164459_row3500125412260"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.4.1.1 "><p id="cce_02_0238__en-us_topic_0199164459_p105001654202618">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.3.4.2.4.1.2 "><p id="cce_02_0238__en-us_topic_0199164459_p20500954182618">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="61%" headers="mcps1.3.3.4.2.4.1.3 "><p id="cce_02_0238__p35202313507">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 on how to obtain a user token, see <a href="cce_02_0004.html">API Usage Guidelines</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="cce_02_0238__p1611232212217"><strong id="cce_02_0238__b18637103252113">Example request</strong>:</p>
<p id="cce_02_0238__p10992402120">N/A</p>
</div>
<div class="section" id="cce_02_0238__section61819725020"><h4 class="sectiontitle">Response</h4><p id="cce_02_0238__en-us_topic_0079614900_p2018733"><strong id="cce_02_0238__en-us_topic_0079614900_b18168603">Response parameters:</strong></p>
<p id="cce_02_0238__p16966318249"><a href="#cce_02_0238__table34052983203655">Table 3</a> describes the response parameters.</p>
<div class="tablenoborder"><a name="cce_02_0238__table34052983203655"></a><a name="table34052983203655"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0238__table34052983203655" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameters</caption><thead align="left"><tr id="cce_02_0238__row30254333203655"><th align="left" class="cellrowborder" valign="top" width="21%" id="mcps1.3.4.4.2.4.1.1"><p id="cce_02_0238__p34681881203655">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="27%" id="mcps1.3.4.4.2.4.1.2"><p id="cce_02_0238__p57769002203655">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52%" id="mcps1.3.4.4.2.4.1.3"><p id="cce_02_0238__p58673482203655">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cce_02_0238__row54931625203655"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cce_02_0238__p44731858185518">kind</p>
</td>
<td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cce_02_0238__p57145269553">String</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cce_02_0238__p12712326175517">API type. The value is fixed at <strong id="cce_02_0238__b14211820173214">Cluster</strong> and cannot be changed.</p>
</td>
</tr>
<tr id="cce_02_0238__row15234185203655"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cce_02_0238__p144741580551">apiVersion</p>
</td>
<td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cce_02_0238__p6707526185513">String</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cce_02_0238__p1770492695518">API version. The value is fixed at <strong id="cce_02_0238__b126571459155415">v3</strong> and cannot be changed.</p>
</td>
</tr>
<tr id="cce_02_0238__row1122635417553"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cce_02_0238__p144741558135518">metadata</p>
</td>
<td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cce_02_0238__p18711257121911"><a href="cce_02_0236.html#cce_02_0236__table669019286188">metadata</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cce_02_0238__p16108141202712">Cluster metadata, which is a collection of attributes.</p>
</td>
</tr>
<tr id="cce_02_0238__row9619511127"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cce_02_0238__p4785161212">spec</p>
</td>
<td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cce_02_0238__p13198142153113"><a href="#cce_02_0238__table1034041612134">spec</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cce_02_0238__p1896142152710">Detailed description of the cluster targeted by this API. CCE creates or updates objects by defining or updating its spec.</p>
</td>
</tr>
<tr id="cce_02_0238__row4466312313"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cce_02_0238__p15204203610152">status</p>
</td>
<td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cce_02_0238__p138171915205"><a href="#cce_02_0238__table6749834132215">status</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cce_02_0238__p166941916272">Cluster status and jobID of the job that reads a specified cluster.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="cce_02_0238__table1034041612134"></a><a name="table1034041612134"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0238__table1034041612134" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Data structure of the <strong id="cce_02_0238__b148704303206">spec</strong> field</caption><thead align="left"><tr id="cce_02_0238__row14348121616132"><th align="left" class="cellrowborder" valign="top" width="23.26%" id="mcps1.3.4.5.2.4.1.1"><p id="cce_02_0238__p133505167139">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.93%" id="mcps1.3.4.5.2.4.1.2"><p id="cce_02_0238__p735501615139">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.81%" id="mcps1.3.4.5.2.4.1.3"><p id="cce_02_0238__p15357151631311">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cce_02_0238__row1691013144014"><td class="cellrowborder" valign="top" width="23.26%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cce_02_0238__p44543171286">category</p>
</td>
<td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cce_02_0238__p94543171188">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.81%" headers="mcps1.3.4.5.2.4.1.3 "><div class="p" id="cce_02_0238__p1445414171086">Cluster category:<ul id="cce_02_0238__ul1126620151116"><li id="cce_02_0238__li12642019119">CCE: CCE cluster</li><li id="cce_02_0238__li1226122019112">Turbo: CCE Turbo cluster</li></ul>
</div>
<div class="note" id="cce_02_0238__note1173936124019"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="cce_02_0238__p107391263409">This parameter is valid in cluster of v1.17.17 or higher.</p>
</div></div>
</td>
</tr>
<tr id="cce_02_0238__row178365271483"><td class="cellrowborder" valign="top" width="23.26%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cce_02_0238__p146521540191916">type</p>
</td>
<td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cce_02_0238__p1052510179227">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.81%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cce_02_0238__p1691385774411">Cluster type.</p>
<p id="cce_02_0238__p115781428135215"><strong id="cce_02_0238__b122221723185118">VirtualMachine</strong>: The master node architecture is x86.</p>
</td>
</tr>
<tr id="cce_02_0238__row111221127144415"><td class="cellrowborder" valign="top" width="23.26%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cce_02_0238__p1612362713448">flavor</p>
</td>
<td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cce_02_0238__p1512392713442">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.81%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cce_02_0238__p16621941104417">Cluster flavor, which cannot be changed after the cluster is created.</p>
<ul id="cce_02_0238__ul4805141115020"><li id="cce_02_0238__cce_02_0236_li14485164815445"><strong id="cce_02_0238__cce_02_0236_b11489836273">cce.s1.small</strong>: small-scale, single-master cluster (≤ 50 nodes)</li><li id="cce_02_0238__cce_02_0236_li64859483443"><strong id="cce_02_0238__cce_02_0236_b367910942720">cce.s1.medium</strong>: medium-scale, single-master cluster (≤ 200 nodes)</li><li id="cce_02_0238__cce_02_0236_li8486648124416"><strong id="cce_02_0238__cce_02_0236_b1081317262919">cce.s2.small</strong>: small-scale, high availability cluster (≤ 50 nodes)</li><li id="cce_02_0238__cce_02_0236_li348664814416"><strong id="cce_02_0238__cce_02_0236_b1689322115296">cce.s2.medium</strong>: medium-scale, high availability cluster (≤ 200 nodes)</li><li id="cce_02_0238__cce_02_0236_li1848684815442"><strong id="cce_02_0238__cce_02_0236_b57413316296">cce.s2.large</strong>: large-scale, high availability cluster (≤ 1,000 nodes)</li><li id="cce_02_0238__cce_02_0236_li15483153111118"><strong id="cce_02_0238__cce_02_0236_b195451031102014">cce.s2.xlarge</strong>: ultra-large-scale, high availability cluster (≤ 2,000 nodes)</li></ul>
<div class="note" id="cce_02_0238__note10821115618447"><span class="notetitle"> NOTE: </span><div class="notebody"><ul id="cce_02_0238__ul13821356164415"><li id="cce_02_0238__li68211756114414">s1: single-master cluster</li><li id="cce_02_0238__li5821556144419">s2: high availability cluster</li><li id="cce_02_0238__li58221656194414">For example, <strong id="cce_02_0238__b1251010481560">≤ 50 nodes</strong> indicates that the maximum number of nodes that can be managed by the cluster is 50.</li><li id="cce_02_0238__li1882216565446">A single-master cluster has only one master node. If the master node is down, the cluster will become unavailable and stop serving new workloads. However, existing workloads in the cluster are not affected.</li><li id="cce_02_0238__li128221456114412">A high-availability cluster has multiple master nodes. Faults in a single master node will not take the cluster down.</li></ul>
</div></div>
</td>
</tr>
<tr id="cce_02_0238__row83711516191317"><td class="cellrowborder" valign="top" width="23.26%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cce_02_0238__p1565217404195">version</p>
</td>
<td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cce_02_0238__p252511174227">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.81%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cce_02_0238__p0929195015409">Cluster's baseline Kubernetes version. The latest version is recommended.</p>
</td>
</tr>
<tr id="cce_02_0238__row1126035716393"><td class="cellrowborder" valign="top" width="23.26%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cce_02_0238__p1884144893515">platformVersion</p>
</td>
<td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cce_02_0238__p284124873520">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.81%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cce_02_0238__p38411148113510">Version of the CCE cluster platform, which is for viewing only and cannot be specified during cluster creation. The latest platform version corresponding to the cluster version is automatically selected during cluster creation.</p>
<div class="p" id="cce_02_0238__p10350184112363">Value format: <strong id="cce_02_0238__b9950204813384">cce.X.Y</strong><ul id="cce_02_0238__ul24765594314"><li id="cce_02_0238__li14761859431"><strong id="cce_02_0238__b146921148154814">X</strong> indicates the quarterly or regularly feature version number, starting from 1.</li><li id="cce_02_0238__li84766513437"><strong id="cce_02_0238__b8450650184815">Y</strong> indicates the patch version of the cluster, starting from 0 (feature version). Other values indicate later patch versions after the feature version is released.</li></ul>
</div>
</td>
</tr>
<tr id="cce_02_0238__row533805884917"><td class="cellrowborder" valign="top" width="23.26%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cce_02_0238__p1633905884915">az</p>
</td>
<td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cce_02_0238__p13391558194914">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.81%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cce_02_0238__p56473409213">AZ of the cluster.</p>
</td>
</tr>
<tr id="cce_02_0238__row8880154533217"><td class="cellrowborder" valign="top" width="23.26%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cce_02_0238__p61211443864">ipv6enable</p>
</td>
<td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cce_02_0238__p712119434619">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="55.81%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cce_02_0238__p10837151832714"><span id="cce_02_0238__ph104128541136">Whether the cluster supports IPv6 addresses. This field is supported in clusters of v1.25 and later versions.</span></p>
</td>
</tr>
<tr id="cce_02_0238__row53621622155010"><td class="cellrowborder" valign="top" width="23.26%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cce_02_0238__p1036210224509">supportIstio</p>
</td>
<td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cce_02_0238__p193621822175012">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.81%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cce_02_0238__p4339111123319">Reserved. This parameter is not used in the current version.</p>
<div class="note" id="cce_02_0238__note14449515181617"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="cce_02_0238__p1644917159167">This field is not supported for the current version.</p>
</div></div>
</td>
</tr>
<tr id="cce_02_0238__row20432126134212"><td class="cellrowborder" valign="top" width="23.26%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cce_02_0238__p1443386124219">description</p>
</td>
<td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cce_02_0238__p1743310614212">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.81%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cce_02_0238__p19433156124218">Cluster description.</p>
</td>
</tr>
<tr id="cce_02_0238__row132744535618"><td class="cellrowborder" valign="top" width="23.26%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cce_02_0238__p1061204712564">customSan</p>
</td>
<td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cce_02_0238__p1161254720565">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="55.81%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cce_02_0238__p14612154715618">Custom SAN field in the server certificate of the cluster API server, which must comply with the SSL and X509 format specifications.</p>
<ol id="cce_02_0238__ol1661234755617"><li id="cce_02_0238__li1061214471563">Duplicate names are not allowed.</li><li id="cce_02_0238__li126121447125614">Must comply with the IP address and domain name formats.</li></ol>
<p id="cce_02_0238__p1161284715613">example: SAN 1: DNS Name=example.com SAN 2: DNS Name=www.example.com SAN 3: DNS Name=example.net SAN 4: IP Address=93.184.216.34</p>
</td>
</tr>
<tr id="cce_02_0238__row17011947507"><td class="cellrowborder" valign="top" width="23.26%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cce_02_0238__p4701194125011">hostNetwork</p>
</td>
<td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cce_02_0238__p167012042507"><a href="#cce_02_0238__table1622013552507">hostNetwork</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="55.81%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cce_02_0238__p123281848104313">Node network parameters, including a VPC and subnet ID. <strong id="cce_02_0238__b13136114517294">hostNetwork</strong> is mandatory because nodes in a cluster communicate with each other by using a VPC.</p>
</td>
</tr>
<tr id="cce_02_0238__row651719205217"><td class="cellrowborder" valign="top" width="23.26%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cce_02_0238__p851151955212">containerNetwork</p>
</td>
<td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cce_02_0238__p7514193520"><a href="#cce_02_0238__table882310145412">containerNetwork</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="55.81%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cce_02_0238__p16930187201117">Container network parameters, including a container network model and container CIDR block.</p>
</td>
</tr>
<tr id="cce_02_0238__row2538142563314"><td class="cellrowborder" valign="top" width="23.26%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cce_02_0238__p128644191585">eniNetwork</p>
</td>
<td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cce_02_0238__p1534774661616"><a href="#cce_02_0238__request_EniNetwork">eniNetwork</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="55.81%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cce_02_0238__p645579113410">Configuration of Cloud Native Network 2.0. Specify this field when creating a CCE Turbo cluster.</p>
</td>
</tr>
<tr id="cce_02_0238__row9493123913567"><td class="cellrowborder" valign="top" width="23.26%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cce_02_0238__p2493239145620">authentication</p>
</td>
<td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cce_02_0238__p6493113918562"><a href="cce_02_0236.html#cce_02_0236__table71529332533">authentication</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="55.81%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cce_02_0238__p14939395566">Configurations of the cluster authentication mode.</p>
</td>
</tr>
<tr id="cce_02_0238__row138261435110"><td class="cellrowborder" valign="top" width="23.26%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cce_02_0238__p6826841514">billingMode</p>
</td>
<td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cce_02_0238__p188261245511">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="55.81%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cce_02_0238__p1834638101617">Billing mode of a node.</p>
<div class="note" id="cce_02_0238__note0702131124412"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="cce_02_0238__p77026184417">This field is not supported for the current version.</p>
</div></div>
</td>
</tr>
<tr id="cce_02_0238__row6819161812313"><td class="cellrowborder" valign="top" width="23.26%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cce_02_0238__p165111129172211">masters</p>
</td>
<td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cce_02_0238__p2051112912213">No</p>
</td>
<td class="cellrowborder" valign="top" width="55.81%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cce_02_0238__p1651220292221"><a href="#cce_02_0238__request_MasterSpec">MasterSpec</a> objects</p>
<p id="cce_02_0238__p15513112910229">Advanced configurations of the master node.</p>
</td>
</tr>
<tr id="cce_02_0238__row0552182615116"><td class="cellrowborder" valign="top" width="23.26%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cce_02_0238__p155392619517">extendParam</p>
</td>
<td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cce_02_0238__p165531261511"><a href="#cce_02_0238__table17575013586">extendParam</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="55.81%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cce_02_0238__p13817123194716">Extended fields in the format of key-value pairs.</p>
</td>
</tr>
<tr id="cce_02_0238__row97803915130"><td class="cellrowborder" valign="top" width="23.26%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cce_02_0238__p156284113136">kubernetesSvcIpRange</p>
</td>
<td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cce_02_0238__p0703163016251">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.81%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cce_02_0238__p7782199181315">Service CIDR block or the IP address range which the <strong id="cce_02_0238__b1853831421311">kubernetes clusterIp</strong> must fall within. This parameter is available only for clusters of v1.11.7 and later.</p>
</td>
</tr>
<tr id="cce_02_0238__row334518801617"><td class="cellrowborder" valign="top" width="23.26%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cce_02_0238__p6345128161614">kubeProxyMode</p>
</td>
<td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cce_02_0238__p734518141613">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.81%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cce_02_0238__p656873817549">Service forwarding mode. Two modes are available:</p>
<ul id="cce_02_0238__ul205681238125417"><li id="cce_02_0238__li12568113813546"><strong id="cce_02_0238__b15681538185418">iptables</strong>: Traditional kube-proxy uses iptables rules to implement service load balancing. In this mode, too many iptables rules will be generated when many services are deployed. In addition, non-incremental updates will cause a latency and even obvious performance issues in the case of heavy service traffic.</li><li id="cce_02_0238__li656863814549"><strong id="cce_02_0238__b156973816540">ipvs</strong>: Optimized kube-proxy mode with higher throughput and faster speed. This mode supports incremental updates and can keep connections uninterrupted during service updates. It is suitable for large-sized clusters.</li></ul>
</td>
</tr>
<tr id="cce_02_0238__row87851323833"><td class="cellrowborder" valign="top" width="23.26%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cce_02_0238__p20912143020">enableMasterVolumeEncryption</p>
</td>
<td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cce_02_0238__p6912134502">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="55.81%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cce_02_0238__p11912184309">The system disks and data disks of the master nodes in the cluster are encrypted. By default, the AES-256 encryption algorithm is used. This function is available in both CCE standard and Turbo clusters of v1.25 and later versions. The configuration cannot be modified after the cluster is created. After this function is enabled, there is some disk I/O performance loss.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="cce_02_0238__table1622013552507"></a><a name="table1622013552507"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0238__table1622013552507" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Data structure of the <strong id="cce_02_0238__b1761155392517">hostNetwork</strong> field</caption><thead align="left"><tr id="cce_02_0238__row922065525010"><th align="left" class="cellrowborder" valign="top" width="22.99%" id="mcps1.3.4.6.2.4.1.1"><p id="cce_02_0238__p687613311518">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.84%" id="mcps1.3.4.6.2.4.1.2"><p id="cce_02_0238__p168912031515">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.169999999999995%" id="mcps1.3.4.6.2.4.1.3"><p id="cce_02_0238__p158914355111">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cce_02_0238__row1622075519505"><td class="cellrowborder" valign="top" width="22.99%" headers="mcps1.3.4.6.2.4.1.1 "><p id="cce_02_0238__p1465319402192">vpc</p>
</td>
<td class="cellrowborder" valign="top" width="21.84%" headers="mcps1.3.4.6.2.4.1.2 "><p id="cce_02_0238__p1452691718229">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.169999999999995%" headers="mcps1.3.4.6.2.4.1.3 "><p id="cce_02_0238__p2018164753013">ID of the VPC used to create a master node. The VPC ID is obtained from <a href="cce_02_0100.html">Creating a VPC and Subnet</a>.</p>
</td>
</tr>
<tr id="cce_02_0238__row322025520508"><td class="cellrowborder" valign="top" width="22.99%" headers="mcps1.3.4.6.2.4.1.1 "><p id="cce_02_0238__p1665317409195">subnet</p>
</td>
<td class="cellrowborder" valign="top" width="21.84%" headers="mcps1.3.4.6.2.4.1.2 "><p id="cce_02_0238__p185261417112213">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.169999999999995%" headers="mcps1.3.4.6.2.4.1.3 "><p id="cce_02_0238__p111816472307">Network ID of the subnet. The value is obtained from <a href="cce_02_0100.html">Creating a VPC and Subnet</a>.</p>
</td>
</tr>
<tr id="cce_02_0238__row152996116531"><td class="cellrowborder" valign="top" width="22.99%" headers="mcps1.3.4.6.2.4.1.1 "><p id="cce_02_0238__p1229917119536">SecurityGroup</p>
</td>
<td class="cellrowborder" valign="top" width="21.84%" headers="mcps1.3.4.6.2.4.1.2 "><p id="cce_02_0238__p1329981117534">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.169999999999995%" headers="mcps1.3.4.6.2.4.1.3 "><p id="cce_02_0238__p1829921111531">ID of the default security group created for the node during cluster creation.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="cce_02_0238__table882310145412"></a><a name="table882310145412"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0238__table882310145412" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Data structure of the <strong id="cce_02_0238__b464715522912">containerNetwork</strong> field</caption><thead align="left"><tr id="cce_02_0238__row1682316016545"><th align="left" class="cellrowborder" valign="top" width="22.99%" id="mcps1.3.4.7.2.4.1.1"><p id="cce_02_0238__p1694819205543">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.69%" id="mcps1.3.4.7.2.4.1.2"><p id="cce_02_0238__p11964620145410">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.32%" id="mcps1.3.4.7.2.4.1.3"><p id="cce_02_0238__p09648200542">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cce_02_0238__row482317016541"><td class="cellrowborder" valign="top" width="22.99%" headers="mcps1.3.4.7.2.4.1.1 "><p id="cce_02_0238__p2082320195415">mode</p>
</td>
<td class="cellrowborder" valign="top" width="20.69%" headers="mcps1.3.4.7.2.4.1.2 "><p id="cce_02_0238__p28237014542">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.32%" headers="mcps1.3.4.7.2.4.1.3 "><p id="cce_02_0238__p2398131181613">Container network model. Select one of the following possible values:</p>
<ul id="cce_02_0238__ul1085141916166"><li id="cce_02_0238__li34128225166"><strong id="cce_02_0238__b1892704916116">overlay_l2</strong>: an overlay_l2 network built for containers by using OpenVSwitch (OVS).</li><li id="cce_02_0238__li485171981612"><strong id="cce_02_0238__b15370163183618">vpc-router</strong>: an underlay_l2 network built for containers by using ipvlan and custom VPC routes.</li><li id="cce_02_0238__li175841223205113"><strong id="cce_02_0238__b0584623145118">eni</strong>: cloud native 2.0 network model. This model deeply integrates the native ENI capability of VPC, uses the VPC CIDR block to allocate container addresses, and supports passthrough between load balancers and containers to provide high performance. You can use this network model when creating a CCE Turbo cluster.</li></ul>
<div class="note" id="cce_02_0238__note1860516155199"><span class="notetitle"> NOTE: </span><div class="notebody"><ul id="cce_02_0238__ul21791736131915"><li id="cce_02_0238__li5179536151917">Tunnel network: Under this model, the container network is an overlay network on top of a VPC network based on the VXLAN technology. VXLAN encapsulates Ethernet packets as UDP packets for tunnel transmission. Though at some cost of performance, the tunnel encapsulation enables higher interoperability and compatibility with advanced features (such as network policy-based isolation), meeting the requirements of most applications.</li><li id="cce_02_0238__li2020854413199">VPC network: Routing is implemented within a VPC network according to custom VPC routes. Each node is assigned a CIDR block of a fixed size. vpc-router networks are free of tunnel encapsulation overheads and provide better container network performance than tunnel networks. In addition, as routes to node IP addresses and the containers have been configured on vpc-router, container instances can be directly accessed from outside the cluster.</li></ul>
</div></div>
</td>
</tr>
<tr id="cce_02_0238__row482313013542"><td class="cellrowborder" valign="top" width="22.99%" headers="mcps1.3.4.7.2.4.1.1 "><p id="cce_02_0238__p1982310145419">cidr</p>
</td>
<td class="cellrowborder" valign="top" width="20.69%" headers="mcps1.3.4.7.2.4.1.2 "><p id="cce_02_0238__p19823401545">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.32%" headers="mcps1.3.4.7.2.4.1.3 "><p id="cce_02_0238__p84035416174">Container CIDR block. Recommended: 10.0.0.0/12-19, 172.16.0.0/16-19, or 192.168.0.0/16-19. If the selected CIDR block conflicts with existing CIDR blocks, the system automatically selects another CIDR block.</p>
<p id="cce_02_0238__p1540195441713">This parameter cannot be modified after the cluster is created. Exercise caution when setting this parameter.(This parameter has been discarded. If <strong id="cce_02_0238__b1093110531174">cidrs</strong> has been configured, skip this parameter.)</p>
<p id="cce_02_0238__p1390788347">Minimum: <strong id="cce_02_0238__b163907813342">0</strong></p>
<p id="cce_02_0238__p93901184349">Maximum: <strong id="cce_02_0238__b4390118123411">64</strong></p>
</td>
</tr>
<tr id="cce_02_0238__row208811756576"><td class="cellrowborder" valign="top" width="22.99%" headers="mcps1.3.4.7.2.4.1.1 "><p id="cce_02_0238__p838891319370">cidrs</p>
</td>
<td class="cellrowborder" valign="top" width="20.69%" headers="mcps1.3.4.7.2.4.1.2 "><p id="cce_02_0238__p20389121343714">Array of <a href="#cce_02_0238__request_ContainerCIDR">ContainerCIDR</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="56.32%" headers="mcps1.3.4.7.2.4.1.3 "><p id="cce_02_0238__p19321153174">List of container CIDR blocks. In clusters of v1.21 and later, the <strong id="cce_02_0238__b19328533718">cidrs</strong> field is used. When the cluster network type is <strong id="cce_02_0238__b89321153070">vpc-router</strong>, you can add multiple container CIDR blocks. In versions earlier than v1.21, if the <strong id="cce_02_0238__b1093212531171">cidrs</strong> field is used, the first CIDR element in the array is used as the container CIDR block.</p>
<p id="cce_02_0238__p793215531276">The configuration cannot be changed after the cluster is created.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="cce_02_0238__request_ContainerCIDR"></a><a name="request_ContainerCIDR"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0238__request_ContainerCIDR" frame="border" border="1" rules="all"><caption><b>Table 7 </b>ContainerCIDR</caption><thead align="left"><tr id="cce_02_0238__row13957412123714"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.8.2.5.1.1"><p id="cce_02_0238__p832930154717">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.8.2.5.1.2"><p id="cce_02_0238__p113215303473">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.8.2.5.1.3"><p id="cce_02_0238__p63203034712">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.8.2.5.1.4"><p id="cce_02_0238__p733203004715">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cce_02_0238__row5957141212376"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.5.1.1 "><p id="cce_02_0238__p183902137370">cidr</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.5.1.2 "><p id="cce_02_0238__p9391121373712">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.5.1.3 "><p id="cce_02_0238__p103911513193716">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.8.2.5.1.4 "><p id="cce_02_0238__p12391313113711">Container CIDR block. Recommended: 10.0.0.0/12-19, 172.16.0.0/16-19, and 192.168.0.0/16-19</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="cce_02_0238__request_EniNetwork"></a><a name="request_EniNetwork"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0238__request_EniNetwork" frame="border" border="1" rules="all"><caption><b>Table 8 </b>EniNetwork</caption><thead align="left"><tr id="cce_02_0238__row18429162325114"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.9.2.5.1.1"><p id="cce_02_0238__p13585182315513">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.9.2.5.1.2"><p id="cce_02_0238__p55851235512">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.9.2.5.1.3"><p id="cce_02_0238__p458572314518">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.9.2.5.1.4"><p id="cce_02_0238__p6585523185115">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cce_02_0238__row1429723185112"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.5.1.1 "><p id="cce_02_0238__p55859232519">eniSubnetId</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.5.1.2 "><p id="cce_02_0238__p3585192319515">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.5.1.3 "><p id="cce_02_0238__p1758592312514">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.9.2.5.1.4 "><p id="cce_02_0238__p658517237511">IPv4 Subnet ID of the ENI container subnet. Currently, IPv6 is not supported.</p>
</td>
</tr>
<tr id="cce_02_0238__row6429192310512"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.5.1.1 "><p id="cce_02_0238__p2058582320518">eniSubnetCIDR</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.5.1.2 "><p id="cce_02_0238__p358582315519">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.5.1.3 "><p id="cce_02_0238__p258572318516">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.9.2.5.1.4 "><p id="cce_02_0238__p058522315117">ENI subnet CIDR block.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="cce_02_0238__request_MasterSpec"></a><a name="request_MasterSpec"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0238__request_MasterSpec" frame="border" border="1" rules="all"><caption><b>Table 9 </b>MasterSpec</caption><thead align="left"><tr id="cce_02_0238__row660352917222"><th align="left" class="cellrowborder" valign="top" width="17.630000000000003%" id="mcps1.3.4.10.2.5.1.1"><p id="cce_02_0238__p16532730142211">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.14%" id="mcps1.3.4.10.2.5.1.2"><p id="cce_02_0238__p2532163013227">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.459999999999999%" id="mcps1.3.4.10.2.5.1.3"><p id="cce_02_0238__p55321330132215">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.769999999999996%" id="mcps1.3.4.10.2.5.1.4"><p id="cce_02_0238__p0532193015226">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cce_02_0238__row7603132916227"><td class="cellrowborder" valign="top" width="17.630000000000003%" headers="mcps1.3.4.10.2.5.1.1 "><p id="cce_02_0238__p135321630142216">availabilityZone</p>
</td>
<td class="cellrowborder" valign="top" width="11.14%" headers="mcps1.3.4.10.2.5.1.2 "><p id="cce_02_0238__p155321230162218">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.459999999999999%" headers="mcps1.3.4.10.2.5.1.3 "><p id="cce_02_0238__p125322030142219">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.769999999999996%" headers="mcps1.3.4.10.2.5.1.4 "><p id="cce_02_0238__p178875298384">Availability Zone.</p>
<p id="cce_02_0238__p48691940163718">For example, eu-de-01.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="cce_02_0238__table17575013586"></a><a name="table17575013586"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0238__table17575013586" frame="border" border="1" rules="all"><caption><b>Table 10 </b>Data structure of the extendParam field</caption><thead align="left"><tr id="cce_02_0238__row51071750155814"><th align="left" class="cellrowborder" valign="top" width="20.71%" id="mcps1.3.4.11.2.4.1.1"><p id="cce_02_0238__p41071050115816">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.62%" id="mcps1.3.4.11.2.4.1.2"><p id="cce_02_0238__p1312155019587">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="58.67%" id="mcps1.3.4.11.2.4.1.3"><p id="cce_02_0238__p13121155016582">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cce_02_0238__row1457961164816"><td class="cellrowborder" valign="top" width="20.71%" headers="mcps1.3.4.11.2.4.1.1 "><p id="cce_02_0238__p1757418610512">alpha.cce/fixPoolMask</p>
</td>
<td class="cellrowborder" valign="top" width="20.62%" headers="mcps1.3.4.11.2.4.1.2 "><p id="cce_02_0238__p17573263512">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.67%" headers="mcps1.3.4.11.2.4.1.3 "><p id="cce_02_0238__p54363518438">Number of mask bits of the fixed IP address pool of the container network model. This field is supported only for the VPC network model (vpc-router).</p>
<p id="cce_02_0238__p843618516437">This parameter determines the number of container IP addresses that can be allocated to a node. The maximum number of pods that can be created on a node is decided by this parameter and maxPods set during node creation.</p>
<p id="cce_02_0238__p443615534316">The value is an integer ranging from 24 to 28.</p>
</td>
</tr>
<tr id="cce_02_0238__row15380172523019"><td class="cellrowborder" valign="top" width="20.71%" headers="mcps1.3.4.11.2.4.1.1 "><p id="cce_02_0238__p1594918321549">kubernetes.io/cpuManagerPolicy</p>
</td>
<td class="cellrowborder" valign="top" width="20.62%" headers="mcps1.3.4.11.2.4.1.2 "><p id="cce_02_0238__p1994343217412">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.67%" headers="mcps1.3.4.11.2.4.1.3 "><p id="cce_02_0238__p1394113321442">CPU management policy of the master node.</p>
</td>
</tr>
<tr id="cce_02_0238__row9784733459"><td class="cellrowborder" valign="top" width="20.71%" headers="mcps1.3.4.11.2.4.1.1 "><p id="cce_02_0238__p1578413331758">upgradefrom</p>
</td>
<td class="cellrowborder" valign="top" width="20.62%" headers="mcps1.3.4.11.2.4.1.2 "><p id="cce_02_0238__p5784533258">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.67%" headers="mcps1.3.4.11.2.4.1.3 "><p id="cce_02_0238__p1875343414011">Version from which this version is upgrade.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="cce_02_0238__table6749834132215"></a><a name="table6749834132215"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0238__table6749834132215" frame="border" border="1" rules="all"><caption><b>Table 11 </b>Data structure of the <strong id="cce_02_0238__b14719165813166">status</strong> field</caption><thead align="left"><tr id="cce_02_0238__row14749534122218"><th align="left" class="cellrowborder" valign="top" width="21%" id="mcps1.3.4.12.2.4.1.1"><p id="cce_02_0238__p37490340223">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="27%" id="mcps1.3.4.12.2.4.1.2"><p id="cce_02_0238__p7749734112218">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52%" id="mcps1.3.4.12.2.4.1.3"><p id="cce_02_0238__p67491034152211">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cce_02_0238__row1749834132213"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.12.2.4.1.1 "><p id="cce_02_0238__p16749153410220">phase</p>
</td>
<td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.4.12.2.4.1.2 "><p id="cce_02_0238__p4749193482216">String</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.12.2.4.1.3 "><p id="cce_02_0238__p19996100113820">Cluster status. Possible values:</p>
<ul id="cce_02_0238__ul954920813385"><li id="cce_02_0238__li100912163818"><strong id="cce_02_0238__b31162290589">Available</strong>: The cluster is running properly.</li><li id="cce_02_0238__li6188523133814"><strong id="cce_02_0238__b271603245815">Unavailable</strong>: The cluster is exhibiting unexpected behavior. Manually delete the cluster or contact the administrator to delete the cluster.</li><li id="cce_02_0238__li649426113819"><strong id="cce_02_0238__b1618913355587">ScalingUp</strong>: Nodes are being added to the cluster.</li><li id="cce_02_0238__li2896132853810"><strong id="cce_02_0238__b182112393582">ScalingDown</strong>: The cluster is being downsized to fewer nodes.</li><li id="cce_02_0238__li15646103143819"><strong id="cce_02_0238__b193081845185818">Creating</strong>: The cluster is being created.</li><li id="cce_02_0238__li6622435133811"><strong id="cce_02_0238__b164334713587">Deleting</strong>: The cluster is being deleted.</li><li id="cce_02_0238__li1617693833820"><strong id="cce_02_0238__b18491748105818">Upgrading</strong>: The cluster is being upgraded.</li><li id="cce_02_0238__li16364134093811"><strong id="cce_02_0238__b18688456155816">Resizing</strong>: Cluster specifications are being changed.</li><li id="cce_02_0238__li185499817383"><strong id="cce_02_0238__b10115131217599">Empty</strong>: The cluster has no resources.</li></ul>
</td>
</tr>
<tr id="cce_02_0238__row6749834122215"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.12.2.4.1.1 "><p id="cce_02_0238__p167491634122217">reason</p>
</td>
<td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.4.12.2.4.1.2 "><p id="cce_02_0238__p1870174132519">String</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.12.2.4.1.3 "><p id="cce_02_0238__p8749534142216">Reason of cluster state transition. This parameter is returned if the cluster is not in the Available state.</p>
</td>
</tr>
<tr id="cce_02_0238__row1574915349227"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.12.2.4.1.1 "><p id="cce_02_0238__p774993432217">message</p>
</td>
<td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.4.12.2.4.1.2 "><p id="cce_02_0238__p1571284172519">String</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.12.2.4.1.3 "><p id="cce_02_0238__p48271730459">Detailed information about why the cluster changes to the current state. This parameter is returned if the cluster is not in the Available state.</p>
</td>
</tr>
<tr id="cce_02_0238__row9189104316515"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.12.2.4.1.1 "><p id="cce_02_0238__p319094395117">endpoints</p>
</td>
<td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.4.12.2.4.1.2 "><p id="cce_02_0238__p619084316514"><a href="#cce_02_0238__t3d666891caf940a39046a0807b3c480a">endpoint</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.12.2.4.1.3 "><p id="cce_02_0238__p13190943135116">Access address of the kube-apiserver in the cluster.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="cce_02_0238__t3d666891caf940a39046a0807b3c480a"></a><a name="t3d666891caf940a39046a0807b3c480a"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0238__t3d666891caf940a39046a0807b3c480a" frame="border" border="1" rules="all"><caption><b>Table 12 </b>Data structure of the endpoint field</caption><thead align="left"><tr id="cce_02_0238__r21652f7a92354ddc97bb1eced149ff3a"><th align="left" class="cellrowborder" valign="top" width="20.792079207920793%" id="mcps1.3.4.13.2.4.1.1"><p id="cce_02_0238__a58d65dc53b9d4f2da3791b1612bedd1f">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="26.732673267326735%" id="mcps1.3.4.13.2.4.1.2"><p id="cce_02_0238__aa02b4a8b12ab4109b4442ae3ffa03ee4">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52.475247524752476%" id="mcps1.3.4.13.2.4.1.3"><p id="cce_02_0238__acc10a55b9e224f2d8fe58f509a24b767">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cce_02_0238__r03ad43ab59d1482795974193959e47a1"><td class="cellrowborder" valign="top" width="20.792079207920793%" headers="mcps1.3.4.13.2.4.1.1 "><p id="cce_02_0238__af592733d401946dab4f8b1fe44a7d061">internal</p>
</td>
<td class="cellrowborder" valign="top" width="26.732673267326735%" headers="mcps1.3.4.13.2.4.1.2 "><p id="cce_02_0238__a98c38a11ab774e22a973311375577841">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.475247524752476%" headers="mcps1.3.4.13.2.4.1.3 "><p id="cce_02_0238__a57119fe622d9407c9d52289cbd9e1195">Internal network address.</p>
</td>
</tr>
<tr id="cce_02_0238__r0c8fedfca25f4644899868c111dcc671"><td class="cellrowborder" valign="top" width="20.792079207920793%" headers="mcps1.3.4.13.2.4.1.1 "><p id="cce_02_0238__ad046c7cf6d88431ba221243410dcdcb0">external</p>
</td>
<td class="cellrowborder" valign="top" width="26.732673267326735%" headers="mcps1.3.4.13.2.4.1.2 "><p id="cce_02_0238__ac40b6385fc6d45ad8fbc3fee9858d294">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.475247524752476%" headers="mcps1.3.4.13.2.4.1.3 "><p id="cce_02_0238__en-us_topic_0102499095_p124413401524">External network address.</p>
</td>
</tr>
<tr id="cce_02_0238__row1892195682011"><td class="cellrowborder" valign="top" width="20.792079207920793%" headers="mcps1.3.4.13.2.4.1.1 "><p id="cce_02_0238__p4741194813586">external_otc</p>
</td>
<td class="cellrowborder" valign="top" width="26.732673267326735%" headers="mcps1.3.4.13.2.4.1.2 "><p id="cce_02_0238__p107411448155811">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.475247524752476%" headers="mcps1.3.4.13.2.4.1.3 "><p id="cce_02_0238__p16741148135815">Endpoint of the cluster to be accessed through API Gateway.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="cce_02_0238__en-us_topic_0079614900_p24465425"><strong id="cce_02_0238__b476951722219">Response example</strong>:</p>
<pre class="screen" id="cce_02_0238__screen244842816103"> "kind": "Cluster",
"apiVersion": "v3",
"metadata": {
"name": "mycluster",
"uid": "365b5e05-846a-11ea-9fe6-0255ac101107",
"creationTimestamp": "2020-04-22 07:23:50.157883 +0000 UTC",
"updateTimestamp": "2020-05-08 03:10:12.174334 +0000 UTC"
},
"spec": {
"type": "VirtualMachine",
"flavor": "cce.s1.small",
"version": "v1.17.9-r0",
"description": "new description",
"az": "eu-de-01",
"ipv6enable": false,
"supportIstio": true,
"hostNetwork": {
"vpc": "23d3725f-6ffe-400e-8fb6-b4f9a7b3e8c1",
"subnet": "c90b3ce5-e1f1-4c87-a006-644d78846438",
"SecurityGroup": "7bf2a95b-f41d-4187-9e72-d0a9a4de8e6d"
},
"containerNetwork": {
"mode": "overlay_l2",
"cidr": "172.16.0.0/16"
},
"eniNetwork": {},
"authentication": {
"mode": "rbac",
"authenticatingProxy": {}
},
"billingMode": 0,
"extendParam": {
"alpha.cce/fixPoolMask": "",
"kubernetes.io/cpuManagerPolicy": "",
"upgradefrom": ""
},
"kubernetesSvcIpRange": "10.247.0.0/16",
"kubeProxyMode": "iptables"
},
"status": {
"phase": "Available",
"endpoints": [
{
"Internal": "https://192.168.0.61:5443",
},
{
"External": "https://10.185.69.54:5443",
},
{
"external_otc": "https://a140174a-2f3e-11e9-9f91-0255ac101405.cce.eu-de.otc.t-systems.com", },
]
}
}</pre>
</div>
<div class="section" id="cce_02_0238__section123061448462"><h4 class="sectiontitle">Status Code</h4><p id="cce_02_0238__en-us_topic_0079614900_p21869221"><a href="#cce_02_0238__en-us_topic_0079614900_table46761928">Table 13</a> describes the status code of this API.</p>
<div class="tablenoborder"><a name="cce_02_0238__en-us_topic_0079614900_table46761928"></a><a name="en-us_topic_0079614900_table46761928"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0238__en-us_topic_0079614900_table46761928" frame="border" border="1" rules="all"><caption><b>Table 13 </b>Status code</caption><thead align="left"><tr id="cce_02_0238__en-us_topic_0079614900_row33254664"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.3.2.3.1.1"><p id="cce_02_0238__p55616028205955">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.3.2.3.1.2"><p id="cce_02_0238__p8604418205955">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cce_02_0238__en-us_topic_0079614900_row41084259"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.3.1.1 "><p id="cce_02_0238__en-us_topic_0079614900_p39490674">200</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.3.1.2 "><p id="cce_02_0238__en-us_topic_0079614900_p44628050">Information about the specified cluster is successfully obtained.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="cce_02_0238__p347213715512">For details about error status codes, see <a href="cce_02_0084.html">Status Code</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="cce_02_0092.html">Cluster Management</a></div>
</div>
</div>
View Git Blame Copy Permalink