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>
196 lines
13 KiB
HTML
196 lines
13 KiB
HTML
<a name="EnableFederation"></a><a name="EnableFederation"></a>
|
|
|
|
<h1 class="topictitle1">Enabling Cluster Federation</h1>
|
|
<div id="body181212189103"><div class="section" id="EnableFederation__section91391871017"><h4 class="sectiontitle">Function</h4><p id="EnableFederation__p1214151819108">This API is used to enable cluster federation.</p>
|
|
</div>
|
|
<div class="section" id="EnableFederation__section6141518141011"><h4 class="sectiontitle">URI</h4><p id="EnableFederation__p1516161815102">POST /v1/clustergroups/{clustergroupid}/federations</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EnableFederation__table1918141813101" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameter</caption><thead align="left"><tr id="EnableFederation__row111761831011"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="EnableFederation__p171961812100">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="EnableFederation__p31931819109">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="EnableFederation__p82001871011">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="EnableFederation__p72121815109">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EnableFederation__row9171818181010"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="EnableFederation__p1722718111011">clustergroupid</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="EnableFederation__p1723191816109">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="EnableFederation__p624151817104">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="EnableFederation__p12517183104">Fleet ID</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EnableFederation__table227141816109" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query parameter</caption><thead align="left"><tr id="EnableFederation__row1426121841010"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="EnableFederation__p22871831015">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="EnableFederation__p1029141891010">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="EnableFederation__p030818181016">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="EnableFederation__p19301218141011">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EnableFederation__row172671812101"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="EnableFederation__p113281881011">retryjoinall</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="EnableFederation__p103210184105">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="EnableFederation__p834318131016">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="EnableFederation__p13518182109">Whether to retry adding the cluster to the federation.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EnableFederation__section93510188106"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EnableFederation__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameters in the request header</caption><thead align="left"><tr id="EnableFederation__row63611811104"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="EnableFederation__p154411891017">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="EnableFederation__p10452018151013">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="EnableFederation__p134571812103">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="EnableFederation__p54651811010">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EnableFederation__row163661871012"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="EnableFederation__p1747121851011">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="EnableFederation__p1948101815109">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="EnableFederation__p19489185100">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="EnableFederation__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="EnableFederation__row89691147122110"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="EnableFederation__p20110172212422">Content-Type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="EnableFederation__p411018227429">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="EnableFederation__p7110152218429">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="EnableFederation__p12110172216422">Message body type (format). Only <strong id="EnableFederation__b137279352641723">application/json</strong> is supported.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EnableFederation__section250918131011"><h4 class="sectiontitle">Response Parameters</h4><p id="EnableFederation__p173381517486"><strong id="EnableFederation__b1833015164812">Status code: 201</strong></p>
|
|
<p id="EnableFederation__p233111510489">container fleet has in enable federation progress.</p>
|
|
<p id="EnableFederation__p13331815184814"><strong id="EnableFederation__b933101516484">Status code: 400</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EnableFederation__response_-" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="EnableFederation__row18331315104814"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.1"><p id="EnableFederation__p1233171518484">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.2"><p id="EnableFederation__p1333615134817">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.5.2.4.1.3"><p id="EnableFederation__p163312156486">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EnableFederation__row733111520480"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="EnableFederation__p1331155486">-</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="EnableFederation__p333141517486">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="EnableFederation__p1833515194811">-</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="EnableFederation__p5335157482"><strong id="EnableFederation__b533101512486">Status code: 404</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EnableFederation__table533101594810" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="EnableFederation__row73491515487"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.7.2.4.1.1"><p id="EnableFederation__p834161584816">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.7.2.4.1.2"><p id="EnableFederation__p113491574817">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.7.2.4.1.3"><p id="EnableFederation__p183471534811">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EnableFederation__row1334015144814"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.1 "><p id="EnableFederation__p12342159489">-</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.2 "><p id="EnableFederation__p2341615174819">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.7.2.4.1.3 "><p id="EnableFederation__p83421519486">-</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="EnableFederation__p19341115184811"><strong id="EnableFederation__b1234161514481">Status code: 500</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EnableFederation__table123491515481" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="EnableFederation__row93419158482"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.9.2.4.1.1"><p id="EnableFederation__p103461513485">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.9.2.4.1.2"><p id="EnableFederation__p13353159481">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.9.2.4.1.3"><p id="EnableFederation__p1335141519485">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EnableFederation__row1034191516484"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.9.2.4.1.1 "><p id="EnableFederation__p143511158485">-</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.9.2.4.1.2 "><p id="EnableFederation__p13541519483">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.9.2.4.1.3 "><p id="EnableFederation__p113551513486">-</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EnableFederation__section651201811106"><h4 class="sectiontitle">Example Requests</h4><p id="EnableFederation__p851101821015">None</p>
|
|
</div>
|
|
<div class="section" id="EnableFederation__section95491815104"><h4 class="sectiontitle">Example Responses</h4><p id="EnableFederation__p10851134141519"><strong id="EnableFederation__b167579158544">Status code: 201</strong></p>
|
|
<p id="EnableFederation__p08514415159">Cluster federation has been enabled.</p>
|
|
<pre class="screen" id="EnableFederation__screen2085114111152">{ }</pre>
|
|
</div>
|
|
<div class="section" id="EnableFederation__section1055191817106"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EnableFederation__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="EnableFederation__row105616187101"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="EnableFederation__p175971812103">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="EnableFederation__p360918101014">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EnableFederation__row45681851015"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="EnableFederation__p156161813106">201</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="EnableFederation__p261161821011">Cluster federation has been enabled.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EnableFederation__row1157018161011"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="EnableFederation__p106271881011">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="EnableFederation__p863518181010">Client request error. The server could not execute the request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EnableFederation__row857111815104"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="EnableFederation__p176441813100">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="EnableFederation__p166818101013">Resources not found.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EnableFederation__row45718183109"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="EnableFederation__p1266121819102">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="EnableFederation__p3679188107">Internal server error.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EnableFederation__section156871821015"><h4 class="sectiontitle">Error Codes</h4><p id="EnableFederation__p1569101801017">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>
|
|
|