Function

This API is used to create a VPC endpoint for connecting to the federation API server after federation is enabled for a fleet.

URI

POST /v1/clustergroups/{clustergroupid}/connection

**Table 1** Path parameter
Parameter	Mandatory	Type	Description
clustergroupid	Yes	String	Fleet ID

Request Parameters

**Table 2** Parameters in the request header
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	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.
Content-Type	Yes	String	Message body type (format). Only application/json is supported.

**Table 3** Parameters in the request body
Parameter	Mandatory	Type	Description
projectID	Yes	String	Project ID
vpcID	Yes	String	VPC ID, which must belong to the project specified by projectID.
subnetID	Yes	String	Network ID of the subnet. The subnet must be in the VPC specified by vpcID.

Response Parameters

Status code: 201

**Table 4** Parameters in the response body
Parameter	Type	Description
id	String	VPC endpoint ID
ip	String	IP address of the VPC endpoint
dnsNames	Array of strings	Domain names of VPC endpoint services

Example Requests

Creating a federation connection

{
  "projectID" : "08d44be1ef00d22e2f6fc0061f54a2f1",
  "vpcID" : "11c9fe72-5a90-4295-bcfe-774726fb9066",
  "subnetID" : "0de91d89-1e06-4e24-b371-35d5d3d3779b"
}

Example Responses

Status code: 201

The federation API server has been connected using a VPC endpoint.

{
  "id" : "a02c4097-ff39-4d76-b9e3-743b7f400d01"
  "ip" : "192.168.1.116"
  "dnsNames" : "test-ucs-fleet.fleet.ucs.eu-de.com"
}

Status Codes

Status Code	Description
201	The federation API server has been connected using a VPC endpoint.

Error Codes

See Error Codes.

Creating a Federation Connection