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

Updated on 2024-04-19 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	Project ID. Minimum: 1 Maximum: 64

**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. 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
endpoint_service_name	No	String	Specifies the name of the public VPC endpoint service. The value is case-sensitive and supports fuzzy match. Minimum: 1 Maximum: 128
id	No	String	Unique ID of the public VPC endpoint service. Minimum: 1 Maximum: 64
sort_key	No	String	Specifies the sorting field of the VPC endpoint services, which can be: ● create_at: VPC endpoint services are sorted by creation time. ● update_at: VPC endpoint services are sorted by update time. The default field is create_at. Default: create_at
sort_dir	No	String	Specifies the sorting method of VPC endpoint services, which can be: ● desc: VPC endpoint services are sorted in descending order. ● asc: VPC endpoint services are sorted in ascending order. The default method is desc. Default: 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. Default: application/json

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. Minimum: 1 Maximum: 64
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: VPC endpoint services of this type are configured by O&M personnel. You can use them directly without creating them by yourselves. ● interface: Cloud services configured by O&M personnel and private services created by yourselves are included. You cannot configure these cloud services, but can use them. You can create a VPC endpoint for accessing gateway and interface VPC endpoint services.
created_at	String	Specifies the creation time of the VPC endpoint service. The applied UTC time format is YYYYMM-DDTHH:MM:SSZ.
is_charge	Boolean	Specifies whether the associated VPC endpoint carries a charge. ● true: The associated VPC endpoint needs to be charged. ● false: The associated VPC endpoint does not need to be charged.
enable_policy	Boolean	Specifies whether the VPC endpoint policy is enabled. ● false: The VPC endpoint policy cannot be set. ● true: The VPC endpoint policy can be set. The default value is false. Specifies whether the VPC endpoint policy is enabled. ● false: The VPC endpoint policy cannot be set. ● true: The VPC endpoint policy can be set. 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
}