Updated on 2022-12-06 GMT+08:00

Querying Connections of a VPC Endpoint Service

Function

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

URI

GET /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}

Table 1 describes the required parameters.
Table 1 Parameters

Parameter

Mandatory

Description

project_id

Yes

Specifies the project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

vpc_endpoint_service_id

Yes

Specifies the ID of the VPC endpoint service.

Table 2 Query parameters

Parameter

Mandatory

Type

Description

id

No

String

Specifies the unique ID of the VPC endpoint.

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 is pending acceptance.
  • accepted: The VPC endpoint has been accepted.
  • rejected: The VPC endpoint has been rejected.
  • failed: The VPC endpoint service failed to be created.

sort_key

No

String

Specifies the sorting field of the VPC endpoint list, which can be:

  • created_at: VPC endpoints are sorted by creation time.
  • updated_at: VPC endpoints are sorted by update time.

The default field is created_at.

sort_dir

No

String

Specifies the sorting method of the VPC endpoint list, which can be:

  • desc: indicates that VPC endpoints are sorted in the descending order.
  • asc: indicates that VPC endpoints are sorted in ascending order.

The default method is desc.

limit

No

Integer

Specifies the maximum number of connections displayed on each page.

The number ranges from 0 to 1000 and is generally 10, 20, or 50. The default value is 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.

Request

  • Parameter description

    None

  • Example request
    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

Response

  • Parameter description
    Table 3 Response parameters

    Parameter

    Type

    Description

    connections

    Array of objects

    Lists the connections. For details, see Table 4.

    total_count

    Integer

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

    Table 4 Connection parameters

    Parameter

    Type

    Description

    id

    String

    Specifies the unique ID of the VPC endpoint.

    marker_id

    Integer

    Specifies the packet ID of the VPC endpoint.

    created_at

    String

    Specifies the creation time of the VPC endpoint.

    The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.

    updated_at

    String

    Specifies the update time of the VPC endpoint.

    The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.

    domain_id

    String

    Specifies the user's domain ID.

    status

    String

    Specifies the connection status of the VPC endpoint.

    • pendingAcceptance: The VPC endpoint is pending acceptance.
    • creating: The VPC endpoint is being created.
    • accepted: The VPC endpoint has been accepted.
    • rejected: The VPC endpoint has been rejected.
    • failed: The VPC endpoint service failed to be created.
    • deleting: The VPC endpoint is being deleted.

    error

    Array of objects

    Specifies the error message.

    This field is returned when the status of the VPC endpoint service changes to failed. For details, see Table 5.

    Table 5 Error parameters

    Parameter

    Type

    Description

    error_code

    String

    Specifies the error code.

    error_message

    String

    Specifies the error message.

  • Example response
    {
      "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 Code

For details about status codes, see Status Code.