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>
138 lines
8.8 KiB
HTML
138 lines
8.8 KiB
HTML
<a name="JoinGroup"></a><a name="JoinGroup"></a>
|
|
|
|
<h1 class="topictitle1">Adding a Cluster to a Fleet</h1>
|
|
<div id="body17576511984"><div class="section" id="JoinGroup__section47571251585"><h4 class="sectiontitle">Function</h4><p id="JoinGroup__p47581951985">This API is used to add a cluster to a fleet.</p>
|
|
</div>
|
|
<div class="section" id="JoinGroup__section137584517813"><h4 class="sectiontitle">URI</h4><p id="JoinGroup__p8759351283">POST /v1/clusters/{clusterid}/join</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="JoinGroup__table97616511387" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameter</caption><thead align="left"><tr id="JoinGroup__row127601511285"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="JoinGroup__p176175110815">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="JoinGroup__p1876219511487">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="JoinGroup__p1576316511814">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="JoinGroup__p12763135116813">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="JoinGroup__row8760551983"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="JoinGroup__p177641751281">clusterid</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="JoinGroup__p107651551281">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="JoinGroup__p18766551087">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="JoinGroup__p187661511286">Cluster ID</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="JoinGroup__section147672511689"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="JoinGroup__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters in the request header</caption><thead align="left"><tr id="JoinGroup__row1876817511289"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="JoinGroup__p1876912516811">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="JoinGroup__p6770451682">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="JoinGroup__p147711511281">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="JoinGroup__p1772105110811">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="JoinGroup__row8768155110810"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="JoinGroup__p17731351189">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="JoinGroup__p47731651884">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="JoinGroup__p1677475113820">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="JoinGroup__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="JoinGroup__row1519294392015"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="JoinGroup__p20110172212422">Content-Type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="JoinGroup__p411018227429">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="JoinGroup__p7110152218429">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="JoinGroup__p12110172216422">Message body type (format). Only <strong id="JoinGroup__b16252845341719">application/json</strong> is supported.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="JoinGroup__request_ClusterJoinGroupRequestBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameter in the request body</caption><thead align="left"><tr id="JoinGroup__row577514513818"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="JoinGroup__p107761512817">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="JoinGroup__p47772511887">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="JoinGroup__p1977813511288">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="JoinGroup__p1177910511380">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="JoinGroup__row1277515511085"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="JoinGroup__p1177919511183">clusterGroupID</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="JoinGroup__p1878085111817">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="JoinGroup__p97811751887">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="JoinGroup__p6781165114815">ID of the fleet that the cluster will be added to</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="JoinGroup__section878245114814"><h4 class="sectiontitle">Response Parameters</h4><p id="JoinGroup__p197839512810">None</p>
|
|
</div>
|
|
<div class="section" id="JoinGroup__section9784551984"><h4 class="sectiontitle">Example Requests</h4><p id="JoinGroup__p15784175115817">Adding a cluster to a fleet</p>
|
|
<pre class="screen" id="JoinGroup__screen107857516813">{
|
|
"clustergroupID" : "49077339-f1cd-11ec-a2be-0255ac1001c2"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="JoinGroup__section147879511985"><h4 class="sectiontitle">Example Responses</h4><p id="JoinGroup__p137131251191114"><strong id="JoinGroup__b131091209542020">Status code: 200</strong></p>
|
|
<p id="JoinGroup__p177149518112">The cluster has been added to the fleet.</p>
|
|
<pre class="screen" id="JoinGroup__screen271485111111">{ }</pre>
|
|
</div>
|
|
<div class="section" id="JoinGroup__section6789751481"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="JoinGroup__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="JoinGroup__row978995117818"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="JoinGroup__p167901151689">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="JoinGroup__p147913516810">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="JoinGroup__row15789151983"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="JoinGroup__p167926512814">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="JoinGroup__p177922511389">The cluster has been added to the fleet.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="JoinGroup__row107891251883"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="JoinGroup__p87930519814">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="JoinGroup__p9794751989">Client request error. The server could not execute the request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="JoinGroup__row2789115112814"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="JoinGroup__p167951451783">403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="JoinGroup__p1279517512815">The server refused the request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="JoinGroup__row19790651181"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="JoinGroup__p479618515817">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="JoinGroup__p779710511587">Internal server error.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="JoinGroup__section137980514818"><h4 class="sectiontitle">Error Codes</h4><p id="JoinGroup__p177991551383">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>
|
|
|