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

Updated on 2024-09-11 GMT+08:00

Online Debugging

CLI Examples

View PDF

Querying VPC Endpoint Services

Function

This API is used to query VPC endpoint services.

Calling Method

For details, see Calling APIs.

URI

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

**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
endpoint_service_name	No	String	Specifies the name of the VPC endpoint service. The name is not case-sensitive and supports fuzzy match. Minimum: 1 Maximum: 128
id	No	String	Specifies the unique ID of the VPC endpoint service.
status	No	String	Specifies the status of the VPC endpoint service. ● creating: The VPC endpoint service is being created. ● available: The VPC endpoint service can be connected. ● failed: The VPC endpoint service fails to be created. ● deleting: The VPC endpoint service is being deleted.
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
limit	No	Integer	Specifies the maximum number of 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
public_border_group	No	String	Specifies the VPC endpoint service that matches the edge attribute in the filtering result.
net_type	No	String	Specifies the type of the network to which the IPv4 address of the VPC endpoint belongs. Minimum: 1 Maximum: 5

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 ServiceList objects	Specifies VPC endpoint services.
total_count	Integer	Specifies the total number of VPC endpoint services that meet the search criteria. The number is not affected by limit or offset.

**Table 5** ServiceList
Parameter	Type	Description
id	String	Specifies the unique ID of the VPC endpoint service. Minimum: 1 Maximum: 64
port_id	String	Specifies the ID that identifies the backend resource of the VPC endpoint service. The ID is in UUID format. If the backend resource is ● A load balancer (recommended), specify the port ID of the private IP address of the load balancer. ● An ECS, specify the NIC ID of the ECS IP address. ● A virtual IP address (discarded), specify the NIC ID of the physical server where virtual resources are created.
service_name	String	Specifies the name of the VPC endpoint service. Minimum: 0 Maximum: 16
server_type	String	Specifies the resource type. ● VM: indicates a cloud server. ● VIP: indicates a virtual IP address. ● LB: indicates a shared load balancer.
vpc_id	String	Specifies the ID of the VPC to which the backend resource of the VPC endpoint service belongs. Minimum: 1 Maximum: 64
approval_enabled	Boolean	Specifies whether approval is required. ● false: No approval is required. The created VPC endpoint is in the accepted state by default. ● true: Approval is required. The created VPC endpoint is in the pendingAcceptance state, and 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 can be connected. ● failed: The VPC endpoint service fails 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: 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. Cloud services configured by O&M personnel do not need to be created. You can use it directly. 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 YYYY-MMDDTHH:MM:SSZ.
updated_at	String	Specifies the update time of the VPC endpoint service. The applied UTC time format is YYYY-MMDDTHH:MM:SSZ.
project_id	String	Project ID. For details about how to obtain the project ID, see Obtaining a Project ID. Minimum: 1 Maximum: 64
domain_id	String	Domain ID Minimum: 1 Maximum: 64
ports	Array of PortList objects	Specifies the port mappings opened by 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,the combinations of server ports and protocols for all port mappings between VPC endpoint services must be unique.
ip	String	Specifies the IPv4 address or domain name of the interface VPC endpoint in VLAN scenarios.
tags	Array of TagList objects	Resource tag list
connection_count	Integer	Specifies the number of VPC endpoints that are in the Creating or Accepted status. Minimum: 0
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.
error	Array of Error objects	Specifies the error message returned when a task submission exception occurs.
description	String	Specifies the description field. The value can contain characters such as letters and digits, but cannot contain less than signs (<) and great than signs (>). Minimum: 0 Maximum: 512
public_border_group	String	Specifies the information about Public Border Group of the pool corresponding to the VPC endpoint service.
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.

**Table 6** 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. Minimum: 1 Maximum: 65535 Minimum: 1 Maximum: 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 Minimum: 1 Maximum: 65535 Minimum: 1 Maximum: 65535
protocol	String	Port mapping protocol. TCP is supported. Default: TCP

**Table 7** TagList
Parameter	Type	Description
key	String	Specifies the tag key. A tag key contains a maximum of 36 Unicode characters. It cannot be left blank. It cannot contain equal signs (=), asterisks (), less than signs (<), greater than signs (>), backslashes (), commas (,), vertical bars (\|), and slashes (/), and the first and last characters cannot be spaces. Minimum: 1 Maximum: 128*
value	String	Specifies the tag key. A tag value contains a maximum of 43 Unicode characters and can be an empty string. It cannot contain equal signs (=), asterisks (), less than signs(<), greater than signs (>), backslashes (), commas (,), vertical bars (\|), and slashes (/), and the first and last characters cannot be spaces. Maximum: 255*

**Table 8** Error
Parameter	Type	Description
message	String	Task error description Minimum: 0 Maximum: 1024
code	String	Error code of a task exception. Minimum: 0 Maximum: 10

Example Requests

Querying VPC endpoint services

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

Example Responses

Status code: 200

The server has successfully processed the request.

{
  "endpoint_services" : [ {
    "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",
    "created_at" : "2022-04-14T09:35:47Z",
    "updated_at" : "2022-04-14T09:36:47Z",
    "public_border_group" : "br-abc-aaa1"
  } ],
  "total_count" : 1
}

SDK Sample Code

The SDK sample code is as follows.

      
       
         
         
           package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.vpcep.v1.region.VpcepRegion;
import com.huaweicloud.sdk.vpcep.v1.*;
import com.huaweicloud.sdk.vpcep.v1.model.*;


public class ListEndpointServiceSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        VpcepClient client = VpcepClient.newBuilder()
                .withCredential(auth)
                .withRegion(VpcepRegion.valueOf("<YOUR REGION>"))
                .build();
        ListEndpointServiceRequest request = new ListEndpointServiceRequest();
        request.withEndpointServiceName("<endpoint_service_name>");
        request.withId("<id>");
        request.withStatus(ListEndpointServiceRequest.StatusEnum.fromValue("<status>"));
        request.withSortKey(ListEndpointServiceRequest.SortKeyEnum.fromValue("<sort_key>"));
        request.withSortDir(ListEndpointServiceRequest.SortDirEnum.fromValue("<sort_dir>"));
        request.withLimit(<limit>);
        request.withOffset(<offset>);
        request.withPublicBorderGroup("<public_border_group>");
        try {
            ListEndpointServiceResponse response = client.listEndpointService(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

          

        

      
     

      
       
         
         
           # coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkvpcep.v1.region.vpcep_region import VpcepRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkvpcep.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = BasicCredentials(ak, sk)

    client = VpcepClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(VpcepRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListEndpointServiceRequest()
        request.endpoint_service_name = "<endpoint_service_name>"
        request.id = "<id>"
        request.status = "<status>"
        request.sort_key = "<sort_key>"
        request.sort_dir = "<sort_dir>"
        request.limit = <limit>
        request.offset = <offset>
        request.public_border_group = "<public_border_group>"
        response = client.list_endpoint_service(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

          

        

      
     

      
       
         
         
           package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    vpcep "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpcep/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpcep/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpcep/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := vpcep.NewVpcepClient(
        vpcep.VpcepClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListEndpointServiceRequest{}
	endpointServiceNameRequest:= "<endpoint_service_name>"
	request.EndpointServiceName = &endpointServiceNameRequest
	idRequest:= "<id>"
	request.Id = &idRequest
	statusRequest:= model.GetListEndpointServiceRequestStatusEnum().<STATUS>
	request.Status = &statusRequest
	sortKeyRequest:= model.GetListEndpointServiceRequestSortKeyEnum().<SORT_KEY>
	request.SortKey = &sortKeyRequest
	sortDirRequest:= model.GetListEndpointServiceRequestSortDirEnum().<SORT_DIR>
	request.SortDir = &sortDirRequest
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	offsetRequest:= int32(<offset>)
	request.Offset = &offsetRequest
	publicBorderGroupRequest:= "<public_border_group>"
	request.PublicBorderGroup = &publicBorderGroupRequest
	response, err := client.ListEndpointService(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

          

        

      
     