Help Center/ VPC Endpoint/ API Reference/ API/ VPC Endpoint Services/ Querying Details of a VPC Endpoint Service

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

Online Debugging

CLI Examples

View PDF

Querying Details of a VPC Endpoint Service

Function

This API is used to query details of a VPC endpoint service.

Calling Method

For details, see Calling APIs.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the project ID.
vpc_endpoint_service_id	Yes	String	Specifies the ID of the VPC endpoint service.

Request Parameters

**Table 2** 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 3** Response body parameters
Parameter	Type	Description
id	String	Specifies the unique ID of the VPC endpoint service.
port_id	String	Specifies the ID that identifies the backend resource of the VPC endpoint service. The ID is in UUID format. The value can be: LB: indicates the port ID of the private IP address of a load balancer (recommended). VM: indicates the NIC ID of an ECS IP address. VIP: indicates the NIC ID of the virtual server for which the virtual IP address is configured. (This value has been discarded. LB is recommended.)
service_name	String	Specifies the name of the VPC endpoint service.
server_type	String	Specifies the resource type. VM: cloud server VIP: virtual IP address LB: enhanced load balancer
vpc_id	String	Specifies the ID of the VPC where the backend resource of the VPC endpoint service is located.
approval_enabled	Boolean	Specifies whether connection approval is required. false: Connection approval is not required. The created VPC endpoint is in the accepted state. true: Connection approval is required. The created VPC endpoint is in the pendingAcceptance state, and it can be used only after being approved by the user of the VPC endpoint service.
status	String	Specifies the status of the VPC endpoint service. creating: The VPC endpoint service is being created. available: The VPC endpoint service is connectable. failed: The VPC endpoint service failed to be created. deleting: The VPC endpoint service is being deleted.
service_type	String	Specifies the type of the VPC endpoint service. There are two types of VPC endpoint services: interface and gateway. 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.
supported_editions	Array of strings	Specifies the type of the VPC endpoint service. The value can be profession or basic.
created_at	String	Specifies when the VPC endpoint service was created. The UTC time format YYYY-MM-DDTHH:MM:SSZ is used.
updated_at	String	Specifies when the VPC endpoint service was updated. The UTC time format YYYY-MM-DDTHH:MM:SSZ is used.
project_id	String	Specifies the project ID. For details about how to obtain the project ID, see "Obtaining a Project ID".
cidr_type	String	Specifies the CIDR block type. public: indicates a public CIDR block. internal: indicates a private CIDR block. The default value is internal.
ip	String	Specifies the IPv4 address or domain name of the interface VPC endpoint in VLAN scenarios.
ports	Array of PortList objects	Specifies the port mappings opened to the VPC endpoint service. Duplicate port mappings are not allowed in the same VPC endpoint service. If multiple VPC endpoint services share one port_id, either server_port or protocol, or both server_port and protocol of each of these endpoint services must be unique.
tcp_proxy	String	Specifies whether to transfer client information, such as source IP addresses, source port numbers, and marker IDs, to the server. The information can be sent to the server in the following ways: TCP TOA: The client information is placed into the tcp option field and sent to the server. Note: TCP TOA is available only when the backend resource is an OBS resource. Proxy Protocol: The client information is placed into the tcp payload field and sent to the server. tcp_proxy is available only when the server can parse the tcp option and tcp payload fields. The value can be one of the following: close: Neither TCP TOA nor Proxy Protocol information is carried. toa_open: TCP TOA information is carried. proxy_open: Proxy Protocol information in carried. open: Both TCP TOA and Proxy Protocol information are carried. The default value is close.
tags	Array of TagList objects	Specifies resource tags.
error	Array of Error objects	Specifies the error message returned when there is an error.
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.
description	String	Specifies the description field. The value can contain characters such as letters and digits, but cannot contain angle brackets (< or >).

**Table 4** PortList
Parameter	Type	Description
client_port	Integer	Specifies the port to be accessed by a VPC endpoint. This port is provided by the VPC endpoint, allowing you to access the VPC endpoint service. Supported range: 1 to 65535.
server_port	Integer	Specifies the port for accessing the VPC endpoint service. This port is associated with backend resources to provide VPC endpoint services. Supported range: 1 to 65535
protocol	String	Port mapping protocol. TCP is supported.

**Table 5** TagList
Parameter	Type	Description
key	String	Specifies the tag key. key cannot be left blank. A key can contain 1 to 128 characters. A key can contain UTF-8 letters, digits, spaces, and the following special characters _ . : = + - @ Keys cannot start with _sys_ because it indicates a system tag. A key cannot start or end with a space.
value	String	Specifies the tag value. A value can contain 0 to 255 characters. A value can contain UTF-8 letters, digits, spaces, and the following special characters _ . : / = + - @ A value can be an empty string.

**Table 6** Error
Parameter	Type	Description
message	String	Task error description
code	String	Error code of a task exception.

Example Requests

Querying details about a VPC endpoint service

GET https://{endpoint}/v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}

For example, you can call the API (GET https://{endpoint}/v1/{project_id}/vpc-endpoint-services/4189d3c2-8882-4871-a3c2-d380272eed88) to query the VPC endpoint service whose ID is **4189d3c2-8882-4871-a3c2-d380272eed88**.

Example Responses

Status code: 200

The server has successfully processed the request.

{
  "id" : "4189d3c2-8882-4871-a3c2-d380272eed83",
  "port_id" : "4189d3c2-8882-4871-a3c2-d380272eed88",
  "vpc_id" : "4189d3c2-8882-4871-a3c2-d380272eed80",
  "status" : "available",
  "approval_enabled" : false,
  "service_name" : "test123",
  "server_type" : "VM",
  "service_type" : "interface",
  "ports" : [ {
    "client_port" : "8080",
    "server_port" : "80",
    "protocol" : "TCP"
  }, {
    "client_port" : "8081",
    "server_port" : "80",
    "protocol" : "TCP"
  } ],
  "project_id" : "6e9dfd51d1124e8d8498dce894923a0d",
  "supported_editions" : [ "basic", "profession" ],
  "created_at" : "2022-04-14T09:35:47Z",
  "updated_at" : "2022-04-14T09:36:47Z"
}