调用ListVpcEndpointConnections查询终端节点连接-私网连接-阿里云

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

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

privatelink:ListVpcEndpointConnections

list

*VpcEndpointService

acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/{#ServiceId}

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	要查询的终端节点连接的地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。	cn-huhehaote
NextToken	string	否	是否拥有下一次查询的令牌（Token）。取值：第一次查询和没有下一次查询时，均无需填写。如果有下一次查询，取值为上一次 API 调用返回的 NextToken 值。	caeba0bbb2be03f84eb48b699f0a4883
MaxResults	integer	否	分页大小。取值范围：1~1000。默认值：50。	50
ServiceId	string	否	终端节点服务 ID。	epsrv-hp3vpx8yqxblby3i****
EniId	string	否	终端节点网卡 ID。	eni-hp32lk0pyv6o94hs****
EndpointId	string	否	终端节点 ID。	ep-hp33b2e43fays7s8****
ConnectionStatus	string	否	终端节点连接状态，取值： Pending：修改中。 Connecting：连接中。 Connected：已连接。 Disconnecting：断开连接中。 Disconnected：未连接。 Deleting：删除中。 ServiceDeleted：对应的终端节点服务已删除。	Disconnected
EndpointOwnerId	integer	否	终端节点所属的账号 ID。	25346073170691****
ResourceId	string	否	服务资源 ID。	lb-hp32z1wp5peaoox2q****
ReplacedResourceId	string	否	平滑迁移场景下被替换的服务资源 ID。	lb-hp32z1wp5peaoox2q****
RegionId	string	是	要查询的终端节点连接的地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。	cn-huhehaote
ResourceGroupId	string	否	要查询的终端节点所属的资源组 ID。	rg-acfmy*****

返回参数

名称	类型	描述	示例值
	object
Connections	array<object>	终端节点连接信息。
	array<object>	终端节点连接信息。
Zones	array<object>	可用区信息。
	object	可用区信息。
VSwitchId	string	终端节点所属的交换机。	vsw-hp3uf6045ljdhd5zr****
ZoneId	string	可用区 ID。	cn-huhehaote-b
ResourceId	string	服务资源 ID。	lb-hp32z1wp5peaoox2q****
EniId	string	终端节点网卡 ID。	eni-hp32lk0pyv6o94hs****
ZoneDomain	string	可用区域名。	ep-hp34jaz8ykl0exwt**-cn-huhehaote.epsrv-hp3vpx8yqxblby3i**.cn-huhehaote-b.privatelink.aliyuncs.com
ZoneStatus	string	可用区的状态。取值： Creating：创建中。 Wait：等待连接。 Connected：已连接。 Deleting：删除中。 Disconnecting：断开连接中。 Disconnected：已断开。 Connecting：连接中。 Migrating：迁移中。 Migrated：已迁移。	Connected
ReplacedResourceId	string	平滑迁移场景下被替换的服务资源 ID。	lb-hp32z1wp5peaoox2q****
ReplacedEniId	string	平滑迁移场景下被替换的终端节点网卡 ID。	eni-hp32lk0pyv6o94hs****
ModifiedTime	string	连接修改时间。	2021-09-28T10:34:46Z
Bandwidth	integer	终端节点连接的连接带宽，单位：Mbps。取值范围：100~10240。说明服务资源为传统型负载均衡 CLB 时，终端节点的连接带宽取值范围为100~10240，默认为 3072Mbps。网络型负载均衡 NLB 不支持限速。	3072
EndpointOwnerId	integer	终端节点所属的账号 ID。	25346073170691****
ResourceOwner	boolean	终端节点和终端节点服务是否同一账号，取值： true：是。 false：否。	true
ServiceId	string	终端节点服务的 ID。	epsrv-hp3vpx8yqxblby3i****
ConnectionStatus	string	终端节点连接状态，取值： Pending：修改中。 Connecting：连接中。 Connected：已连接。 Disconnecting：断开连接中。 Disconnected：未连接。 Deleting：删除中。 ServiceDeleted：对应的终端节点服务已删除。	Disconnected
EndpointId	string	终端节点 ID。	ep-hp33b2e43fays7s8****
EndpointVpcId	string	终端节点所属的专有网络。	vpc-hp356stwkxg3fn2xe****
ResourceGroupId	string	终端节点所属的资源组 ID。	rg-acfmw353z35v***
NextToken	string	是否拥有下一次查询的令牌（Token）。取值：如果 NextToken 为空表示没有下一次查询。如果 NextToken 有返回值，该取值表示下一次查询开始的令牌。	caeba0bbb2be03f84eb48b699f0a4883
RequestId	string	请求 ID。	0ED8D006-F706-4D23-88ED-E11ED28DCAC0
MaxResults	integer	分页大小。	50
TotalCount	string	查询到的终端节点连接列表条目数。	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": 3072,
      "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	错误码	错误信息	描述
400	EndpointServiceNotFound	The specified Service does not exist.	当前终端节点服务不存在

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

ListVpcEndpointConnections - 查询终端节点连接

调试

授权信息

请求参数

返回参数

示例

错误码

变更历史