文档首页> VPC终端节点 VPCEP> API参考> API> 终端节点服务功能> 查询公共终端节点服务列表
更新时间:2024-03-15 GMT+08:00
分享

查询公共终端节点服务列表

功能介绍

查询公共终端节点服务的列表,公共终端节点服务是所有用户可见且可连接的终端节点服务, 由运维人员创建,用户可直接使用,但无权创建。

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

最小长度:1

最大长度:64

表2 Query参数

参数

是否必选

参数类型

描述

limit

Integer

查询返回公共的终端节点服务数量限制,即每页返回的个数。 取值范围:0~1000,取值一般为10,20或者50,默认为10。

最小值:1

最大值:1000

缺省值:10

offset

Integer

偏移量。 偏移量为一个大于0小于终端节点服务总个数的整数, 表示从偏移量后面的终端节点服务开始查询。

最小值:0

endpoint_service_name

String

公共终端节点服务的名称,支持大小写以及模糊匹配。

最小长度:1

最大长度:128

id

String

公共终端节点服务的ID,唯一标识。

最小长度:1

最大长度:64

sort_key

String

查询结果中终端节点服务列表的排序字段,取值为:

  • create_at:终端节点服务的创建时间

  • update_at:终端节点服务的更新时间 默认值为create_at。

缺省值:create_at

sort_dir

String

查询结果中终端节点服务列表的排序方式,取值为:

  • desc:降序排序

  • asc:升序排序 默认值为desc。

缺省值:desc

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

Content-Type

String

发送的实体的MIME类型。推荐用户默认使用application/json, 如果API是对象、镜像上传等接口,媒体类型可按照流类型的不同进行确定。

缺省值:application/json

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

endpoint_services

Array of EndpointService objects

终端节点服务列表。

total_count

Integer

满足查询条件的公共终端节点服务总条数,不受分页(即limit、offset参数)影响。

表5 EndpointService

参数

参数类型

描述

id

String

公共终端节点服务的ID,唯一标识。

最小长度:1

最大长度:64

owner

String

终端节点服务的所有者。

service_name

String

公共终端节点服务的名称。

service_type

String

终端节点服务类型。

  • gateway:由运维人员配置。用户无需创建,可直接使用。

  • interface:包括运维人员配置的云服务和用户自己创建的私有服务。 其中,运维人员配置的云服务无需创建, 用户可直接使用。 您可以通过创建终端节点创建访问Gateway和Interface类型终端节点服务的终端节点。

created_at

String

终端节点服务的创建时间。 采用UTC时间格式,格式为:YYYYMM-DDTHH:MM:SSZ

is_charge

Boolean

连接该终端节点服务的终端节点是否计费。

  • true:计费

  • false:不计费

enable_policy

Boolean

是否开启终端节点策略。

  • false:不支持设置终端节点策略

  • true:支持设置终端节点策略 默认为false 是否开启终端节点策略。

  • false:不支持设置终端节点策略

  • true:支持设置终端节点策略 默认为false

请求示例

查询公共终端节点服务列表

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}

响应示例

状态码: 200

服务器已成功处理了请求

{
  "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代码示例

SDK代码示例如下。

 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
# coding: utf-8

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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("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)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

服务器已成功处理了请求

错误码

请参见错误码

分享:

    相关文档

    相关产品