You need to enable JavaScript to run this app.
文档中心
私网连接

私网连接

复制全文
下载 pdf
终端节点连接
DescribeVpcEndpointConnections - 查询终端节点连接的列表
复制全文
下载 pdf
DescribeVpcEndpointConnections - 查询终端节点连接的列表
调用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 Object[] 示例值:-​
终端节点连接的详细信息。​
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:连接失败。​
  • PartialFailed:部分连接失败。​
  • ServiceDeleted:服务已删除。​
​
Bps Integer 示例值:1000​
终端节点连接的带宽上限,单位为Mbps。​
​
Zones Object[] 示例值:-​
终端节点可用区的详细信息。​
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。​
若处于平滑更换服务资源期间,则表示与被更换服务资源连接的终端节点网卡的ID。​
​
NetworkInterfaceIP String 示例值:192.XX.XX.1​
终端节点网卡的私网IPv4地址。​
若处于平滑更换服务资源期间,则表示与被更换服务资源连接的终端节点网卡的IPv4。​
​
NetworkInterfaceIpv6 String 示例值:2408::153:3921:XX:XX:7b12:1c5f​
终端节点网卡的私网IPv6地址。​
若处于平滑更换服务资源期间,则表示与被更换服务资源连接的终端节点网卡的IPv6地址。​
终端节点仅支持IPv4时,不返回该参数。​
​
ResourceId String 示例值:clb-bp1o94dp5i6ea****​
服务资源的ID。​
若处于平滑更换服务资源期间,则表示被更换服务资源。​
​
ReplacingResource Boolean 示例值:true​
是否正在平滑更换中。​
  • true​
  • false​
​
ReplacedResourceId String 示例值:clb-w2q642dr1ge5a****​
新的服务资源ID。​
如未处于平滑更换服务资源期间,则该参数返回空。​
​
ReplacedNetworkInterfaceId String 示例值:eni-273w2q67fwq9s7fap8t1a****​
用于连接新服务资源的终端节点网卡的ID。​
如未处于平滑更换服务资源期间,则该参数返回空。​
​
ReplacedNetworkInterfaceIp String 示例值:192.XX.XX.1​
用于连接新服务资源的终端节点网卡的IPv4地址。​
如未处于平滑更换服务资源期间,则该参数返回空。​
​
ReplacedNetworkInterfaceIpv6 String 示例值:2408::153:3921:XX:XX:7b12:1c5f​
用于连接新服务资源的终端节点网卡的IPv6地址。​
如未处于平滑更换服务资源期间,则该参数返回空。​
​
​
CreationTime String 示例值:2021-04-09T08:36:47+08:00​
终端节点连接的创建时间。​
​
UpdateTime String 示例值:2021-04-09T08:36:47+08:00​
终端节点连接的最近操作时间。​
​
​
​
​
请求示例​
​
GET /?Action=DescribeVpcEndpointConnections&Version=2020-04-01&EndpointId=ep-273yuq6q7bgn47fap8squ****&ServiceId=epsvc-2fe630gurkl37k5gfuy33**** HTTP/1.1​
Host: privatelink.cn-guangzhou.volcengineapi.com​
X-Date: 20251121T094038Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251121/cn-guangzhou/privatelink/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20230604110420****100232280022D31",​
"Action": "DescribeVpcEndpointConnections",​
"Version": "2020-04-01",​
"Service": "privatelink",​
"Region": "cn-guangzhou"​
},​
"Result": {​
"EndpointConnections": [​
{​
"Bps": 1000,​
"Zones": [​
{​
"ZoneId": "cn-guangzhou-a",​
"SubnetId": "subnet-2744ts087kglc7fap8tu6****",​
"ResourceId": "clb-bp1o94dp5i6ea****",​
"ZoneDomain": "ep-273yuq6q7bgn47fap8squ****.cn-guangzhou-a.epsvc-273yuqembrojk7fap8sbf****.cn-guangzhou.privatelink.volces.com",​
"ZoneStatus": "Connected",​
"ReplacingResource": true,​
"NetworkInterfaceIP": "192.XX.XX.1",​
"NetworkInterfaceId": "eni-273w2q67fwq9s7fap8t1a****",​
"ReplacedResourceId": "clb-w2q642dr1ge5a****",​
"NetworkInterfaceIpv6": "2408::153:3921:XX:XX:7b12:1c5f",​
"ReplacedNetworkInterfaceId": "eni-273w2q67fwq9s7fap8t1a****",​
"ReplacedNetworkInterfaceIp": "192.XX.XX.1",​
"ReplacedNetworkInterfaceIpv6": "2408::153:3921:XX:XX:7b12:1c5f"​
}​
],​
"ServiceId": "epsvc-2fe630gurkl37k5gfuy33****",​
"EndpointId": "ep-273yuq6q7bgn47fap8squ****",​
"UpdateTime": "2021-04-09T08:36:47+08:00",​
"CreationTime": "2021-04-09T08:36:47+08:00",​
"EndpointVpcId": "vpc-2744trcju7sw07fap8u05****",​
"ConnectionStatus": "Connecting",​
"EndpointOwnerAccountId": "21000****"​
}​
],​
"PageNumber": 1,​
"PageSize": 10,​
"RequestId": "0ED8D006-F706-4D23-88ED-E11ED28D****",​
"TotalCount": 2​
}​
}​
​
错误码​
此处仅展示当前API的错误码,更多错误码请参见公共错误码。​
​
状态码​
错误码​
错误信息​
说明​
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.​
指定的分页参数格式不合法。​
400​
InvalidParameter.BatchQueryForFuzzySearch​
Batch query parameters and precise search parameters are passed in at the same time.​
批量查询参数与精确搜索参数不允许同时传入。​
400​
LimitExceed.EndpointNumber​
You've reached the limit on the number of endpoints that you can operate.​
已达到单次可查询终端节点的数量上限。​
404​
InvalidEndpointService.NotFound​
The specified EndpointService does not exist.​
指定的终端节点服务不存在。​
404​
InvalidEndpoint.NotFound​
The specified endpoint does not exist.​
指定的终端节点不存在。​
​
​
最近更新时间:2026.10.26 15:10:41
这个页面对您有帮助吗?
有用
有用
无用
无用