全部产品
Search

搜索本产品

    私网连接 PrivateLink：ListVpcEndpointZones - 查询终端节点可用区列表

    文档中心

    私网连接 PrivateLink：ListVpcEndpointZones - 查询终端节点可用区列表

    更新时间：Sep 26, 2024

    调用ListVpcEndpointZones接口，查询终端节点可用区列表。

    调试

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

    授权信息

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

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

    请求参数

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

    要查询的地域 ID。

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

    		cn-huhehaote
    NextTokenstring否

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

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

    分批次查询时每次显示的条目数。取值范围：1~1000，默认值：50。

    		50
    EndpointIdstring是

    要查询可用区的终端节点 ID。

    指定终端节点 ID 后，系统会查询该终端节点的可用区。

    		ep-hp33b2e43fays7s8****

    返回参数

    名称类型描述示例值
    object
    NextTokenstring

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

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

    请求 ID。

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

    分批次查询时每次显示的条目数。

    		50
    TotalCountinteger

    总记录数。

    		12
    Zonesarray<object>

    可用区信息集合。

    Zoneobject

    可用区信息。

    VSwitchIdstring

    可用区中的交换机，系统会自动在该交换机下创建一个终端节点网卡。

    		vsw-hjkshjvdkdvd****
    EniIpstring

    终端节点网卡的 IP 地址。

    		192.168.2.23
    ZoneStatusstring

    可用区状态，取值：

    • Creating：创建中。
    • Wait：等待连接。
    • Connected：已连接。
    • Deleting：删除中。
    • Disconnecting：断开连接中。
    • Disconnected：已断开。
    • Connecting：连接中。
    		Wait
    ZoneIdstring

    可用区 ID。

    		cn-huhehaote-a
    EniIdstring

    终端节点网卡 ID。

    		eni-hp3c8qj1tyct8aqy****
    ZoneDomainstring

    可用区域名。

    终端节点连接建立成功后，可以通过该可用区域名访问终端节点服务中的服务资源。

    		ep-hp3f033dp24c5yc9****-cn-huhehaote.epsrv-hp3itcpowf37m3d5****.cn-huhehaote-a.privatelink.aliyuncs.com
    RegionIdstring

    终端节点所属的地域 ID。

    		cn-huhehaote
    ZoneIpv6Addressstring

    终端节点服务是否支持 IPv6 功能。取值：

    • true：是。
    • false（默认值）：否。
    		false

    示例

    正常返回示例

    JSON格式

    {
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0",
  "MaxResults": 50,
  "TotalCount": 12,
  "Zones": [
    {
      "VSwitchId": "vsw-hjkshjvdkdvd****",
      "EniIp": "192.168.2.23",
      "ZoneStatus": "Wait",
      "ZoneId": "cn-huhehaote-a",
      "EniId": "eni-hp3c8qj1tyct8aqy****",
      "ZoneDomain": "ep-hp3f033dp24c5yc9****-cn-huhehaote.epsrv-hp3itcpowf37m3d5****.cn-huhehaote-a.privatelink.aliyuncs.com",
      "RegionId": "cn-huhehaote",
      "ZoneIpv6Address": "false"
    }
  ]
}

    错误码

    HTTP status code错误码错误信息描述
    400EndpointNotFoundThe specified Endpoint does not exist.当前终端节点未找到。

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

    变更历史

    变更时间变更内容概要操作
    2024-03-20OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
    2023-08-25OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
    2022-07-18OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
    2022-06-28OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
    2021-03-17OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情