forked from docs/doc-exports
Dong, Qiu Jian
3bfd56205d
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>
338 lines
23 KiB
HTML
338 lines
23 KiB
HTML
<a name="cce_02_0240"></a><a name="cce_02_0240"></a>
|
|
|
|
<h1 class="topictitle1">Updating a Specified Cluster</h1>
|
|
<div id="body1521448221833"><div class="section" id="cce_02_0240__section1686113493165"><h4 class="sectiontitle">Function</h4><p id="cce_02_0240__p209621357141610">This API is used to update information about a specified cluster.</p>
|
|
</div>
|
|
<div class="section" id="cce_02_0240__section8403243161416"><h4 class="sectiontitle">URI</h4><p id="cce_02_0240__p23575517439">PUT /api/v3/projects/{project_id}/clusters/{cluster_id}</p>
|
|
<p id="cce_02_0240__p2037362514220"><a href="#cce_02_0240__table2027961241820">Table 1</a> describes the parameters of this API.</p>
|
|
|
|
<div class="tablenoborder"><a name="cce_02_0240__table2027961241820"></a><a name="table2027961241820"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0240__table2027961241820" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="cce_02_0240__row122809120186"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.4.1.1"><p id="cce_02_0240__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_0240__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_0240__p19143115818187">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cce_02_0240__row32801312121810"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.4.1.1 "><p id="cce_02_0240__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_0240__p814518580186">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="68%" headers="mcps1.3.2.4.2.4.1.3 "><p id="cce_02_0240__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_0240__row126417469411"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.4.1.1 "><p id="cce_02_0240__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_0240__p146484634113">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="68%" headers="mcps1.3.2.4.2.4.1.3 "><p id="cce_02_0240__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_0240__section947084713911"><h4 class="sectiontitle">Request</h4><p id="cce_02_0240__en-us_topic_0079614900_p54374860"><strong id="cce_02_0240__b65693974">Request parameters</strong>:</p>
|
|
<p id="cce_02_0240__p132051734919"><a href="#cce_02_0240__table172831182919">Table 2</a> and <a href="#cce_02_0240__table34052983203655">Table 3</a> describe the request parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="cce_02_0240__table172831182919"></a><a name="table172831182919"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0240__table172831182919" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters in the <strong id="cce_02_0240__b371651911205">request</strong> header</caption><thead align="left"><tr id="cce_02_0240__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_0240__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_0240__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_0240__en-us_topic_0199164459_p16500154162611">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cce_02_0240__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_0240__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_0240__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_0240__en-us_topic_0199164459_p169801011203416">Message body type (format). Possible values:</p>
|
|
<ul id="cce_02_0240__en-us_topic_0199164459_ul7385444163617"><li id="cce_02_0240__en-us_topic_0199164459_li18385114483612">application/json;charset=utf-8</li><li id="cce_02_0240__en-us_topic_0199164459_li3516132853714">application/json</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="cce_02_0240__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_0240__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_0240__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_0240__en-us_topic_0199164459_p18824197845">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>
|
|
|
|
<div class="tablenoborder"><a name="cce_02_0240__table34052983203655"></a><a name="table34052983203655"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0240__table34052983203655" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameters in the request body</caption><thead align="left"><tr id="cce_02_0240__row30254333203655"><th align="left" class="cellrowborder" valign="top" width="20.202020202020204%" id="mcps1.3.3.5.2.5.1.1"><p id="cce_02_0240__p34681881203655">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.131313131313133%" id="mcps1.3.3.5.2.5.1.2"><p id="cce_02_0240__p333122111014">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.181818181818183%" id="mcps1.3.3.5.2.5.1.3"><p id="cce_02_0240__p57769002203655">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="48.484848484848484%" id="mcps1.3.3.5.2.5.1.4"><p id="cce_02_0240__p58673482203655">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cce_02_0240__row9619511127"><td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.3.5.2.5.1.1 "><p id="cce_02_0240__p4785161212">spec</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.3.5.2.5.1.2 "><p id="cce_02_0240__p97205171219">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.181818181818183%" headers="mcps1.3.3.5.2.5.1.3 "><p id="cce_02_0240__p32441816164615"><a href="#cce_02_0240__table1034041612134">spec</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.484848484848484%" headers="mcps1.3.3.5.2.5.1.4 "><p id="cce_02_0240__p10785112129">Detailed description of the cluster targeted by this API. CCE creates or updates objects by defining or updating its spec.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="cce_02_0240__table1034041612134"></a><a name="table1034041612134"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0240__table1034041612134" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Data structure of the <strong id="cce_02_0240__b55431125371">spec</strong> field</caption><thead align="left"><tr id="cce_02_0240__row14348121616132"><th align="left" class="cellrowborder" valign="top" width="20.202020202020204%" id="mcps1.3.3.6.2.5.1.1"><p id="cce_02_0240__p133505167139">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.131313131313133%" id="mcps1.3.3.6.2.5.1.2"><p id="cce_02_0240__p6353201611319">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.181818181818183%" id="mcps1.3.3.6.2.5.1.3"><p id="cce_02_0240__p735501615139">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="48.484848484848484%" id="mcps1.3.3.6.2.5.1.4"><p id="cce_02_0240__p15357151631311">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cce_02_0240__row438141651319"><td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.3.6.2.5.1.1 "><p id="cce_02_0240__p1653144010196">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.3.6.2.5.1.2 "><p id="cce_02_0240__p9485133718193">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.181818181818183%" headers="mcps1.3.3.6.2.5.1.3 "><p id="cce_02_0240__p65261417142217">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.484848484848484%" headers="mcps1.3.3.6.2.5.1.4 "><p id="cce_02_0240__p1318113472302">Cluster description.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cce_02_0240__row184426275574"><td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.3.6.2.5.1.1 "><p id="cce_02_0240__p74897355579">customSan</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.3.6.2.5.1.2 "><p id="cce_02_0240__p5489103513571">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.181818181818183%" headers="mcps1.3.3.6.2.5.1.3 "><p id="cce_02_0240__p448943516571">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.484848484848484%" headers="mcps1.3.3.6.2.5.1.4 "><p id="cce_02_0240__p1748983514571">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_0240__ol4489835155717"><li id="cce_02_0240__li34891335175716">Duplicate names are not allowed.</li><li id="cce_02_0240__li10489193520577">Must comply with the IP address and domain name formats.</li></ol>
|
|
<p id="cce_02_0240__p194891335165718">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_0240__row114231839115711"><td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.3.6.2.5.1.1 "><p id="cce_02_0240__p0504188123417">containerNetwork</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.3.6.2.5.1.2 "><p id="cce_02_0240__p650415817349">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.181818181818183%" headers="mcps1.3.3.6.2.5.1.3 "><p id="cce_02_0240__p7504387341"><a href="#cce_02_0240__request_ContainerNetworkUpdate">ContainerNetworkUpdate</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.484848484848484%" headers="mcps1.3.3.6.2.5.1.4 "><p id="cce_02_0240__p175049818346">Container networking parameters, including information about the container CIDR block.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="cce_02_0240__request_ContainerNetworkUpdate"></a><a name="request_ContainerNetworkUpdate"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0240__request_ContainerNetworkUpdate" frame="border" border="1" rules="all"><caption><b>Table 5 </b>ContainerNetworkUpdate</caption><thead align="left"><tr id="cce_02_0240__row650488113415"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.7.2.5.1.1"><p id="cce_02_0240__p18504585343">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.7.2.5.1.2"><p id="cce_02_0240__p125049873414">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.7.2.5.1.3"><p id="cce_02_0240__p1850512812342">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.7.2.5.1.4"><p id="cce_02_0240__p85051388344">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cce_02_0240__row850413823414"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.5.1.1 "><p id="cce_02_0240__p115051587346">cidrs</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.5.1.2 "><p id="cce_02_0240__p165053818345">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.5.1.3 "><p id="cce_02_0240__p195051381343">Array of <a href="#cce_02_0240__request_ContainerCIDR">ContainerCIDR</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.7.2.5.1.4 "><p id="cce_02_0240__p1750514813340">List of container CIDR blocks. For clusters of v1.21 and later, if the cluster uses the VPC network model, container CIDR blocks can be added incrementally.</p>
|
|
<p id="cce_02_0240__p1350510883419">The configuration cannot be changed after the cluster is updated.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="cce_02_0240__request_ContainerCIDR"></a><a name="request_ContainerCIDR"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0240__request_ContainerCIDR" frame="border" border="1" rules="all"><caption><b>Table 6 </b>ContainerCIDR</caption><thead align="left"><tr id="cce_02_0240__row1750517813411"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.8.2.5.1.1"><p id="cce_02_0240__p1750619833412">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.8.2.5.1.2"><p id="cce_02_0240__p7506985341">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.8.2.5.1.3"><p id="cce_02_0240__p450620843417">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.8.2.5.1.4"><p id="cce_02_0240__p9506178123417">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cce_02_0240__row125051385340"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.8.2.5.1.1 "><p id="cce_02_0240__p17506686344">cidr</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.8.2.5.1.2 "><p id="cce_02_0240__p18506138123413">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.8.2.5.1.3 "><p id="cce_02_0240__p2506685344">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.8.2.5.1.4 "><p id="cce_02_0240__p10506087349">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>
|
|
<p id="cce_02_0240__p1949713104354"><strong id="cce_02_0240__b562002">Example request</strong>:</p>
|
|
<ul id="cce_02_0240__ul882158123410"><li id="cce_02_0240__li128211783349">Updating the description of a cluster<pre class="screen" id="cce_02_0240__screen128211688349">{
|
|
"spec" : {
|
|
"description" : "new description"
|
|
}
|
|
}</pre>
|
|
</li><li id="cce_02_0240__li182117812342">Updating only the custom SAN of the cluster certificate<pre class="screen" id="cce_02_0240__screen282118819341">{
|
|
"spec" : {
|
|
"customSan" : [ "192.168.1.0", "example.com" ]
|
|
}
|
|
}</pre>
|
|
</li><li id="cce_02_0240__li6821188103414">Updating both the cluster description and custom certificate SAN<pre class="screen" id="cce_02_0240__screen1782115833413">{
|
|
"spec" : {
|
|
"description" : "new description",
|
|
"customSan" : [ "192.168.1.0", "example.com" ]
|
|
}
|
|
}</pre>
|
|
</li><li id="cce_02_0240__li1782110833411">Adding a container CIDR block for a cluster of v1.21 or later that uses the VPC network model<pre class="screen" id="cce_02_0240__screen1082114853414">{
|
|
"spec" : {
|
|
"containerNetwork" : {
|
|
"cidrs" : [ {
|
|
"cidr" : "10.10.0.0/16"
|
|
}, {
|
|
"cidr" : "10.11.0.0/16"
|
|
} ]
|
|
}
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="cce_02_0240__section61819725020"><h4 class="sectiontitle">Response</h4><p id="cce_02_0240__en-us_topic_0079614900_p2018733"><strong id="cce_02_0240__en-us_topic_0079614900_b18168603">Response parameters:</strong></p>
|
|
<p id="cce_02_0240__p16966318249">For details about the response parameters, see <a href="#cce_02_0240__table111553952019">Table 7</a>.</p>
|
|
|
|
<div class="tablenoborder"><a name="cce_02_0240__table111553952019"></a><a name="table111553952019"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0240__table111553952019" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Parameters in the response body</caption><thead align="left"><tr id="cce_02_0240__row215439202012"><th align="left" class="cellrowborder" valign="top" width="23.26%" id="mcps1.3.4.4.2.4.1.1"><p id="cce_02_0240__p1216133992018">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.93%" id="mcps1.3.4.4.2.4.1.2"><p id="cce_02_0240__p1316153982018">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="55.81%" id="mcps1.3.4.4.2.4.1.3"><p id="cce_02_0240__p111663913204">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cce_02_0240__row54931625203655"><td class="cellrowborder" valign="top" width="23.26%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cce_02_0240__p16164395205">kind</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cce_02_0240__p11673972012">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.81%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cce_02_0240__p016239162015">API type. For a cluster management API, the parameter must be set to <strong id="cce_02_0240__b8304143918315">Cluster</strong> and cannot be changed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cce_02_0240__row15234185203655"><td class="cellrowborder" valign="top" width="23.26%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cce_02_0240__p4168391206">apiVersion</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cce_02_0240__p101616395202">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.81%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cce_02_0240__p1416173919201">API version. The value is fixed at <strong id="cce_02_0240__b95215361854">v3</strong> and cannot be changed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cce_02_0240__row1122635417553"><td class="cellrowborder" valign="top" width="23.26%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cce_02_0240__p144741558135518">metadata</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cce_02_0240__p16227554165511"><a href="cce_02_0236.html#cce_02_0236__table669019286188">metadata</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.81%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cce_02_0240__p102271654195515">Basic information about a cluster. metadata is a collection of attributes.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cce_02_0240__row3161391200"><td class="cellrowborder" valign="top" width="23.26%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cce_02_0240__p1016239102012">spec</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cce_02_0240__p67105119126"><a href="cce_02_0236.html#cce_02_0236__table195921039143517">spec</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.81%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cce_02_0240__p16166398201">Detailed description of the cluster to be created. CCE creates or updates objects by defining or updating its spec.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cce_02_0240__row98251185230"><td class="cellrowborder" valign="top" width="23.26%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cce_02_0240__p118251118192315">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cce_02_0240__p148261618142315"><a href="cce_02_0236.html#cce_02_0236__table6749834132215">status</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.81%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cce_02_0240__p188261618172317">Cluster status and jobID of the job that reads a specified cluster.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="cce_02_0240__p1055311619571"><strong id="cce_02_0240__b32815482115">Example response:</strong></p>
|
|
</div>
|
|
<pre class="screen" id="cce_02_0240__screen44087268277">{
|
|
"kind": "Cluster",
|
|
"apiVersion": "v3",
|
|
"metadata": {
|
|
"name": "mycluster",
|
|
"uid": "4d1ecb2c-229a-11e8-9c75-0255ac100ceb",
|
|
"creationTimestamp": "2020-02-02 03:48:58.968214406 +0000 UTC",
|
|
"updateTimestamp": "2020-02-02 06:39:36.844676088 +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": "4d1ecb2c-229a-11e8-9c75-0255ac100ceb",
|
|
"subnet": "4d1ecb2c-229a-11e8-9c75-0255ac100ceb",
|
|
"SecurityGroup": "5da0b181-e0a2-4981-87ac-1681545cd666"
|
|
},
|
|
"containerNetwork": {
|
|
"mode": "overlay_l2",
|
|
"cidr": "172.17.0.0/16"
|
|
},
|
|
"eniNetwork": {},
|
|
"authentication": {
|
|
"mode": "rbac",
|
|
"authenticatingProxy": {}
|
|
},
|
|
"billingMode": 0,
|
|
"extendParam": {
|
|
"alpha.cce/fixPoolMask": "",
|
|
"kubernetes.io/cpuManagerPolicy": "",
|
|
"patchVersion": "",
|
|
"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 class="section" id="cce_02_0240__s50f1049a6a4d404c895cf636eb8f3bf1"><h4 class="sectiontitle">Status Code</h4><p id="cce_02_0240__en-us_topic_0079614900_p21869221"><a href="#cce_02_0240__en-us_topic_0079614900_table46761928">Table 8</a> describes the status code of this API.</p>
|
|
|
|
<div class="tablenoborder"><a name="cce_02_0240__en-us_topic_0079614900_table46761928"></a><a name="en-us_topic_0079614900_table46761928"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0240__en-us_topic_0079614900_table46761928" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Status code</caption><thead align="left"><tr id="cce_02_0240__en-us_topic_0079614900_row33254664"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.6.3.2.3.1.1"><p id="cce_02_0240__p55616028205955">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.6.3.2.3.1.2"><p id="cce_02_0240__p8604418205955">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cce_02_0240__en-us_topic_0079614900_row41084259"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.6.3.2.3.1.1 "><p id="cce_02_0240__en-us_topic_0079614900_p39490674">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.6.3.2.3.1.2 "><p id="cce_02_0240__en-us_topic_0079614900_p44628050">Information about the specified cluster is successfully updated.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="cce_02_0240__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>
|
|
|