全部产品
Search
文档中心

私网连接 PrivateLink:ListVpcEndpointServices - 查询终端节点服务列表

更新时间:Feb 27, 2024

调用ListVpcEndpointServices接口,查询终端节点服务列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
privatelink:ListVpcEndpointServicesRead
  • VpcEndpointService
    acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/*

请求参数

名称类型必填描述示例值
RegionIdstring

终端节点服务所属的地域 ID。

您可以通过调用 DescribeRegions 接口获取地域 ID。

cn-huhehaote
NextTokenstring

是否拥有下一次查询的令牌(Token)。取值:

  • 第一次查询和没有下一次查询时,均无需填写。
  • 如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。
FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResultsinteger

分批次查询时每次显示的条目数。取值范围:1~50,默认值:50

50
ServiceIdstring

终端节点服务的 ID。

epsrv-hp3vpx8yqxblby3i****
ServiceNamestring

终端节点服务的名称。

com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****
ResourceIdstring

服务资源 ID。

lb-hp32z1wp5peaoox2q****
ServiceResourceTypestring

服务资源类型,取值:

  • slb:表示服务资源类型为传统型负载均衡 CLB(Classic Load Balancer)。

  • alb:表示服务资源类型为应用型负载均衡 ALB(Application Load Balancer)。

  • nlb :表示服务资源类型为网络型负载均衡 NLB(Network Load Balancer )。

slb
AutoAcceptEnabledboolean

是否自动接受终端节点连接,取值:

  • true:自动接受终端节点连接。

  • false(默认值):不自动接受终端节点连接。

false
ServiceStatusstring

终端节点服务的状态,取值:

  • Creating:创建中。

  • Pending:修改中。

  • Active:可用。

  • Deleting:删除中。

Active
ServiceBusinessStatusstring

终端节点服务的业务状态,取值:

  • Normal:正常。

  • FinancialLocked:欠费锁定。

Normal
ZoneAffinityEnabledboolean

是否支持连接服务的终端节点域名就近解析。取值:

  • true(默认值):是。
  • false:否。
true
Tagobject []

标签列表。

Keystring

实例的标签键。最多支持 20 个标签键。一旦传入该值,则不允许为空字符串。

最多支持 64 个字符,不能以aliyunacs:开头,不能包含http://或者https://

FinanceDept
Valuestring

实例的标签值。最多支持 20 个标签值。一旦传入该值,可以为空字符串。

最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://或者https://

FinanceJoshua
ResourceGroupIdstring

资源组 ID。

rg-acfmy*****

返回参数

名称类型描述示例值
object
Servicesobject []

终端节点服务集合。

AutoAcceptEnabledboolean

是否自动接受终端节点连接,取值:

  • true:自动接受终端节点连接。

  • false:不自动接受终端节点连接。

true
ServiceIdstring

终端节点服务的 ID。

epsrv-hp3vpx8yqxblby3i****
CreateTimestring

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

2021-09-24T17:15:10Z
MinBandwidthinteger

终端节点连接的最小带宽。单位:Mbps。

100
MaxBandwidthinteger

终端节点连接的最大带宽。单位:Mbps。

1024
ServiceStatusstring

终端节点服务的状态,取值:

  • Creating:创建中。

  • Pending:修改中。

  • Active:可用。

  • Deleting:删除中。

Active
ZoneAffinityEnabledboolean

是否支持可用区就近解析,取值:

  • true:是。
  • false:否。
true
RegionIdstring

终端节点服务所属的地域。

cn-huhehaote
ServiceDomainstring

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

epsrv-hp3vpx8yqxblby3i****.cn-huhehaote.privatelink.aliyuncs.com
Payerstring

付费方,取值:

  • Endpoint:服务使用方。
  • EndpointService:服务提供方。
Endpoint
ServiceBusinessStatusstring

终端节点服务的业务状态,取值:

  • Normal:正常。

  • FinancialLocked:欠费锁定。

Normal
ConnectBandwidthinteger

默认连接带宽峰值。单位:Mbps。

1024
ServiceNamestring

终端节点服务的名称。

com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****
ServiceDescriptionstring

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

This is my EndpointService.
ServiceResourceTypestring

服务资源类型,取值:

  • slb:表示服务资源类型为传统型负载均衡 CLB(Classic Load Balancer)。

  • alb:表示服务资源类型为应用型负载均衡 ALB(Application Load Balancer)。

  • nlb :表示服务资源类型为网络型负载均衡 NLB(Network Load Balancer )。

slb
ServiceTypestring

终端节点服务类型,取值:

  • Interface:表示 ServiceResourceTypeslb(传统型负载均衡 CLB)、alb(应用型负载均衡 ALB)、nlb(网络型负载均衡 NLB)时的终端节点服务类型。
Interface
ServiceSupportIPv6boolean

终端节点服务是否支持 IPv6 功能。取值:

  • true:是。

  • false:否。

false
Tagsobject []

标签列表。

Keystring

实例的标签键。

FinanceDept
Valuestring

实例的标签值。

FinanceJoshua
ResourceGroupIdstring

资源组 ID。

rg-acfmy*****
NextTokenstring

是否拥有下一次查询的令牌(Token)。取值:

  • 如果 NextToken 为空表示没有下一次查询。
  • 如果 NextToken 有返回值,该取值表示下一次查询开始的令牌。
FFmyTO70tTpLG6I3FmYAXGKPd****
RequestIdstring

请求 ID。

0ED8D006-F706-4D23-88ED-E11ED28DCAC0
MaxResultsinteger

分批次查询时每次显示的条目数。

50
TotalCountinteger

总记录数。

12

示例

正常返回示例

JSON格式

{
  "Services": [
    {
      "AutoAcceptEnabled": true,
      "ServiceId": "epsrv-hp3vpx8yqxblby3i****",
      "CreateTime": "2021-09-24T17:15:10Z",
      "MinBandwidth": 100,
      "MaxBandwidth": 1024,
      "ServiceStatus": "Active",
      "ZoneAffinityEnabled": true,
      "RegionId": "cn-huhehaote",
      "ServiceDomain": "epsrv-hp3vpx8yqxblby3i****.cn-huhehaote.privatelink.aliyuncs.com",
      "Payer": "Endpoint",
      "ServiceBusinessStatus": "Normal",
      "ConnectBandwidth": 1024,
      "ServiceName": "com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****",
      "ServiceDescription": "This is my EndpointService.",
      "ServiceResourceType": "slb",
      "ServiceType": "Interface",
      "ServiceSupportIPv6": false,
      "Tags": [
        {
          "Key": "FinanceDept",
          "Value": "FinanceJoshua"
        }
      ],
      "ResourceGroupId": "rg-acfmy*****"
    }
  ],
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0",
  "MaxResults": 50,
  "TotalCount": 12
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-09-26OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-09-05OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-03-02OpenAPI 描述信息更新、OpenAPI 返回结构发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
出参OpenAPI 返回结构发生变更
2022-12-06OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:ResourceId
2022-09-20OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:ResourceGroupId
出参OpenAPI 返回结构发生变更
2022-07-26OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:Tag
出参OpenAPI 返回结构发生变更
2021-03-17OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更