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

文档中心

立即注册

导航

DescribeVpcEndpointConnections

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

调用DescribeVpcEndpointConnections接口，查询满足指定条件的终端节点连接列表。

调试

API Explorer

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

去调试

请求参数

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

返回数据

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

EndpointConnections

名称	类型	示例值	描述
ServiceId	String	epsvc-2fe630gurkl37k5gfuy33****	终端节点连接关联的终端节点服务的ID。
EndpointId	String	ep-273yuq6q7bgn47fap8squ****	终端节点连接关联的终端节点的ID。
EndpointOwnerAccountId	String	21000****	终端节点所属账号ID。
EndpointVpcId	String	vpc-2744trcju7sw07fap8u05****	终端节点网卡所属VPC的ID。
ConnectionStatus	String	Connecting	终端节点连接的状态。 PendingAcceptance：等待连接。 Connecting：连接中。 Connected：已连接。 Disconnecting：断开连接中。 Rejected：拒绝连接。 Failed：连接失败。
Zones	Array of Struct	-	终端节点可用区的详细信息。具体请参见下表“Zones”。
CreationTime	String	2021-04-09T08:36:47+08:00	终端节点连接的创建时间。
UpdateTime	String	2021-04-09T08:36:47+08:00	终端节点连接的最近操作时间。

Zones

名称	类型	示例值	描述
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：连接失败。
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时，不返回该参数。
ResourceId	String	clb-bp1o94dp5i6ea****	服务资源的ID。

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28D****",
        "Action": "DescribeVpcEndpointConnections",
        "Version": "2020-04-01",
        "Service": "privatelink",
        "Region": "cn-guangzhou"
    },
    "Result": {
        "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28D****",
        "EndpointConnections": [
            {
                "ServiceId": "epsvc-2fe630gurkl37k5gfuy33****",
                "EndpointId": "ep-273yuq6q7bgn47fap8squ****",
                "EndpointOwnerAccountId": "21000****",
                "EndpointVpcId": "vpc-2744trcju7sw07fap8u05****",
                "ConnectionStatus": "Connected",
                "Zones": [
                    {
                        "ZoneId": "cn-guangzhou-a",
                        "ZoneDomain": "ep-2fewhlxhtuf4059gp671d****-cn-guangzhou-a.epsvc-2fenyln10m5fk59gp67bomdvq.cn-guangzhou.privatelink.volces.com",
                        "ZoneStatus": "Connected",
                        "SubnetId": "subnet-12ahgew2hapkw17q7y36u****",
                        "NetworkInterfaceId": "eni-12ahz6sxl4wzk17q7y2lq****",
                        "NetworkInterfaceIP": "192.168.0.88",
                        "NetworkInterfaceIpv6": "2408::153:3921:XX:XX:7b12:1c5f",
                        "ResourceId": "clb-imccfaszf4sg8gbssxtu****"
                    }
                ],
                "CreationTime": "2021-04-09T08:36:47+08:00",
                "UpdateTime": "2021-04-09T08:36:47+08:00"
            }
        ]
    }
}

错误码

此处仅展示当前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	InvalidEndpointService.NotFound	The specified EndpointService does not exist.	指定的终端节点服务不存在。
404	InvalidEndpoint.NotFound	The specified endpoint does not exist.	指定的终端节点不存在。