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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 ListVpcEndpoints

系统规定参数。取值：ListVpcEndpoints。

RegionId String 是 cn-huhehaote

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

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

NextToken String 否 caeba0bbb2be03f84eb48b699f0a4883

是否拥有下一次查询的令牌（Token）。取值：

  • 第一次查询和没有下一次查询时，均无需填写。
  • 如果有下一次查询，取值为上一次API调用返回的NextToken值。
MaxResults Integer 否 50

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

EndpointId String 否 ep-hp33b2e43fays7s8****

要查询的终端节点ID。
ServiceName String 否 com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****

要查询的终端节点关联的终端节点服务名称。
VpcId String 否 vpc-fdjkf789dfdfdfde****

终端节点所属的专有网络。
EndpointName String 否 test

终端节点名称。
EndpointType String 否 Interface

终端节点类型。

仅取值：Interface，表示ServiceId的服务资源类型为slb（传统型负载均衡CLB）的终端节点类型。

EndpointStatus String 否 Active

终端节点状态，取值：

  • Creating：创建中。
  • Active：可用。
  • Pending：修改中。
  • Deleting：删除中。
ConnectionStatus String 否 Disconnected

终端节点连接状态，取值：

  • Pending：修改中。
  • Connecting：连接中。
  • Connected：已连接。
  • Disconnecting：断开连接中。
  • Disconnected：未连接。
  • Deleting：删除中。
  • ServiceDeleted：终端节点对应的服务已删除。

返回数据

名称 类型 示例值 描述
Endpoints Array of Endpoint

终端节点信息集合。
VpcId String vpc-hp356stwkxg3fn2xe****

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

终端节点名称。
EndpointType String Interface

终端节点类型。

仅取值：Interface，表示ServiceId的服务资源类型为slb（传统型负载均衡CLB）的终端节点类型。

CreateTime String 2021-09-24T18:00:07Z

终端节点的创建时间。
ServiceId String epsrv-hp3vpx8yqxblby3i****

终端节点关联的终端节点服务的ID。
ZoneAffinityEnabled Boolean true

是否支持可用区就近解析，取值：

  • true：是。
  • false：否。
EndpointDomain String ep-hp33b2e43fays7s8****.epsrv-hp3xdsq46ael67lo****.cn-huhehaote.privatelink.aliyuncs.com

终端节点域名。
EndpointStatus String Active

终端节点状态，取值：

  • Creating：创建中。
  • Active：可用。
  • Pending：修改中。
  • Deleting：删除中。
RegionId String cn-huhehaote

终端节点所属的地域ID。
ResourceOwner Boolean true

终端节点和终端节点服务是否同一账号，取值：

  • true：是。
  • false：否。
Bandwidth Long 1024

终端节点的连接带宽，单位：Mbps。
ConnectionStatus String Disconnected

终端节点连接状态，取值：

  • Pending：修改中。
  • Connecting：连接中。
  • Connected：已连接。
  • Disconnecting：断开连接中。
  • Disconnected：未连接。
  • Deleting：删除中。
  • ServiceDeleted：终端节点对应的服务已删除。
EndpointDescription String This is my Endpoint.

终端节点描述。
EndpointId String ep-hp33b2e43fays7s8****

终端节点ID。
EndpointBusinessStatus String Normal

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

  • Normal：正常。
  • FinacialLocked：欠费锁定。
ServiceName String com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****

终端节点关联的终端节点服务的名称。
NextToken String caeba0bbb2be03f84eb48b699f0a****

是否拥有下一次查询的令牌（Token）。取值：

  • 如果NextToken为空表示没有下一次查询。
  • 如果NextToken有返回值，该取值表示下一次查询开始的令牌。
RequestId String 0ED8D006-F706-4D23-88ED-E11ED28DCAC0

请求ID。
MaxResults Integer 50

分页大小。

示例

请求示例

http(s)://[Endpoint]/?Action=ListVpcEndpoints
&RegionId=cn-huhehaote
&NextToken=caeba0bbb2be03f84eb48b699f0a4883
&MaxResults=50
&EndpointId=ep-hp33b2e43fays7s8****
&ServiceName=com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****
&VpcId=vpc-fdjkf789dfdfdfde****
&EndpointName=test
&EndpointType=Interface
&EndpointStatus=Active
&ConnectionStatus=Disconnected
&公共请求参数

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<ListVpcEndpointsResponse>
    <Endpoints>
        <VpcId>vpc-hp356stwkxg3fn2xe****</VpcId>
        <EndpointName>test</EndpointName>
        <EndpointType>Interface</EndpointType>
        <CreateTime>2021-09-24T18:00:07Z</CreateTime>
        <ServiceId>epsrv-hp3vpx8yqxblby3i****</ServiceId>
        <ZoneAffinityEnabled>true</ZoneAffinityEnabled>
        <EndpointDomain>ep-hp33b2e43fays7s8****.epsrv-hp3xdsq46ael67lo****.cn-huhehaote.privatelink.aliyuncs.com</EndpointDomain>
        <EndpointStatus>Active</EndpointStatus>
        <RegionId>cn-huhehaote</RegionId>
        <ResourceOwner>true</ResourceOwner>
        <Bandwidth>1024</Bandwidth>
        <ConnectionStatus>Disconnected</ConnectionStatus>
        <EndpointDescription>This is my Endpoint.</EndpointDescription>
        <EndpointId>ep-hp33b2e43fays7s8****</EndpointId>
        <EndpointBusinessStatus>Normal</EndpointBusinessStatus>
        <ServiceName>com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****</ServiceName>
    </Endpoints>
    <NextToken>caeba0bbb2be03f84eb48b699f0a****</NextToken>
    <RequestId>0ED8D006-F706-4D23-88ED-E11ED28DCAC0</RequestId>
    <MaxResults>50</MaxResults>
</ListVpcEndpointsResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/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****"
  } ],
  "NextToken" : "caeba0bbb2be03f84eb48b699f0a****",
  "RequestId" : "0ED8D006-F706-4D23-88ED-E11ED28DCAC0",
  "MaxResults" : 50
}

错误码

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