You need to enable JavaScript to run this app.
导航
私网连接
  • 文档首页
    • /
  • 私网连接

DescribeVpcEndpointZones

最近更新时间：2024.04.22 16:36:17

首次发布时间：2023.03.17 21:09:38

我的收藏

调用DescribeVpcEndpointZones接口，查询指定终端节点已添加的可用区。

调试

API Explorer
您可以通过API Explorer在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

名称类型是否必选示例值描述
ActionString是DescribeVpcEndpointZones要执行的操作，取值为DescribeVpcEndpointZones。
VersionString是2020-04-01API版本信息，当前版本为2020-04-01。
EndpointIdString是ep-273yuq6q7bgn47fap8squ****终端节点的ID。您可以调用DescribeVpcEndpoints接口获取终端节点的ID。
PageNumberInteger否1列表的页码。默认值为1。
PageSizeInteger否10分页查询时每页的行数。最大值为100，默认值为10。

返回数据

名称类型示例值描述
RequestIdString0ED8D006-F706-4D23-88ED-E11ED28D****请求ID。
PageNumberInteger1当前页码。
PageSizeInteger10当前分页的行数。
TotalCountInteger2符合条件的终端节点服务总数。
EndpointZonesArray of Struct-终端节点可用区的详细信息。具体请参见下表“EndpointZones”。

EndpointZones

名称类型示例值描述
ZoneIdStringcn-guangzhou-a终端节点可用区的ID。
ZoneDomainStringep-273yuq6q7bgn47fap8squ****.cn-guangzhou-a.epsvc-273yuqembrojk7fap8sbf****.cn-guangzhou.privatelink.volces.com终端节点可用区的域名。格式为<终端节点ID>.<可用区ID>.<终端节点服务ID>.<地域ID>.privatelink.volces.com。

ZoneStatus

String

Connected

终端节点可用区的状态。

  • PendingAcceptance：等待连接。
  • Connecting：连接中。
  • Connected：已连接。
  • Disconnecting：断开连接中。
  • Rejected：拒绝连接。
  • Failed：连接失败。

ServiceStatus

String

Available

终端节点服务的状态。

  • Creating：创建中。
  • Pending：配置修改中。
  • Active：可用。
  • Deleting：删除中。
  • Inactive：不可用。
SubnetIdStringsubnet-2744ts087kglc7fap8tu6****终端节点网卡所属子网的ID。
NetworkInterfaceIdStringeni-273w2q67fwq9s7fap8t1a****终端节点网卡的ID。
NetworkInterfaceIPString192.XX.XX.1终端节点网卡的私网IP地址。

请求示例

GET /?Action=DescribeVpcEndpointZones&Version=2020-04-01&EndpointId=ep-273yuq6q7bgn47fap8squ**** HTTP/1.1
Host: open.volcengineapi.com
Service: privatelink
Region: cn-guangzhou

返回示例

{
    "ResponseMetadata": {
        "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28D****",
        "Action": "DescribeVpcEndpointZones",
        "Version": "2020-04-01",
        "Service": "privatelink",
        "Region": "cn-guangzhou"
    },
    "Result": {
        "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28D****",
        "PageNumber": 1,
        "PageSize": 10,  
        "TotalCount": 2,
        "EndpointZones": [
            {
                "ZoneId": "cn-guangzhou-a",
                "ZoneDomain": "ep-273yuq6q7bgn47fap8squ****.cn-guangzhou.epsvc-273yuqembrojk7fap8sbf****.cn-guangzhou.privatelink.volces.com",
                "ZoneStatus": "Connected",
                "ServiceStatus": "Active",
                "SubnetId": "subnet-2744ts087kglc7fap8tu6****",
                "NetworkInterfaceId": "eni-273w2q67fwq9s7fap8t1a****",
                "NetworkInterfaceIP": "192.XX.XX.1"
            }
        ]
    }
}

错误码

此处仅展示当前API的错误码，更多错误码请参见公共错误码。

HttpCode错误码错误信息描述

400

MissingParameter

The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, the 'XXX'.

该请求缺少必要参数。请确保发起请求已提供全部必要参数，比如XXX。

说明

其中，XXX表示缺少的参数名称。

400InvalidPaging.MalformedThe specified PageNumber or PageSize is malformed.指定的分页参数格式不合法。
404InvalidEndpoint.NotFoundThe specified endpoint does not exist.指定的终端节点不存在。