DescribeVpcEndpointZones--私网连接-火山引擎

文档中心

立即注册

导航

DescribeVpcEndpointZones

最近更新时间：2024.06.05 10:05:18首次发布时间：2023.03.17 21:09:38

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

调试

API Explorer

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

去调试

请求参数

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

返回数据

名称	类型	示例值	描述
RequestId	String	0ED8D006-F706-4D23-88ED-E11ED28D****	请求ID。
PageNumber	Integer	1	当前页码。
PageSize	Integer	10	当前分页的行数。
TotalCount	Integer	2	符合条件的终端节点服务总数。
EndpointZones	Array of Struct	-	终端节点可用区的详细信息。具体请参见下表“EndpointZones”。

EndpointZones

名称	类型	示例值	描述
ZoneId	String	cn-guangzhou-a	终端节点可用区的ID。
ZoneDomain	String	ep-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	Active	终端节点IPv4地址的服务状态。 Active：正常。 Inactive：异常。
Ipv6ServiceStatus	String	Active	终端节点IPv6地址的服务状态。 Active：正常。 Inactive：异常。说明终端节点仅支持IPv4时，不返回该参数。
SubnetId	String	subnet-2744ts087kglc7fap8tu6****	终端节点网卡所属子网的ID。
NetworkInterfaceId	String	eni-273w2q67fwq9s7fap8t1a****	终端节点网卡的ID。
NetworkInterfaceIP	String	192.XX.XX.1	终端节点网卡的私网IPv4地址。
NetworkInterfaceIpv6	String	2408::153:3921:XX:XX:7b12:1c5f	终端节点网卡的私网IPv6地址。说明终端节点仅支持IPv4时，不返回该参数。

请求示例

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表示缺少的参数名称。
400	InvalidPaging.Malformed	The specified PageNumber or PageSize is malformed.	指定的分页参数格式不合法。
404	InvalidEndpoint.NotFound	The specified endpoint does not exist.	指定的终端节点不存在。