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

调试

API Explorer

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

去调试

请求参数

Action String 必选示例值：DescribeVpcEndpointServices

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

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

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

PageNumber Integer 可选示例值：1

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

PageSize Integer 可选示例值：10

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

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

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

ServiceType String 可选示例值：Interface

终端节点服务的类型。

Interface：接口终端节点服务。

ServiceIds.N String 可选示例值：epsvc-2fe630gurkl37k5gfuy33****

终端节点服务的ID。

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

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

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

ProjectName String 可选示例值：default

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

ServiceResourceType String 可选示例值：CLB

终端节点服务关联的服务资源类型。取值如下：

CLB：负载均衡CLB。

ALB：应用型负载均衡ALB。

RDSMySQL：云数据库 MySQL版。

说明

私网连接支持ALB、RDS类型服务资源的功能正在邀测中，如需使用，请联系客户经理。

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。

传入空字符串时，表示查询标签值为空的ALB实例。

ServiceRegions.N String 可选示例值：cn-beijing

终端节点服务发布的地域。该地域的终端节点可与本终端节点服务建立连接。地域ID请参见地域与可用区。

返回参数

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

请求ID。

PageNumber Integer 示例值：1

当前页码。

PageSize Integer 示例值：10

当前分页的行数。

TotalCount Integer 示例值：2

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

VpcEndpointServices Object[] 示例值：--

终端节点服务的详细信息。

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

终端节点服务的ID。

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

终端节点服务的名称。

ServiceNameManaged String 示例值：false

是否为托管终端节点服务。

false：非托管终端节点服务。

true：托管终端节点服务。

说明

终端节点服务所属账号未开通托管终端节点服务功能时，不返回该参数。

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

终端节点服务的服务域名。

AutoAcceptEnabled Boolean 示例值：false

是否自动接受终端节点连接。

true：终端节点服务自动接受终端节点连接。

false：终端节点服务不会自动接受终端节点连接，需要调用EnableVpcEndpointConnection接口手动接受。

ServiceType String 示例值：Interface

终端节点服务的类型。

Interface：接口终端节点服务。

Payer String 示例值：Endpoint

私网连接的付费账号。

Endpoint：终端节点账号。

EndpointService：终端节点服务账号。

BillingType Integer 示例值：0

终端节点服务的计费类型。

0：不计费。

3：按量计费。

BusinessStatus String 示例值：Normal

终端节点服务是否被锁定。

Normal：正常。

FinancialLocked：被锁定。

说明

该参数返回为空时，表示终端节点服务未锁定。

IpAddressVersions String[] 示例值：ipv4

终端节点服务的IP协议类型。

返回值中仅包含ipv4时，说明该终端节点服务为IPv4类型，仅支持提供IPv4服务。

返回值中同时包含ipv4和ipv6时，说明该终端节点服务为双栈类型，支持同时提供IPv4和IPv6服务。

ServiceResourceType String 示例值：CLB

服务资源的类型。

CLB：负载均衡CLB。

ALB：应用型负载均衡ALB。

RDSMySQL：云数据库 MySQL版。

ZoneIds String[] 示例值：cn-guangzhou-a

终端节点服务提供服务的可用区。

说明

参数ServiceResourceType返回值为RDSMySQL时，该参数返回空值。

Description String 示例值：endpoint service

终端节点服务的描述信息。

PrivateDNSEnabled Boolean 示例值：false

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

false：未启用。

true：已启用。

PrivateDNSName String 示例值：www.example.com

终端节点服务的私有DNS名称。

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

PrivateDNSType String 示例值：public

私有DNS名称的域名类型。

public：公网。

说明

未开通自定义私网域名功能时，不返回该参数。

PrivateDNSNameConfiguration Object 示例值：--

终端节点服务私有DNS名称的配置信息。具体请参见下表PrivateDNSNameConfiguration。

说明

PrivateDNSType为private时，不返回该参数。

Name String 示例值：_2fe6iz2tou9s059gp68um****

域验证名称。

Status String 示例值：PendingVerification

域验证状态。

PendingVerification：待验证

Verifying：验证中

Verified：验证通过

Failed：验证失败

Type String 示例值：TXT

域验证类型。

TXT：TXT记录。

Value String 示例值：epsvc:2fe6iz4spybr459gp67fb****

域验证值。

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

终端节点服务的创建时间。

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

终端节点服务的删除时间。

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

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

Status String 示例值：Available

终端节点服务的状态。

Creating：创建中。

Pending：配置修改中。

Available：可用。

Deleting：删除中。

ProjectName String 示例值：default

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

Tags Object[] 示例值：--

终端节点服务的标签信息。

Key String 示例值：k1

终端节点服务标签的标签键。

Value String 示例值：v1

终端节点服务标签的标签值。

SupportedRegions String[] 示例值：["cn-beijing","cn-shanghai"]

终端节点服务发布的地域。

请求示例

返回示例

错误码

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

状态码	错误码	错误信息	说明
400	InvalidName.Malformed	The specified Name is malformed.	指定的参数Name格式不合法。
400	InvalidPaging.Malformed	The specified PageNumber or PageSize is malformed.	指定的分页参数格式不合法。
400	LimitExceed.EndpointServices	You've reached the limit on the number of EndpointServices 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.	已达到单次可指定过滤标签键值数量的上限。