yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
218900ecfc237f6c0ba9f9684f9afa10f1d5ea9a
doc-exports/docs/ucs/api-ref/CreateFederationConnection.html
qiujiandong1 535e30e292 UCS API initial update 20250523 version 
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>
2026-02-23 09:12:31 +00:00

180 lines
13 KiB
HTML
Raw Blame History

<a name="CreateFederationConnection"></a><a name="CreateFederationConnection"></a>
<h1 class="topictitle1">Creating a Federation Connection</h1>
<div id="body54841018201012"><div class="section" id="CreateFederationConnection__section164851718131018"><h4 class="sectiontitle">Function</h4><p id="CreateFederationConnection__p148661817108">This API is used to create a VPC endpoint for connecting to the federation API server after federation is enabled for a fleet.</p>
</div>
<div class="section" id="CreateFederationConnection__section1248619189103"><h4 class="sectiontitle">URI</h4><p id="CreateFederationConnection__p144875186100">POST /v1/clustergroups/{clustergroupid}/connection</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateFederationConnection__table18489818161010" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameter</caption><thead align="left"><tr id="CreateFederationConnection__row1448811861010"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="CreateFederationConnection__p6489101817105">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="CreateFederationConnection__p449011851016">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="CreateFederationConnection__p104911318191014">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="CreateFederationConnection__p149121820102">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateFederationConnection__row19488918111018"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="CreateFederationConnection__p949511184109">clustergroupid</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="CreateFederationConnection__p13496618131011">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="CreateFederationConnection__p144981318151015">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="CreateFederationConnection__p749820184107">Fleet ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="CreateFederationConnection__section1449910187105"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateFederationConnection__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters in the request header</caption><thead align="left"><tr id="CreateFederationConnection__row185007187106"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="CreateFederationConnection__p65021718181017">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="CreateFederationConnection__p9503181812107">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="CreateFederationConnection__p8505118131017">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="CreateFederationConnection__p85061218121011">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateFederationConnection__row145001318151013"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="CreateFederationConnection__p1650651812106">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="CreateFederationConnection__p1450711186104">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="CreateFederationConnection__p135082184109">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="CreateFederationConnection__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="CreateFederationConnection__row1381822017225"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="CreateFederationConnection__p20110172212422">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="CreateFederationConnection__p411018227429">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="CreateFederationConnection__p7110152218429">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="CreateFederationConnection__p12110172216422">Message body type (format). Only <strong id="CreateFederationConnection__b31259682041726">application/json</strong> is supported.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateFederationConnection__request_CreateFederationConnectionRequestBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameters in the request body</caption><thead align="left"><tr id="CreateFederationConnection__row1251041815103"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="CreateFederationConnection__p151221831011">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="CreateFederationConnection__p205131418111018">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="CreateFederationConnection__p19513101881016">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="CreateFederationConnection__p11514181813109">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateFederationConnection__row14510918181010"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateFederationConnection__p18514171861010">projectID</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateFederationConnection__p16515121811013">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateFederationConnection__p18516181841011">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateFederationConnection__p165169181101">Project ID</p>
</td>
</tr>
<tr id="CreateFederationConnection__row451031818104"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateFederationConnection__p35171186101">vpcID</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateFederationConnection__p251821816102">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateFederationConnection__p0518018161014">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateFederationConnection__p14520101861011">VPC ID, which must belong to the project specified by <strong id="CreateFederationConnection__b18880171413262">projectID</strong>.</p>
</td>
</tr>
<tr id="CreateFederationConnection__row205101018201011"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateFederationConnection__p65201018171020">subnetID</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateFederationConnection__p1852111817106">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateFederationConnection__p1852221810102">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateFederationConnection__p4522101861013">Network ID of the subnet. The subnet must be in the VPC specified by <strong id="CreateFederationConnection__b17271922192613">vpcID</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="CreateFederationConnection__section55231188109"><h4 class="sectiontitle">Response Parameters</h4><p id="CreateFederationConnection__p1552441831011"><strong id="CreateFederationConnection__b182047348443959">Status code: 201</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateFederationConnection__response_VPCEPEndpoint" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Parameters in the response body</caption><thead align="left"><tr id="CreateFederationConnection__row55261918111012"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="CreateFederationConnection__p4527191820107">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="CreateFederationConnection__p10528111801010">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="CreateFederationConnection__p15291718111017">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateFederationConnection__row752671831015"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateFederationConnection__p12530171871014">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateFederationConnection__p0531161871016">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateFederationConnection__p16532111818101">VPC endpoint ID</p>
</td>
</tr>
<tr id="CreateFederationConnection__row33176812716"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateFederationConnection__p5318198576">ip</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateFederationConnection__p33182815712">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateFederationConnection__p831818817714">IP address of the VPC endpoint</p>
</td>
</tr>
<tr id="CreateFederationConnection__row372417116719"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateFederationConnection__p4725131111710">dnsNames</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateFederationConnection__p107256111373">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateFederationConnection__p117251611675">Domain names of VPC endpoint services</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="CreateFederationConnection__section3533101851014"><h4 class="sectiontitle">Example Requests</h4><p id="CreateFederationConnection__p7534181816109">Creating a federation connection</p>
<pre class="screen" id="CreateFederationConnection__screen12536118181019">{
"projectID" : "08d44be1ef00d22e2f6fc0061f54a2f1",
"vpcID" : "11c9fe72-5a90-4295-bcfe-774726fb9066",
"subnetID" : "0de91d89-1e06-4e24-b371-35d5d3d3779b"
}</pre>
</div>
<div class="section" id="CreateFederationConnection__section1253921818100"><h4 class="sectiontitle">Example Responses</h4><p id="CreateFederationConnection__p195401918191019"><strong id="CreateFederationConnection__b65466244643959">Status code: 201</strong></p>
<p id="CreateFederationConnection__p654011814104">The federation API server has been connected using a VPC endpoint.</p>
<pre class="screen" id="CreateFederationConnection__screen165416182100">{
"id" : "a02c4097-ff39-4d76-b9e3-743b7f400d01"
"ip" : "192.168.1.116"
"dnsNames" : "test-ucs-fleet.fleet.ucs.eu-de.com"
}</pre>
</div>
<div class="section" id="CreateFederationConnection__section75431918131017"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateFederationConnection__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="CreateFederationConnection__row17545121814109"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="CreateFederationConnection__p11546141871016">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="CreateFederationConnection__p354791881019">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateFederationConnection__row6545518191019"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="CreateFederationConnection__p954861861017">201</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="CreateFederationConnection__p254851819102">The federation API server has been connected using a VPC endpoint.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="CreateFederationConnection__section154981816107"><h4 class="sectiontitle">Error Codes</h4><p id="CreateFederationConnection__p755020184100">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>
View Git Blame Copy Permalink