文档

ListVpcEndpoints - 查询终端节点列表

更新时间:

调用ListVpcEndpoints接口,查询终端节点列表。

调试

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

授权信息

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

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

请求参数

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

要查询的终端节点所属的地域 ID。

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

cn-huhehaote
NextTokenstring

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

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

分页大小。取值范围:1~50。默认值:50

50
EndpointIdstring

要查询的终端节点 ID。

ep-hp33b2e43fays7s8****
ServiceNamestring

要查询的终端节点关联的终端节点服务名称。

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

终端节点所属的专有网络。

vpc-fdjkf789dfdfdfde****
EndpointNamestring

终端节点名称。

test
EndpointTypestring

终端节点类型。

仅取值: Interface,表示接口终端节点,您可以添加应用型负载均衡 ALB(Application Load Balancer)、传统型负载均衡 CLB(Classic Load Balancer)和网络型负载均衡 NLB(Network Load Balancer )的服务资源类型。

Interface
EndpointStatusstring

终端节点状态,取值:

  • Creating:创建中。

  • Active:可用。

  • Pending:修改中。

  • Deleting:删除中。

Active
ConnectionStatusstring

终端节点连接状态,取值:

  • Pending:修改中。

  • Connecting:连接中。

  • Connected:已连接。

  • Disconnecting:断开连接中。

  • Disconnected:未连接。

  • Deleting:删除中。

  • ServiceDeleted:终端节点对应的服务已删除。

Disconnected
Tagobject []

标签列表。

Keystring

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

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

FinanceDept
Valuestring

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

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

FinanceJoshua
ResourceGroupIdstring

资源组 ID。

1

返回参数

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

终端节点信息集合。

VpcIdstring

终端节点所属的专有网络。

vpc-hp356stwkxg3fn2xe****
EndpointNamestring

终端节点名称。

test
EndpointTypestring

终端节点类型。

仅取值: Interface,表示接口终端节点,您可以添加应用型负载均衡 ALB(Application Load Balancer)、传统型负载均衡 CLB(Classic Load Balancer)和网络型负载均衡 NLB(Network Load Balancer )的服务资源类型。

Interface
CreateTimestring

终端节点的创建时间。

2021-09-24T18:00:07Z
ServiceIdstring

终端节点关联的终端节点服务的 ID。

epsrv-hp3vpx8yqxblby3i****
ZoneAffinityEnabledboolean

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

  • true:是。

  • false:否。

true
EndpointDomainstring

终端节点域名。

ep-hp33b2e43fays7s8****.epsrv-hp3xdsq46ael67lo****.cn-huhehaote.privatelink.aliyuncs.com
EndpointStatusstring

终端节点状态,取值:

  • Creating:创建中。

  • Active:可用。

  • Pending:修改中。

  • Deleting:删除中。

Active
RegionIdstring

终端节点所属的地域 ID。

cn-huhehaote
ResourceOwnerboolean

终端节点和终端节点服务是否同一账号,取值:

  • true:是。

  • false:否。

true
Bandwidthlong

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

1024
ConnectionStatusstring

终端节点连接状态,取值:

  • Pending:修改中。

  • Connecting:连接中。

  • Connected:已连接。

  • Disconnecting:断开连接中。

  • Disconnected:未连接。

  • Deleting:删除中。

  • ServiceDeleted:终端节点对应的服务已删除。

Disconnected
EndpointDescriptionstring

终端节点描述。

This is my Endpoint.
EndpointIdstring

终端节点 ID。

ep-hp33b2e43fays7s8****
EndpointBusinessStatusstring

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

  • Normal:正常。

  • FinancialLocked:欠费锁定。

Normal
ServiceNamestring

终端节点关联的终端节点服务的名称。

com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****
Tagsobject []

标签列表。

Keystring

实例的标签键。

FinanceDept
Valuestring

实例的标签值。

FinanceJoshua
ResourceGroupIdstring

资源实例 ID。

1
NextTokenstring

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

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

请求 ID。

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

分页大小。

50
TotalCountinteger

总记录数。

12

示例

正常返回示例

JSON格式

{
  "Endpoints": [
    {
      "VpcId": "vpc-hp356stwkxg3fn2xe****",
      "EndpointName": "test",
      "EndpointType": "Interface",
      "CreateTime": "2021-09-24T18:00:07Z",
      "ServiceId": "epsrv-hp3vpx8yqxblby3i****",
      "ZoneAffinityEnabled": true,
      "EndpointDomain": "ep-hp33b2e43fays7s8****.epsrv-hp3xdsq46ael67lo****.cn-huhehaote.privatelink.aliyuncs.com",
      "EndpointStatus": "Active",
      "RegionId": "cn-huhehaote",
      "ResourceOwner": true,
      "Bandwidth": 1024,
      "ConnectionStatus": "Disconnected",
      "EndpointDescription": "This is my Endpoint.",
      "EndpointId": "ep-hp33b2e43fays7s8****",
      "EndpointBusinessStatus": "Normal",
      "ServiceName": "com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****",
      "Tags": [
        {
          "Key": "FinanceDept",
          "Value": "FinanceJoshua"
        }
      ],
      "ResourceGroupId": "1"
    }
  ],
  "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0",
  "MaxResults": 50,
  "TotalCount": 12
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-09-26OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-09-19OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    删除入参:PrivateDnsName
2023-09-05OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:PrivateDnsName
出参OpenAPI 返回结构发生变更
2023-03-02OpenAPI 描述信息更新、OpenAPI 返回结构发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
出参OpenAPI 返回结构发生变更
2022-07-26OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:Tag
    新增入参:ResourceGroupId
出参OpenAPI 返回结构发生变更
2021-03-17OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈