Help Center/ VPC Endpoint/ API Reference/ API/ VPC Endpoint Services/ Querying Connections to a VPC Endpoint Service
Updated on 2024-04-19 GMT+08:00

Querying Connections to a VPC Endpoint Service

Function

This API is used to query connections to a VPC endpoint service. The marker ID is the unique ID of each connection.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}/connections

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

Minimum: 1

Maximum: 64

vpc_endpoint_service_id

Yes

String

Specifies the ID of the VPC endpoint service.

Minimum: 1

Maximum: 64

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

id

No

String

Specifies the unique ID of the VPC endpoint.

Minimum: 1

Maximum: 64

marker_id

No

String

Specifies the packet ID of the VPC endpoint.

status

No

String

Specifies the connection status of the VPC endpoint. ● pendingAcceptance: The VPC endpoint connection is to be accepted. ● creating: The VPC endpoint connection is being created. ● accepted: The VPC endpoint connection has been accepted. ● failed: The VPC endpoint connection failed.

sort_key

No

String

Specifies the sorting field of the VPC endpoints, which can be: ●create_at: VPC endpoints are sorted by creation time. ●update_at: VPC endpoints are sorted by update time. The default field is create_at.

Default: create_at

sort_dir

No

String

Specifies the sorting method of VPC endpoints, which can be: ● desc: VPC endpoints are sorted in descending order. ● asc: VPC endpoints are sorted in ascending order. The default method is desc.

Default: desc

limit

No

Integer

Specifies the maximum number of connections displayed on each page. The value ranges from 0 to 1000 and is generally 10, 20, or 50. The default number is 10.

Minimum: 1

Maximum: 1000

Default: 10

offset

No

Integer

Specifies the offset. All VPC endpoint services after this offset will be queried. The offset must be an integer greater than 0 but less than the number of VPC endpoint services.

Minimum: 0

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies the user token. It can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token.

Content-Type

No

String

Specifies the MIME type of the request body. Default value application/json is recommended. For APIs used to upload objects or images, the MIME type varies depending on the flow type.

Default: application/json

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

connections

Array of ConnectionEndpoints objects

Specifies the connection list.

total_count

Integer

Specifies the total number of VPC endpoints that meet the search criteria. The number is not affected by limit or offset.

Table 5 ConnectionEndpoints

Parameter

Type

Description

id

String

Specifies the unique ID of the VPC endpoint.

Minimum: 1

Maximum: 64

marker_id

Integer

Specifies the packet ID of the VPC endpoint.

created_at

String

Specifies the creation time of the VPC endpoint. The applied UTC time format is YYYY-MMDDTHH:MM:SSZ.

updated_at

String

Specifies the update time of the VPC endpoint. The applied UTC time format is YYYY-MMDDTHH:MM:SSZ.

domain_id

String

Domain ID of a user.

Minimum: 1

Maximum: 64

error

Array of QueryError objects

Specifies the error message. This field is returned when the VPC endpoint is abnormal, that is, the value of status is failed.

status

String

Specifies the connection status of the VPC endpoint. ● pendingAcceptance: The VPC endpoint connection is to be accepted. ● creating: The VPC endpoint connection is being created. ● accepted: The VPC endpoint connection has been accepted. ● rejected: The VPC endpoint connection has been rejected. ● failed: The VPC endpoint connection failed. ● deleting: The VPC endpoint connection is being deleted.

description

String

Specifies the description of a VPC endpoint connection.

Minimum: 0

Maximum: 512

Table 6 QueryError

Parameter

Type

Description

error_code

String

Error code.

Minimum: 0

Maximum: 10

error_message

String

Error message.

Minimum: 0

Maximum: 1024

Example Requests

Querying connections to a VPC endpoint service

GET https://{endpoint}/v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}/connections? id={vpc_endpoint_id}&marker_id={marker_id}&status={status}&sort_key={sort_key }&sort_dir={sort_dir}&limit={limit}&offset={offset}

This request is to query connections of the VPC endpoint service whose ID is 4189d3c2-8882-4871-a3c2-d380272eed88. GET https://{endpoint}/v1/{project_id}/vpc-endpoint-services/4189d3c2-8882-4871-a3c2-d380272eed88/connections

Example Responses

Status code: 200

The server has successfully processed the request.

{
  "connections" : [ {
    "id" : "adb7b229-bb11-4072-bcc0-3327cd784263",
    "status" : "accepted",
    "marker_id" : 16777510,
    "domain_id" : "5fc973eea581490997e82ea11a1df31f",
    "created_at" : "2018-09-17T11:10:11Z",
    "updated_at" : "2018-09-17T11:10:12Z"
  }, {
    "id" : "fd69d29f-dc29-4a9b-80d8-b51d1e7e58ea",
    "status" : "accepted",
    "marker_id" : 16777513,
    "domain_id" : "5fc973eea581490997e82ea11a1df31f",
    "created_at" : "2018-09-17T07:28:56Z",
    "updated_at" : "2018-09-17T07:28:58Z"
  } ],
  "total_count" : 2
}

Status Codes

Status Code

Description

200

The server has successfully processed the request.

Error Codes

See Error Codes.