forked from docs/doc-exports
zhengxiu
8f6b8d3664
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com> Co-authored-by: zhengxiu <zhengxiu@huawei.com> Co-committed-by: zhengxiu <zhengxiu@huawei.com>
159 lines
12 KiB
HTML
159 lines
12 KiB
HTML
<a name="UpdateClusterName"></a><a name="UpdateClusterName"></a>
|
|
|
|
<h1 class="topictitle1">Renaming a Cluster</h1>
|
|
<div id="body1708331107508"><div class="section" id="UpdateClusterName__section8556143166"><h4 class="sectiontitle">Function</h4><p id="UpdateClusterName__p115567413160">This API is used to change cluster names.</p>
|
|
</div>
|
|
<div class="section" id="UpdateClusterName__section155571145167"><h4 class="sectiontitle">Calling Method</h4><p id="UpdateClusterName__p1655774161610">For details, see <a href="css_03_0077.html">Calling APIs</a>.</p>
|
|
</div>
|
|
<div class="section" id="UpdateClusterName__section2055813412163"><h4 class="sectiontitle">URI</h4><p id="UpdateClusterName__p2055816417163">POST /v1.0/{project_id}/clusters/{cluster_id}/changename</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateClusterName__table455919421618" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="UpdateClusterName__row20558144201618"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="UpdateClusterName__p85591648166">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="UpdateClusterName__p6559194171610">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="UpdateClusterName__p55591943162">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="UpdateClusterName__p955915441610">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="UpdateClusterName__row115581146164"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="UpdateClusterName__p655911414166">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="UpdateClusterName__p1056016421616">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="UpdateClusterName__p75601249162">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="UpdateClusterName__p1656034151615"><strong id="UpdateClusterName__b856015471616">Definition</strong>:</p>
|
|
<p id="UpdateClusterName__p156014111617">Project ID. For details about how to obtain the project ID and name, see <a href="css_03_0071.html">Obtaining the Project ID and Name</a>.</p>
|
|
<p id="UpdateClusterName__p756013431611"><strong id="UpdateClusterName__b856074201611">Constraints</strong>:</p>
|
|
<p id="UpdateClusterName__p25611746164">N/A</p>
|
|
<p id="UpdateClusterName__p45611415160"><strong id="UpdateClusterName__b356119431617">Value range</strong>:</p>
|
|
<p id="UpdateClusterName__p12561144164">Project ID of the account.</p>
|
|
<p id="UpdateClusterName__p175617412162"><strong id="UpdateClusterName__b75615461616">Default value</strong>:</p>
|
|
<p id="UpdateClusterName__p10561184111619">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateClusterName__row7558114101617"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="UpdateClusterName__p145614421611">cluster_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="UpdateClusterName__p7561104161618">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="UpdateClusterName__p12562174171611">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="UpdateClusterName__p556224101620"><strong id="UpdateClusterName__b195623471611">Definition</strong>:</p>
|
|
<p id="UpdateClusterName__p115622045163">ID of the cluster that you want to rename For details about how to obtain the cluster ID, see <a href="css_03_0101.html">Obtaining the Cluster ID</a>.</p>
|
|
<p id="UpdateClusterName__p1856219461619"><strong id="UpdateClusterName__b156217411612">Constraints</strong>:</p>
|
|
<p id="UpdateClusterName__p135629418165">N/A</p>
|
|
<p id="UpdateClusterName__p135631846164"><strong id="UpdateClusterName__b1956354151619">Value range</strong>:</p>
|
|
<p id="UpdateClusterName__p256354171616">Cluster ID.</p>
|
|
<p id="UpdateClusterName__p9563124101611"><strong id="UpdateClusterName__b256384101619">Default value</strong>:</p>
|
|
<p id="UpdateClusterName__p55633451613">N/A</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="UpdateClusterName__section4563143163"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateClusterName__request_UpdateClusterNameReq" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request body parameters</caption><thead align="left"><tr id="UpdateClusterName__row15637451616"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="UpdateClusterName__p05641349163">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="UpdateClusterName__p7564124191618">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="UpdateClusterName__p1356414101618">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="UpdateClusterName__p19565114191616">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="UpdateClusterName__row556344131617"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="UpdateClusterName__p155654412165">display_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="UpdateClusterName__p1056519419166">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="UpdateClusterName__p85655412168">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="UpdateClusterName__p155651549161"><strong id="UpdateClusterName__b2056510431612">Definition</strong>:</p>
|
|
<p id="UpdateClusterName__p155661943162">New name of a cluster</p>
|
|
<p id="UpdateClusterName__p85668413166"><strong id="UpdateClusterName__b25663419168">Constraints</strong>:</p>
|
|
<p id="UpdateClusterName__p195663411615">display_name and desc cannot be null at the same time.</p>
|
|
<p id="UpdateClusterName__p1856624171614"><strong id="UpdateClusterName__b165662041169">Value range</strong>:</p>
|
|
<p id="UpdateClusterName__p35662410164">The cluster name must start with a letter and can contain 4 to 32 characters. Only letters, digits, periods (.), hyphens (-), and underscores (_) are allowed.</p>
|
|
<p id="UpdateClusterName__p125661542161"><strong id="UpdateClusterName__b65666414168">Default value</strong>:</p>
|
|
<p id="UpdateClusterName__p115661345168">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateClusterName__row1256316421613"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="UpdateClusterName__p1956744201616">desc</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="UpdateClusterName__p65671342163">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="UpdateClusterName__p156784101617">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="UpdateClusterName__p956774191619"><strong id="UpdateClusterName__b1156716421611">Definition</strong>:</p>
|
|
<p id="UpdateClusterName__p8568845163">Cluster description.</p>
|
|
<p id="UpdateClusterName__p17568448166"><strong id="UpdateClusterName__b1756810415165">Constraints</strong>:</p>
|
|
<p id="UpdateClusterName__p13568154141615">The value can contain up to 128 characters. display_name and desc cannot be null at the same time.</p>
|
|
<p id="UpdateClusterName__p1956814420166"><strong id="UpdateClusterName__b1856874111610">Value range</strong>:</p>
|
|
<p id="UpdateClusterName__p656817417165">N/A</p>
|
|
<p id="UpdateClusterName__p145681545163"><strong id="UpdateClusterName__b15681745167">Default value</strong>:</p>
|
|
<p id="UpdateClusterName__p0568104151611">N/A</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="UpdateClusterName__section105687413169"><h4 class="sectiontitle">Response Parameters</h4><p id="UpdateClusterName__p125691442165"><strong id="UpdateClusterName__b95698415164">Status code: 200</strong></p>
|
|
<p id="UpdateClusterName__p656918431612">Request succeeded.</p>
|
|
<p id="UpdateClusterName__p1569343169">None</p>
|
|
</div>
|
|
<div class="section" id="UpdateClusterName__section95691146164"><h4 class="sectiontitle">Example Requests</h4><p id="UpdateClusterName__p55690481616">Change the display name of the current cluster.</p>
|
|
<pre class="screen" id="UpdateClusterName__screen1857004111611">POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/changename
|
|
|
|
{
|
|
"display_name" : "ES-Test-new",
|
|
"desc" : "test1"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="UpdateClusterName__section1057024201617"><h4 class="sectiontitle">Example Responses</h4><p id="UpdateClusterName__p657054101618">None</p>
|
|
</div>
|
|
<div class="section" id="UpdateClusterName__section1770213471612"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateClusterName__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="UpdateClusterName__row1659014418165"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="UpdateClusterName__p47021419169">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.8.2.1.3.1.2"><p id="UpdateClusterName__p1770219417168">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="UpdateClusterName__row1459018491615"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="UpdateClusterName__p1170315471612">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="UpdateClusterName__p2703645163">Request succeeded.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateClusterName__row559017412169"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="UpdateClusterName__p17703847168">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="UpdateClusterName__p1570364201618">Invalid request.</p>
|
|
<p id="UpdateClusterName__p18703184101613">Modify the request before retry.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateClusterName__row18590744165"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="UpdateClusterName__p137037418162">409</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="UpdateClusterName__p37031246166">The request could not be completed due to a conflict with the current state of the resource.</p>
|
|
<p id="UpdateClusterName__p177033416167">The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateClusterName__row15590164171614"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="UpdateClusterName__p137039451617">412</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="UpdateClusterName__p570364121615">The server did not meet one of the preconditions contained in the request.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="UpdateClusterName__section17703114111619"><h4 class="sectiontitle">Error Codes</h4><p id="UpdateClusterName__p1370315410161">See <a href="css_03_0076.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="cluster_management.html">Cluster Management</a></div>
|
|
</div>
|
|
</div>
|
|
|