Help Center/ VPC Endpoint/ API Reference/ API/ VPC Endpoint Services/ Querying Basic Information About a VPC Endpoint Service

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

View PDF

Querying Basic Information About a VPC Endpoint Service

Function

This API is used to query basic information about a VPC endpoint service. You can use this API to query the target VPC endpoint service. This API can also be used by other users to query basic information about your VPC endpoint service, without exposing your server information.

Calling Method

For details, see Calling APIs.

URI

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

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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
endpoint_service_name	No	String	Specifies the name of the VPC endpoint service. Note: Either this field or the id field must be specified. Otherwise, an error occurs.
id	No	String	Specifies the ID of the VPC endpoint service. The ID is the unique identifier of the VPC endpoint service. Note: Either this parameter or endpoint_service_name must be specified.

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
id	String	Specifies the unique ID of the VPC endpoint service.
service_name	String	Specifies the name of the VPC endpoint service.
service_type	String	Specifies the type of the VPC endpoint service. Only your private services can be configured into interface VPC endpoint services. 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 cannot configure these cloud services, but can use them. 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.
public_border_group	String	Specifies the public border group information about the pool corresponding to the VPC endpoint.
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 basic information about a VPC endpoint service

GET https://{endpoint}/v1/{project_id}/vpc-endpoint-services/describe?id=4189d3c2-8882-4871-a3c2-d380272eed83

Example Responses

Status code: 200

The server has successfully processed the request.

{
  "id" : "9d4c1028-1336-4556-9881-b5d807c1b8a8",
  "service_name" : "test123",
  "service_type" : "interface",
  "created_at" : "2018-09-17T07:28:31Z",
  "is_charge" : "true"
}