forked from docs/doc-exports
qiujiandong1
535e30e292
Reviewed-by: Gergo-Bence Lorincz <a200452876@noreply.gitea.eco.tsi-dev.otc-service.com> Co-authored-by: qiujiandong1 <qiujiandong1@huawei.com> Co-committed-by: qiujiandong1 <qiujiandong1@huawei.com>
141 lines
9.7 KiB
HTML
141 lines
9.7 KiB
HTML
<a name="UpdateClusterGroup"></a><a name="UpdateClusterGroup"></a>
|
|
|
|
<h1 class="topictitle1">Updating Fleet Description</h1>
|
|
<div id="body76216183105"><div class="section" id="UpdateClusterGroup__section186211718131017"><h4 class="sectiontitle">Function</h4><p id="UpdateClusterGroup__p562216183103">This API is used to update the description of a fleet. You must have the permissions to update the fleet.</p>
|
|
</div>
|
|
<div class="section" id="UpdateClusterGroup__section3622518181013"><h4 class="sectiontitle">URI</h4><p id="UpdateClusterGroup__p18625111818107">PUT /v1/clustergroups/{clustergroupid}/description</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateClusterGroup__table18627318171013" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameter</caption><thead align="left"><tr id="UpdateClusterGroup__row6625161810108"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="UpdateClusterGroup__p1362741821016">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="UpdateClusterGroup__p1462971821018">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="UpdateClusterGroup__p13629131851013">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="UpdateClusterGroup__p0630118151019">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="UpdateClusterGroup__row4626131811108"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="UpdateClusterGroup__p13631131819105">clustergroupid</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="UpdateClusterGroup__p76317189107">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="UpdateClusterGroup__p146321518201015">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="UpdateClusterGroup__p186332018111017">Fleet ID</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="UpdateClusterGroup__section06341918201017"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateClusterGroup__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters in the request header</caption><thead align="left"><tr id="UpdateClusterGroup__row11635151812101"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="UpdateClusterGroup__p8637118141014">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="UpdateClusterGroup__p116381918101014">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="UpdateClusterGroup__p96381118121019">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="UpdateClusterGroup__p563911812103">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="UpdateClusterGroup__row19635318201010"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="UpdateClusterGroup__p364101814101">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="UpdateClusterGroup__p5642201815107">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="UpdateClusterGroup__p196431818191014">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="UpdateClusterGroup__p1266617331861">Identity authentication information. 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.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateClusterGroup__row152553013211"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="UpdateClusterGroup__p20110172212422">Content-Type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="UpdateClusterGroup__p411018227429">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="UpdateClusterGroup__p7110152218429">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="UpdateClusterGroup__p12110172216422">Message body type (format). Only <strong id="UpdateClusterGroup__b102765776941723">application/json</strong> is supported.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateClusterGroup__request_UpdateClusterGroupDescriptionRequest" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameter in the request body</caption><thead align="left"><tr id="UpdateClusterGroup__row1664517183107"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="UpdateClusterGroup__p10646151881015">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="UpdateClusterGroup__p1764781815106">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="UpdateClusterGroup__p1664801819104">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="UpdateClusterGroup__p10648101811017">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="UpdateClusterGroup__row126451188105"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="UpdateClusterGroup__p1064921811102">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="UpdateClusterGroup__p7649111811104">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="UpdateClusterGroup__p1565031851011">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="UpdateClusterGroup__p66518189100">Fleet description</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="UpdateClusterGroup__section6651141811103"><h4 class="sectiontitle">Response Parameters</h4><p id="UpdateClusterGroup__p265216188108">None</p>
|
|
</div>
|
|
<div class="section" id="UpdateClusterGroup__section065361871017"><h4 class="sectiontitle">Example Requests</h4><p id="UpdateClusterGroup__p126541818181016">Updating fleet description</p>
|
|
<pre class="screen" id="UpdateClusterGroup__screen106552186109">{
|
|
"description" : "aaaaaaaaa"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="UpdateClusterGroup__section1658018131010"><h4 class="sectiontitle">Example Responses</h4><p id="UpdateClusterGroup__p186593183102">None</p>
|
|
</div>
|
|
<div class="section" id="UpdateClusterGroup__section19659101881013"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateClusterGroup__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="UpdateClusterGroup__row3660151817106"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="UpdateClusterGroup__p1766151841019">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="UpdateClusterGroup__p36621418101015">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="UpdateClusterGroup__row566031810109"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="UpdateClusterGroup__p0663218191013">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="UpdateClusterGroup__p11664101817103">Updated.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateClusterGroup__row12660131811014"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="UpdateClusterGroup__p1866461819107">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="UpdateClusterGroup__p1766561851014">Client request error. The server could not execute the request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateClusterGroup__row86611118131015"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="UpdateClusterGroup__p20666101812109">403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="UpdateClusterGroup__p76661018181012">The server refused the request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateClusterGroup__row16661618161016"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="UpdateClusterGroup__p266710188107">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="UpdateClusterGroup__p106686186103">Resources not found.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateClusterGroup__row3661191818107"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="UpdateClusterGroup__p666915187101">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="UpdateClusterGroup__p15669151881020">Internal server error.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="UpdateClusterGroup__section667011182106"><h4 class="sectiontitle">Error Codes</h4><p id="UpdateClusterGroup__p96716187105">See <a href="ErrorCode.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000001.html">Fleets</a></div>
|
|
</div>
|
|
</div>
|
|
|