Obtaining a VPC Endpoint Connection¶

Function¶

This API is used to obtain a VPC endpoint connection.

Debugging¶

You can debug this API in . Automatic authentication is supported.

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, see Obtaining a Project ID and Name.
cluster_id	Yes	String	ID of the cluster to be queried

Request Parameters¶

None

Response Parameters¶

Status code: 200

**Table 2** Response body parameter¶
Parameter	Type	Description
connections	Array of connections objects	Connection information
vpcepUpdateSwitch	Boolean	Indicates whether the endpoint update function is enabled. true: enabled false: 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	Time when a cluster is created. The format is ISO8601: CCYY-MM-DDThh:mm:ss.
update_at	String	Update time. The default value is null.
domain_id	String	Owner

Request Example¶

None

Response Example¶

Status code: 200

The request is processed successfully.

{
  "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	The request is processed successfully.
400	Invalid request. Modify the request instead of retrying.
409	The request cannot be processed due to a conflict. This status code indicates that the resource that the client attempts to create already exists, or the request fails to be processed because of the update of the conflict request.
412	The server does not meet one of the requirements that the requester puts on the request.

last updated: 2024-09-07 00:07