Help Center/ VPC Endpoint/ API Reference/ API/ VPC Endpoint Services/ Querying Public VPC Endpoint Services
Updated on 2024-08-12 GMT+08:00

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
}

SDK Sample Code

The SDK sample code is as follows.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
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 ListServicePublicDetailsSolution {

    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();
        ListServicePublicDetailsRequest request = new ListServicePublicDetailsRequest();
        request.withLimit(<limit>);
        request.withOffset(<offset>);
        request.withEndpointServiceName("<endpoint_service_name>");
        request.withId("<id>");
        request.withSortKey(ListServicePublicDetailsRequest.SortKeyEnum.fromValue("<sort_key>"));
        request.withSortDir(ListServicePublicDetailsRequest.SortDirEnum.fromValue("<sort_dir>"));
        try {
            ListServicePublicDetailsResponse response = client.listServicePublicDetails(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());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
# 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 = ListServicePublicDetailsRequest()
        request.limit = <limit>
        request.offset = <offset>
        request.endpoint_service_name = "<endpoint_service_name>"
        request.id = "<id>"
        request.sort_key = "<sort_key>"
        request.sort_dir = "<sort_dir>"
        response = client.list_service_public_details(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
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.ListServicePublicDetailsRequest{}
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	offsetRequest:= int32(<offset>)
	request.Offset = &offsetRequest
	endpointServiceNameRequest:= "<endpoint_service_name>"
	request.EndpointServiceName = &endpointServiceNameRequest
	idRequest:= "<id>"
	request.Id = &idRequest
	sortKeyRequest:= model.GetListServicePublicDetailsRequestSortKeyEnum().<SORT_KEY>
	request.SortKey = &sortKeyRequest
	sortDirRequest:= model.GetListServicePublicDetailsRequestSortDirEnum().<SORT_DIR>
	request.SortDir = &sortDirRequest
	response, err := client.ListServicePublicDetails(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

The server has successfully processed the request.

Error Codes

See Error Codes.