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

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

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

privatelink:ListVpcEndpoints

get

*VpcEndpoint

acs:privatelink:{#regionId}:{#accountId}:vpcendpoint/{#EndpointId}

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	要查询的终端节点所属的地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。	cn-huhehaote
NextToken	string	否	是否拥有下一次查询的令牌（Token）。取值：第一次查询和没有下一次查询时，均无需填写。如果有下一次查询，取值为上一次 API 调用返回的 NextToken 值。	caeba0bbb2be03f84eb48b699f0a4883
MaxResults	integer	否	分页大小。取值范围：1~1000。默认值：50。	50
EndpointId	string	否	要查询的终端节点 ID。	ep-hp33b2e43fays7s8****
ServiceName	string	否	要查询的终端节点关联的终端节点服务名称。	com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****
VpcId	string	否	终端节点所属的专有网络。	vpc-fdjkf789dfdfdfde****
EndpointName	string	否	终端节点名称。	test
EndpointType	string	否	终端节点类型。取值： Interface：表示接口终端节点。 Reverse：表示反向终端节点。 GatewayLoadBalancer：表示网关型负载均衡终端节点。	Interface
EndpointStatus	string	否	终端节点状态，取值： Creating：创建中。 Active：可用。 Pending：修改中。 Deleting：删除中。	Active
ConnectionStatus	string	否	终端节点连接状态，取值： Pending：修改中。 Connecting：连接中。 Connected：已连接。 Disconnecting：断开连接中。 Disconnected：未连接。 Deleting：删除中。 ServiceDeleted：终端节点对应的服务已删除。	Disconnected
Tag	array<object>	否	标签列表。
	object	否	标签。
Key	string	否	实例的标签键。最多支持 20 个标签键。一旦传入该值，则不允许为空字符串。最多支持 64 个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。	FinanceDept
Value	string	否	实例的标签值。最多支持 20 个标签值。一旦传入该值，可以为空字符串。最多支持 128 个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。	FinanceJoshua
RegionId	string	是	要查询的终端节点所属的地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。	cn-huhehaote
ResourceGroupId	string	否	资源组 ID。	1
AddressIpVersion	string	否	协议版本。取值： IPv4：IPv4 类型。 DualStack：双栈类型。	IPv4
ServiceRegionId	string	否

返回参数

名称	类型	描述	示例值
	object
Endpoints	array<object>	终端节点信息集合。
	array<object>	终端节点信息集合。
VpcId	string	终端节点所属的专有网络。	vpc-hp356stwkxg3fn2xe****
EndpointName	string	终端节点名称。	test
EndpointType	string	终端节点类型。取值： Interface：表示接口终端节点。 Reverse：表示反向终端节点。 GatewayLoadBalancer：表示网关型负载均衡终端节点。	Interface
CreateTime	string	终端节点的创建时间。	2021-09-24T18:00:07Z
ServiceId	string	终端节点关联的终端节点服务的 ID。	epsrv-hp3vpx8yqxblby3i****
ZoneAffinityEnabled	boolean	是否支持连接服务的终端节点域名就近解析。取值： true：是。 false：否。	true
EndpointDomain	string	终端节点域名。	ep-hp33b2e43fays7s8**.epsrv-hp3xdsq46ael67lo**.cn-huhehaote.privatelink.aliyuncs.com
EndpointStatus	string	终端节点状态，取值： Creating：创建中。 Active：可用。 Pending：修改中。 Deleting：删除中。	Active
RegionId	string	终端节点所属的地域 ID。	cn-huhehaote
ResourceOwner	boolean	终端节点和终端节点服务是否同一账号，取值： true：是。 false：否。	true
Bandwidth	integer	终端节点的连接带宽，单位：Mbps。	1024
ConnectionStatus	string	终端节点连接状态，取值： Pending：修改中。 Connecting：连接中。 Connected：已连接。 Disconnecting：断开连接中。 Disconnected：未连接。 Deleting：删除中。 ServiceDeleted：终端节点对应的服务已删除。	Disconnected
EndpointDescription	string	终端节点描述。	This is my Endpoint.
EndpointId	string	终端节点 ID。	ep-hp33b2e43fays7s8****
EndpointBusinessStatus	string	终端节点的业务状态。取值： Normal：正常。 FinancialLocked：欠费锁定。	Normal
ServiceName	string	终端节点关联的终端节点服务的名称。	com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****
Tags	array<object>	标签列表。
	object	标签列表。
Key	string	实例的标签键。	FinanceDept
Value	string	实例的标签值。	FinanceJoshua
ResourceGroupId	string	资源实例 ID。	1
PolicyDocument	string	RAM 权限策略。关于策略定义的更多信息，请参见权限策略基本元素。	{\n \"Version\": \"1\",\n \"Statement\": [\n {\n \"Effect\": \"Allow\",\n \"Action\": \"\",\n \"Principal\": \"\",\n \"Resource\": \"*\"\n }\n ]\n}
AddressIpVersion	string	协议版本。取值： IPv4：IPv4 类型。 DualStack：双栈类型。	IPv4
ServiceRegionId	string
CrossRegionBandwidth	integer
NextToken	string	是否拥有下一次查询的令牌（Token）。取值：如果 NextToken 为空表示没有下一次查询。如果 NextToken 有返回值，该取值表示下一次查询开始的令牌。	caeba0bbb2be03f84eb48b699f0a****
RequestId	string	请求 ID。	0ED8D006-F706-4D23-88ED-E11ED28DCAC0
MaxResults	integer	分页大小。	50
TotalCount	integer	总记录数。	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",
      "PolicyDocument": "{\\n  \\\"Version\\\": \\\"1\\\",\\n  \\\"Statement\\\": [\\n    {\\n      \\\"Effect\\\": \\\"Allow\\\",\\n      \\\"Action\\\": \\\"*\\\",\\n      \\\"Principal\\\": \\\"*\\\",\\n      \\\"Resource\\\": \\\"*\\\"\\n    }\\n  ]\\n}",
      "AddressIpVersion": "IPv4",
      "ServiceRegionId": "",
      "CrossRegionBandwidth": 0
    }
  ],
  "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0",
  "MaxResults": 50,
  "TotalCount": 12
}

错误码

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

变更历史

更多信息，参考变更详情。