文档

ListVpcEndpointConnections - 查询终端节点连接

更新时间:

调用ListVpcEndpointConnections接口,查询终端节点连接。

调试

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

授权信息

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

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

请求参数

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

要查询的终端节点连接的地域 ID。

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

cn-huhehaote
NextTokenstring

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

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

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

50
ServiceIdstring

终端节点服务 ID。

epsrv-hp3vpx8yqxblby3i****
EniIdstring

终端节点网卡 ID。

eni-hp32lk0pyv6o94hs****
EndpointIdstring

终端节点 ID。

ep-hp33b2e43fays7s8****
ConnectionStatusstring

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

  • Pending:修改中。

  • Connecting:连接中。

  • Connected:已连接。

  • Disconnecting:断开连接中。

  • Disconnected:未连接。

  • Deleting:删除中。

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

Disconnected
EndpointOwnerIdlong

终端节点所属的账号 ID。

25346073170691****
ResourceIdstring

服务资源 ID。

lb-hp32z1wp5peaoox2q****
ReplacedResourceIdstring

平滑迁移场景下被替换的服务资源 ID。

lb-hp32z1wp5peaoox2q****
ResourceGroupIdstring

要查询的终端节点所属的资源组 ID。

rg-acfmy*****

返回参数

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

终端节点连接信息。

Zonesobject []

可用区信息。

VSwitchIdstring

终端节点所属的交换机。

vsw-hp3uf6045ljdhd5zr****
ZoneIdstring

可用区 ID。

cn-huhehaote-b
ResourceIdstring

服务资源 ID。

lb-hp32z1wp5peaoox2q****
EniIdstring

终端节点网卡 ID。

eni-hp32lk0pyv6o94hs****
ZoneDomainstring

可用区域名。

ep-hp34jaz8ykl0exwt****-cn-huhehaote.epsrv-hp3vpx8yqxblby3i****.cn-huhehaote-b.privatelink.aliyuncs.com
ZoneStatusstring

可用区的状态。取值:

  • Creating:创建中。
  • Wait:等待连接。
  • Connected:已连接。
  • Deleting:删除中。
  • Disconnecting:断开连接中。
  • Disconnected:已断开。
  • Connecting:连接中。
  • Migrating:迁移中。
  • Migrated:已迁移。
Connected
ReplacedResourceIdstring

平滑迁移场景下被替换的服务资源 ID。

lb-hp32z1wp5peaoox2q****
ReplacedEniIdstring

平滑迁移场景下被替换的终端节点网卡 ID。

eni-hp32lk0pyv6o94hs****
ModifiedTimestring

连接修改时间。

2021-09-28T10:34:46Z
Bandwidthinteger

终端节点连接的连接带宽,单位:Mbps。取值范围:1024~10240

1024
EndpointOwnerIdlong

终端节点所属的账号 ID。

25346073170691****
ResourceOwnerboolean

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

  • true:是。

  • false:否。

true
ServiceIdstring

终端节点服务的 ID。

epsrv-hp3vpx8yqxblby3i****
ConnectionStatusstring

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

  • Pending:修改中。

  • Connecting:连接中。

  • Connected:已连接。

  • Disconnecting:断开连接中。

  • Disconnected:未连接。

  • Deleting:删除中。

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

Disconnected
EndpointIdstring

终端节点 ID。

ep-hp33b2e43fays7s8****
EndpointVpcIdstring

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

vpc-hp356stwkxg3fn2xe****
ResourceGroupIdstring

终端节点所属的资源组 ID。

rg-acfmw353z35v***
NextTokenstring

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

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

请求 ID。

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

分页大小。

50
TotalCountstring

查询到的终端节点连接列表条目数。

1

示例

正常返回示例

JSON格式

{
  "Connections": [
    {
      "Zones": [
        {
          "VSwitchId": "vsw-hp3uf6045ljdhd5zr****",
          "ZoneId": "cn-huhehaote-b",
          "ResourceId": "lb-hp32z1wp5peaoox2q****",
          "EniId": "eni-hp32lk0pyv6o94hs****",
          "ZoneDomain": "ep-hp34jaz8ykl0exwt****-cn-huhehaote.epsrv-hp3vpx8yqxblby3i****.cn-huhehaote-b.privatelink.aliyuncs.com",
          "ZoneStatus": "Connected",
          "ReplacedResourceId": "lb-hp32z1wp5peaoox2q****",
          "ReplacedEniId": "eni-hp32lk0pyv6o94hs****"
        }
      ],
      "ModifiedTime": "2021-09-28T10:34:46Z",
      "Bandwidth": 1024,
      "EndpointOwnerId": 0,
      "ResourceOwner": true,
      "ServiceId": "epsrv-hp3vpx8yqxblby3i****",
      "ConnectionStatus": "Disconnected",
      "EndpointId": "ep-hp33b2e43fays7s8****",
      "EndpointVpcId": "vpc-hp356stwkxg3fn2xe****",
      "ResourceGroupId": "rg-acfmw353z35v***"
    }
  ],
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0",
  "MaxResults": 50,
  "TotalCount": "1"
}

错误码

HTTP status code错误码错误信息描述
400EndpointServiceNotFoundThe specified Service does not exist.当前终端节点服务不存在

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

变更历史

变更时间变更内容概要操作
2023-09-27OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
入参OpenAPI 入参发生变更
    删除入参:ConnectionId
出参OpenAPI 返回结构发生变更
2023-09-19OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
2023-03-02OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更
2022-09-20OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
入参OpenAPI 入参发生变更
    新增入参:ResourceGroupId
出参OpenAPI 返回结构发生变更
2022-01-06OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈