更新时间:2024-09-11 GMT+08:00
分享

查询终端节点列表

功能介绍

查询当前用户下的终端节点的列表。

调用方法

请参见如何调用API

URI

GET /v1/{project_id}/vpc-endpoints

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

最小长度:1

最大长度:64

表2 Query参数

参数

是否必选

参数类型

描述

endpoint_service_name

String

终端节点服务的名称,支持大小写,前后模糊匹配。

最小长度:1

最大长度:128

vpc_id

String

终端节点所在的VPC的ID。

最小长度:1

最大长度:64

id

String

终端节点的ID,唯一标识。

最小长度:1

最大长度:64

limit

Integer

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

最小值:1

最大值:1000

缺省值:10

offset

Integer

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

最小值:0

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参数

参数

参数类型

描述

endpoints

Array of EndpointResponseBody objects

终端节点列表。

total_count

Integer

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

表5 EndpointResponseBody

参数

参数类型

描述

id

String

终端节点的ID,唯一标识。

最小长度:1

最大长度:64

service_type

String

终端节点连接的终端节点服务类型。

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

  • interface:包括运维人员配置的云服务和用户自己创建的私有服务。 其中,运维人员配置的云服务无需创建,用户可直接使用。 您可以通过查询公共终端节点服务列表, 查看由运维人员配置的所有用户可见且可连接的终端节点服务, 并通过创建终端节点服务创建Interface类型的终端节点服务。

status

String

终端节点的连接状态。

  • pendingAcceptance:待接受

  • creating:创建中

  • accepted:已接受

  • rejected:已拒绝

  • failed:失败

  • deleting:删除中

active_status

Array of strings

账号状态。

  • frozen:冻结

  • active:解冻

endpoint_service_name

String

终端节点服务的名称。

marker_id

Integer

终端节点的报文标识。

endpoint_service_id

String

终端节点服务的ID。

最小长度:1

最大长度:64

enable_dns

Boolean

是否创建域名。

  • true:创建域名

  • false:不创建域名 说明 当创建gateway类型终端节点服务的终端节点时, “enable_dns”设置为true或者false,均不创建域名。

dns_names

Array of strings

访问所连接的终端节点服务的域名。 当“enable_dns”为true时,该参数可见。

最小长度:0

最大长度:32

ip

String

访问所连接的终端节点服务的IP。 仅当同时满足如下条件时,返回该参数: 当查询连接interface类型终端节点服务的终端节点时。 终端节点服务启用“连接审批”功能,且已经“接受”连接审批。 “status”可以是“accepted”或者“rejected(仅支持“接受”连接审批后再“拒绝”的情况)”。

最小长度:1

最大长度:64

vpc_id

String

终端节点所在的VPC的ID。

最小长度:1

最大长度:64

subnet_id

String

vpc_id对应VPC下已创建的网络(network)的ID,UUID格式。

最小长度:1

最大长度:64

created_at

String

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

updated_at

String

终端节点的更新时间。 采用UTC时间格式,格式为:YYYY-MM-DDTHH:MM:SSZ

project_id

String

项目ID,获取方法请参见获取项目ID。

最小长度:1

最大长度:64

tags

Array of TagList objects

标签列表,没有标签默认为空数组。

error

Array of QueryError objects

错误信息。 当终端节点状态异常,即“status”的值为“failed”时,会返回该字段。

whitelist

Array of strings

控制访问终端节点的白名单。 若未创建,则返回空列表。 创建连接Interface类型终端节点服务的终端节点时,显示此参数。

最小长度:0

最大长度:32

enable_whitelist

Boolean

是否开启网络ACL隔离。

  • true:开启网络ACL隔离

  • false:不开启网络ACL隔离 若未指定,则返回false。 创建连接Interface类型终端节点服务的终端节点时,显示此参数。

routetables

Array of strings

路由表ID列表。 若未指定,返回默认VPC下路由表ID。 创建gateway类型终端节点服务的终端节点时,显示此参数。

最小长度:0

最大长度:64

description

String

描述字段,支持中英文字母、数字等字符,不支持“<”或“>”字符。

最小长度:0

最大长度:512

policy_statement

Array of PolicyStatement objects

Gateway类型终端节点策略信息,仅限OBS、SFS的终端节点服务的enable_policy值为true时支持该参数。

数组长度:0 - 10

policy_document

Object

终端节点策略信息,仅当终端节点服务的enable_policy值为true时支持该参数,默认值为完全访问权限。(OBS、SFS的终端节点服务暂不支持该参数)

数组长度:0 - 20480

endpoint_pool_id

String

待废弃,实例相关联的集群ID

最小长度:1

最大长度:64

public_border_group

String

终端节点关联的Public Border Group信息,只有当终端节点和边缘Pool相关联时才会返回该字段

表6 TagList

参数

参数类型

描述

key

String

键。 key不能为空,长度1~128个字符(中文也可以输入128个字符)。 可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : = + - @。 _sys_开头属于系统标签,租户不能输入。 key两头不能有空格字符。

最小长度:1

最大长度:128

value

String

值。 长度0~255个字符(中文也可以输入255个字符)。 可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : / = + - @。 资源标签值可以为空字符串。

最大长度:255

表7 QueryError

参数

参数类型

描述

error_code

String

错误编码。

最小长度:0

最大长度:10

error_message

String

错误信息。

最小长度:0

最大长度:1024

表8 PolicyStatement

参数

参数类型

描述

Effect

String

  • Allow,允许控制访问权限

  • Deny,拒绝控制访问权限

Action

Array of strings

obs访问权限

Resource

Array of strings

obs对象

请求示例

查询终端节点列表

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

响应示例

状态码: 200

服务器已成功处理了请求

{
  "endpoints" : [ {
    "id" : "03184a04-95d5-4555-86c4-e767a371ff99",
    "status" : "accepted",
    "ip" : "192.168.0.232",
    "marker_id" : 16777337,
    "active_status" : "active",
    "vpc_id" : "84758cf5-9c62-43ae-a778-3dbd8370c0a4",
    "service_type" : "interface",
    "project_id" : "295dacf46a4842fcbf7844dc2dc2489d",
    "subnet_id" : "68bfbcc1-dff2-47e4-a9d4-332b9bc1b8de",
    "enable_dns" : "true",
    "dns_names" : [ "test123" ],
    "created_at" : "2018-10-18T06:49:46Z",
    "updated_at" : "2018-10-18T06:49:50Z",
    "endpoint_service_id" : "5133655d-0e28-4090-b669-13f87b355c78",
    "endpoint_service_name" : "test123",
    "endpoint_pool_id" : "ee38223b-aacb-46f0-ba7e-94fa62e35dde",
    "public_border_group" : "br-abc-aaa1",
    "whitelist" : [ "127.0.0.1" ],
    "enable_whitelist" : true
  }, {
    "id" : "43b0e3b0-eec9-49da-866b-6687b75f9fe5",
    "status" : "accepted",
    "ip" : "192.168.0.115",
    "marker_id" : 16777322,
    "active_status" : "active",
    "vpc_id" : "e251b400-2963-4131-b38a-da81e32026ee",
    "service_type" : "interface",
    "project_id" : "295dacf46a4842fcbf7844dc2dc2489d",
    "subnet_id" : "65528a22-59a1-4972-ba64-88984b3207cd",
    "enable_dns" : "true",
    "dns_names" : [ "test123" ],
    "created_at" : "2018-10-18T06:36:20Z",
    "updated_at" : "2018-10-18T06:36:24Z",
    "endpoint_service_id" : "5133655d-0e28-4090-b669-13f87b355c78",
    "endpoint_service_name" : "test123",
    "endpoint_pool_id" : "ee38223b-aacb-46f0-ba7e-94fa62e35dde",
    "whitelist" : [ "127.0.0.1" ],
    "enable_whitelist" : 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
52
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 ListEndpointsSolution {

    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();
        ListEndpointsRequest request = new ListEndpointsRequest();
        request.withEndpointServiceName("<endpoint_service_name>");
        request.withVpcId("<vpc_id>");
        request.withId("<id>");
        request.withLimit(<limit>);
        request.withOffset(<offset>);
        request.withSortKey(ListEndpointsRequest.SortKeyEnum.fromValue("<sort_key>"));
        request.withSortDir(ListEndpointsRequest.SortDirEnum.fromValue("<sort_dir>"));
        try {
            ListEndpointsResponse response = client.listEndpoints(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
37
# 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 = ListEndpointsRequest()
        request.endpoint_service_name = "<endpoint_service_name>"
        request.vpc_id = "<vpc_id>"
        request.id = "<id>"
        request.limit = <limit>
        request.offset = <offset>
        request.sort_key = "<sort_key>"
        request.sort_dir = "<sort_dir>"
        response = client.list_endpoints(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
48
49
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.ListEndpointsRequest{}
	endpointServiceNameRequest:= "<endpoint_service_name>"
	request.EndpointServiceName = &endpointServiceNameRequest
	vpcIdRequest:= "<vpc_id>"
	request.VpcId = &vpcIdRequest
	idRequest:= "<id>"
	request.Id = &idRequest
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	offsetRequest:= int32(<offset>)
	request.Offset = &offsetRequest
	sortKeyRequest:= model.GetListEndpointsRequestSortKeyEnum().<SORT_KEY>
	request.SortKey = &sortKeyRequest
	sortDirRequest:= model.GetListEndpointsRequestSortDirEnum().<SORT_DIR>
	request.SortDir = &sortDirRequest
	response, err := client.ListEndpoints(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

服务器已成功处理了请求

错误码

请参见错误码

相关文档