Obtaining an Endpoint Connection

Function

This API is used to obtain a VPC endpoint connection.

Debugging

You can debug this API through automatic authentication in .

URI

GET /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/connections

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.
cluster_id	Yes	String	ID of the cluster you want to query.

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
connections	Array of connections objects	Connection information.
vpcepUpdateSwitch	Boolean	Whether to update endpoints. true: The VPC endpoint is enabled. false: The VPC endpoint is disabled.
total_count	Integer	Number of endpoints.

**Table 3** connections
Parameter	Type	Description
id	String	Endpoint ID.
status	String	Endpoint status. accepted: The VPC endpoint connection is enabled. rejected: The VPC endpoint connection is disabled.
maxSession	String	Maximum number of connections.
specificationName	String	Endpoint name.
created_at	String	Creation time. The format is ISO8601: CCYY-MM-DDThh:mm:ss.
update_at	String	Update time. The default value is null.
domain_id	String	Owner.

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "connections" : [ {
    "id" : "connectionsID",
    "status" : "accepted",
    "maxSession" : "3000",
    "specificationName" : "default",
    "created_at" : "2021-09-17T08:00:07Z",
    "update_at" : null,
    "domain_id" : "domainID"
  } ],
  "vpcepUpdateSwitch" : "false",
  "total_count" : 1
}

Status Codes

Status Code	Description
200	Request succeeded.
400	Invalid request. Modify the request before retry.
409	The request could not be completed due to a conflict with the current state of the resource. The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.
412	The server did not meet one of the preconditions contained in the request.