forked from docs/doc-exports
Yang, Tong
a3bf1a2fff
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com> Co-authored-by: Yang, Tong <yangtong2@huawei.com> Co-committed-by: Yang, Tong <yangtong2@huawei.com>
134 lines
8.9 KiB
HTML
134 lines
8.9 KiB
HTML
<a name="mrs_02_0201"></a><a name="mrs_02_0201"></a>
|
|
|
|
<h1 class="topictitle1">Changing a Cluster Name</h1>
|
|
<div id="body1599638193445"><div class="section" id="mrs_02_0201__section1043802982919"><h4 class="sectiontitle">Function</h4><p id="mrs_02_0201__p4438202962918">This API is used to change a cluster name.</p>
|
|
</div>
|
|
<div class="section" id="mrs_02_0201__section13439929132917"><h4 class="sectiontitle">URI</h4><p id="mrs_02_0201__p11439102918294">PUT /v2/{project_id}/clusters/{cluster_id}/cluster-name</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_0201__table18440102922917" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="mrs_02_0201__row18440172952913"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="mrs_02_0201__p8441132942911">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="mrs_02_0201__p17441929192919">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="mrs_02_0201__p11441929132916">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="mrs_02_0201__p64411629152913">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="mrs_02_0201__row10440429152911"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="mrs_02_0201__p7442112914290">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="mrs_02_0201__p15442132922914">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="mrs_02_0201__p124425299297">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="mrs_02_0201__p3326248113210">The project ID. For details about how to obtain the project ID, see <a href="mrs_02_0011.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0201__row2440112982914"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="mrs_02_0201__p844213293292">cluster_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="mrs_02_0201__p134431929132912">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="mrs_02_0201__p2443192910294">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="mrs_02_0201__p1632894853219">The cluster ID. For details about how to obtain the cluster ID, see <a href="mrs_02_0011.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="mrs_02_0201__section1443152912298"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_0201__request_UpdateClusterReq" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request body parameter</caption><thead align="left"><tr id="mrs_02_0201__row16444122910293"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="mrs_02_0201__p44448295290">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="mrs_02_0201__p5445102912297">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="mrs_02_0201__p94451229192916">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="mrs_02_0201__p344532922910">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="mrs_02_0201__row1544415290290"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="mrs_02_0201__p744517295293">cluster_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="mrs_02_0201__p44451929162917">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="mrs_02_0201__p17446142914296">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="mrs_02_0201__p844652913292">The new cluster name.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="mrs_02_0201__section8446192915299"><h4 class="sectiontitle">Response Parameters</h4><p id="mrs_02_0201__p6446112932912"><strong id="mrs_02_0201__b944618292296">Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_0201__response_ApiCommonResponse" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameter</caption><thead align="left"><tr id="mrs_02_0201__row944882932919"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.1"><p id="mrs_02_0201__p20449152952914">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.2"><p id="mrs_02_0201__p1144972918295">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.4.1.3"><p id="mrs_02_0201__p19449132918290">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="mrs_02_0201__row15448122942910"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="mrs_02_0201__p19449182916290">result</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="mrs_02_0201__p124491129172917">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="mrs_02_0201__p18450152942918">The operation result of the mapping update request. Value **succeeded** indicates that the operation is successful, and value **failed** indicates that the operation fails.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="mrs_02_0201__p1845012911296"><strong id="mrs_02_0201__b14501529132914">Status code: 400</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_0201__response_ErrorRsp" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="mrs_02_0201__row445122919297"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.1"><p id="mrs_02_0201__p845292915294">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.2"><p id="mrs_02_0201__p12452112917293">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.5.2.4.1.3"><p id="mrs_02_0201__p84521291294">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="mrs_02_0201__row245142912915"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="mrs_02_0201__p6452162912915">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="mrs_02_0201__p14453152992916">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="mrs_02_0201__p1245320291297">The error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0201__row94514290298"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="mrs_02_0201__p194531229192914">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="mrs_02_0201__p64534296292">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="mrs_02_0201__p74541291292">The error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="mrs_02_0201__section545412914293"><h4 class="sectiontitle">Example Request</h4><p id="mrs_02_0201__p88311491158">Change the MRS cluster name to <strong id="mrs_02_0201__b1486110563326">mrs_jdRU_dm01</strong>.</p>
|
|
<pre class="screen" id="mrs_02_0201__screen20454202916296">{
|
|
"cluster_name" : "mrs_jdRU_dm01"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="mrs_02_0201__section6455142917293"><h4 class="sectiontitle">Example Response</h4><p id="mrs_02_0201__p4455529132919"><strong id="mrs_02_0201__b14456192914296">Status code: 200</strong></p>
|
|
<p id="mrs_02_0201__p1245632972920">The cluster name is changed.</p>
|
|
<pre class="screen" id="mrs_02_0201__screen4456122917294">{
|
|
"result" : "succeeded"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="mrs_02_0201__section17497124813215"><h4 class="sectiontitle">Status Codes</h4><p id="mrs_02_0201__p1693116917524">See <a href="mrs_02_0015.html">Status Codes</a>.</p>
|
|
</div>
|
|
<div class="section" id="mrs_02_0201__section349834810328"><h4 class="sectiontitle">Error Codes</h4><p id="mrs_02_0201__p1749812480320">See <a href="mrs_02_0014.html">Error Code</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="mrs_02_0100.html">Cluster management APIs (V2)</a></div>
|
|
</div>
|
|
</div>
|
|
|