Help Center/ VPC Endpoint/ API Reference/ API/ VPC Endpoint Services/ Querying Public VPC Endpoint Services

Updated on 2025-05-15 GMT+08:00

View PDF

Querying Public VPC Endpoint Services

Function

This API is used to query public VPC endpoint services.

These services are created by O&M personnel and can be visible to and assessed by all users.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/vpc-endpoint-services/public

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the project ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Specifies the maximum number of public VPC endpoint services displayed on each page. The value ranges from 0 to 1000 and is generally 10, 20, or 50. The default number 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.
endpoint_service_name	No	String	Specifies the name of the public VPC endpoint service. The name can contain letters and supports fuzzy match.
id	No	String	Unique ID of the public VPC endpoint service.
sort_key	No	String	Specifies by what the VPC endpoint services are listed. create_at: VPC endpoint services are listed by creation time. update_at: VPC endpoint services are listed by update time. The default value is create_at.
sort_dir	No	String	Specifies how VPC endpoint services are sorted. desc: indicates the descending order. asc: indicates the ascending order. The default value is desc.

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.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
endpoint_services	Array of EndpointService objects	Specifies VPC endpoint services.
total_count	Integer	Specifies the total number of public VPC endpoint services that meet the search criteria. The number is not affected by limit or offset.

**Table 5** EndpointService
Parameter	Type	Description
id	String	Unique ID of the public VPC endpoint service.
owner	String	Specifies the owner of the VPC endpoint service.
service_name	String	Specifies the name of the public VPC endpoint service.
service_type	String	Specifies the type of the VPC endpoint service. gateway: indicates the VPC endpoint services that are configured by the O&M personnel. You can use them directly without creating them by yourselves. interface: indicates the cloud services configured by the O&M personnel and private services created by yourselves. You can directly use the cloud services configured by the O&M personnel without creating them by yourself. You can create VPC endpoints to connect to gateway and interface VPC endpoint services.
created_at	String	Specifies when the VPC endpoint service was created. The UTC time format YYYY-MM-DDTHH:MM:SSZ is used.
is_charge	Boolean	Specifies whether the VPC endpoint connected to the VPC endpoint service is billed. true: The VPC endpoint is billed. false: The VPC endpoint is not billed.
enable_policy	Boolean	Specifies whether the VPC endpoint policy can be customized. false: The VPC endpoint policy cannot be customized. true: The VPC endpoint policy can be customized. The default value is false.

Example Requests

Querying public VPC endpoint services

GET https://{endpoint}/v1/{project_id}/vpc-endpoint-services/public?limit={limit}&offset={offset}&endpoint_service_name={endpoint_service_name}&id={endpoint_service_id}&sort_key={sort_key}&sort_dir={sort_dir}

Example Responses

Status code: 200

The server has successfully processed the request.

{
  "endpoint_services" : [ {
    "id" : "b0e22f6f-26f4-461c-b140-d873464d4fa0",
    "owner" : "example",
    "service_name" : "test123",
    "service_type" : "interface",
    "created_at" : "2018-09-10T13:13:23Z",
    "is_charge" : "true"
  }, {
    "id" : "26391a76-546b-42a9-b2fc-496ec68c0e4d",
    "owner" : "example",
    "service_name" : "OBS",
    "service_type" : "gateway",
    "created_at" : "2019-03-28T09:30:27Z",
    "is_charge" : "true"
  } ],
  "total_count" : 2
}