调用DescribeVpcEndpoints接口，查询满足指定条件的终端节点列表。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

Action String 必选示例值：DescribeVpcEndpoints

要执行的操作，取值：DescribeVpcEndpoints。

Version String 必选示例值：2020-04-01

API的版本信息，当前版本为 2020-04-01。

PageNumber Integer 可选示例值：1

列表的页码。默认值为1。

PageSize Integer 可选示例值：10

分页查询时每页的行数。最大值为100，默认值为10。

VpcId String 可选示例值：vpc-bp15zkdt37pq72zv****

终端节点所属VPC的ID。

您可以调用DescribeVpcs接口，获取VPC ID。

ServiceId String 可选示例值：epsvc-2fe630gurkl37k5gfuy33****

终端节点服务的ID。

您可以调用DescribeVpcEndpointServices接口，获取终端节点服务的ID。

ServiceName String 可选示例值：com.volces.privatelink.cn-guangzhou.epsvc-2fe630gurkl37k5gfuy33****

终端节点服务的名称。格式为：com.volces.privatelink.<地域ID>.<终端节点服务ID>。

EndpointIds.N String 可选示例值：ep-273yuq6q7bgn47fap8squ****

终端节点的ID。

您可以调用DescribeVpcEndpoints接口，获取终端节点的ID。

N：表示终端节点ID的序号，取值范围为1～100。

多个终端节点ID之间使用&分隔。

EndpointName String 可选示例值：endpoint-01

终端节点的名称。

Status String 可选示例值：Available

终端节点的状态。

Creating：创建中。

Pending：配置修改中。

Available：可用。

Deleting：删除中。

ConnectionStatus String 可选示例值：Connected

终端节点与终端节点服务的连接状态。

PendingAcceptance：等待连接。

Connecting：连接中。

Connected：已连接。

Disconnecting：断开连接中。

Rejected：拒绝连接。

Failed：连接失败。

PartialFailed：部分连接失败。

ServiceDeleted：服务已删除。

ProjectName String 可选示例值：default

终端节点所属的项目。

TagFilters.N.Key String 可选示例值：k1

标签的标签键。

参数 - N：表示标签键的序号，取值范围：1～10。

多个标签键之间用&分隔。多个标签键之间的关系为逻辑“与（AND）”，即查询同时添加多个标签键的接口终端节点。

不允许重复。

TagFilters.N.Values.N String 可选示例值：v1

标签的标签值。

第一个N：表示标签键的序号，取值范围：1～10。

第二个N：表示标签值的序号，取值范围：1～3。同一标签键多个标签值之间的关系为逻辑“或(OR)”，即查询同一标签键下添加其中一个标签值的接口终端节点。

多个标签值之间用&分隔。

说明

若传入该参数，则必须先传入TagFilters.N.Key。

传入空字符串时，表示查询标签值为空的接口终端节点。

返回参数

RequestId String 示例值：0ED8D006-F706-4D23-88ED-E11ED28D****

请求ID。

PageNumber Integer 示例值：1

当前页码。

PageSize Integer 示例值：10

当前分页的行数。

TotalCount Integer 示例值：2

符合条件的终端节点总数。

Endpoints Object[] 示例值：-

终端节点的详细信息。

EndpointId String 示例值：ep-273yuq6q7bgn47fap8squ****

终端节点的ID。

EndpointName String 示例值：endpoint-01

终端节点的名称。

EndpointType String 示例值：Interface

终端节点的类型。

Interface：接口终端节点。

IpAddressVersions String[] 示例值：ipv4

终端节点的IP协议类型。

返回值中仅包含ipv4时，说明该终端节点为IPv4类型。

返回值中同时包含ipv4和ipv6时，说明该终端节点为双栈类型。

Payer String 示例值：Endpoint

私网连接的付费账号。

Endpoint：终端节点账号。

EndpointService：终端节点服务账号。

EndpointDomain String 示例值：ep-273yuq6q7bgn47fap8squ****.epsvc-273yuqembrojk7fap8sbf****.cn-guangzhou.privatelink.volces.com

终端节点的域名。

Status String 示例值：Available

终端节点的状态。

Creating：创建中。

Pending：配置修改中。

Available：可用。

Deleting：删除中。

BusinessStatus String 示例值：Normal

终端节点是否被锁定。

Normal：正常。

FinancialLocked：被锁定。

ConnectionStatus String 示例值：Connecting

终端节点连接的状态。

PendingAcceptance：等待连接。

Connecting：连接中。

Connected：已连接。

Disconnecting：断开连接中。

Rejected：拒绝连接。

Failed：连接失败。

PartialFailed：部分连接失败。

ServiceDeleted：服务已删除。

Bps Integer 示例值：1000

终端节点连接的带宽上限，单位为Mbps。

EndpointZoneNums Integer 示例值：2

终端节点可用区的数量。

Description String 示例值：endpoint service

终端节点的描述信息。

ServiceId String 示例值：epsvc-2fe630gurkl37k5gfuy33****

终端节点服务的ID。

ServiceName String 示例值：com.volces.privatelink.cn-guangzhou.epsvc-2fe630gurkl37k5gfuy33****

终端节点服务的名称。

ServiceManaged Boolean 示例值：false

是否为托管终端节点。

false：非托管终端节点。

true：托管终端节点。

VpcId String 示例值：vpc-bp15zkdt37pq72zv****

终端节点所属VPC的ID。

PrivateDNSEnabled Boolean 示例值：false

终端节点是否启用私有DNS名称。

false：未启用。

true：已启用。

PrivateDNSName String 示例值：www.example.com

终端节点的私有DNS名称。

参数PrivateDNSEnabled返回值为false时，该参数返回空。

CreationTime String 示例值：2021-07-20T03:32:32+08:00

终端节点的创建时间。

UpdateTime String 示例值：2021-07-20T03:32:32+08:00

终端节点的最近操作时间。

DeletedTime String 示例值：2021-08-20T03:32:32+08:00

终端节点的删除时间。

ProjectName String 示例值：default

终端节点所属项目的名称。

Tags Object[] 示例值：-

终端节点的标签信息。

Key String 示例值：k1

终端节点标签的标签键。

Value String 示例值：v1

终端节点标签的标签值。

请求示例

返回示例

错误码

此处仅展示当前API的错误码，更多错误码请参见公共错误码。

状态码	错误码	错误信息	说明
400	InvalidName.Malformed	The specified Name is malformed.	指定的参数Name格式不合法。
400	InvalidPaging.Malformed	The specified PageNumber or PageSize is malformed.	指定的分页参数格式不合法。
400	LimitExceed.EndpointNumber	You've reached the limit on the number of endpoints that you can operate.	已达到单次可操作的终端节点的数量上限。
400	InvalidIncorrectOrder.Malformed	The specified index order is malformed.	指定的索引顺序参数格式不合法。
400	InvalidTagKey.Malformed	The specified TagKey is malformed.	指定的 TagKey 参数格式不合法。
400	InvalidTagValue.Malformed	The specified TagValue is malformed.	指定的 TagValue 参数格式不合法。
400	LimitExceeded.TagFilterKey	You've reached the limit on the number of tag keys that you can filter.	已达到单次可指定过滤标签键数量的上限。
400	LimitExceeded.TagFilterValues	You've reached the limit on the number of tag values that you can filter.	已达到单次可指定过滤标签键值数量的上限。
400	InvalidParameter.BatchQueryForFuzzySearch	Batch query parameters and precise search parameters are passed in at the same time.	批量查询参数与精确搜索参数不允许同时传入。
400	LimitExceed.EndpointServices	You've reached the limit on the number of EndpointServices that you can operate.	已达到单次可操作的终端节点服务的数量上限。
403	Forbidden	You are not authorized to perform operations on the specified service.	无权限对指定服务进行操作。