文档

DescribeSslVpnClients - 查询SSL-VPN连接的客户端的信息

更新时间:

调用DescribeSslVpnClients接口查询指定VPN网关实例下已与阿里云建立SSL-VPN连接的客户端的信息。

接口说明

如果您的 VPN 网关实例是在 2022 年 12 月 10 日之前创建的,则您需要将 VPN 网关实例升级至最新版才能查看 SSL 客户端的连接信息。具体操作,请参见升级 VPN 网关

2022 年 12 月 10 日之后创建的 VPN 网关实例默认支持查看 SSL 客户端的连接信息。

调试

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

授权信息

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

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

请求参数

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

VPN 网关实例所属的地域 ID。

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

eu-central-1
VpnGatewayIdstring

VPN 网关实例 ID。

vpn-gw8gfb947ctddabja****
PageNumberinteger

列表的页码。默认值:1

1
PageSizeinteger

分页查询时每页可显示的最大条目数。取值范围:1~50。默认值:10

10

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

885E117D-06A9-38A3-8DD2-40BDAC429FFC
VpnGatewayIdstring

VPN 网关实例 ID。

vpn-gw8gfb947ctddabja****
PageNumberinteger

列表的页码。

1
PageSizeinteger

分页查询时每页可显示的最大条目数。

10
TotalCountinteger

列表条目数。

1
RegionIdstring

VPN 网关实例所属的地域 ID。

eu-central-1
ClientInfoListobject []

客户端信息列表。

Statusstring

SSL-VPN 连接的状态。

取值:online,表示客户端和阿里云已成功建立 SSL-VPN 连接。

online
PrivateIpstring

客户端与阿里云建立 SSL-VPN 连接时,VPN 网关为客户端分配的私网 IP 地址。

10.10.10.10
SendByteslong

指 VPN 网关通过 SSL-VPN 连接向客户端发送的流量。单位:Byte。

57144
ConnectedTimelong

客户端与阿里云建立 SSL-VPN 连接时的时间戳。单位:毫秒。

时间戳的格式采用 Unix 时间戳,表示从格林威治时间 1970 年 01 月 01 日 00 时 00 分 00 秒至建立 SSL-VPN 连接时的总时长。

1670985008000
CommonNamestring

客户端与阿里云建立 SSL-VPN 连接时,使用的 SSL 客户端证书。

说明 如果客户端使用双因子认证功能与阿里云建立 SSL-VPN 连接,则当前参数的返回值为客户端的用户名。
CN=vsc-gw8gkh6gtilf1whgc****
Ipstring

客户端与阿里云建立 SSL-VPN 连接时,客户端实际使用的公网 IP 地址。

8.XX.XX.15
ReceiveByteslong

指 VPN 网关通过 SSL-VPN 连接从客户端接收的流量。单位:Byte。

60782
Portstring

客户端与阿里云建立 SSL-VPN 连接时,客户端实际使用的端口号。

4****

示例

正常返回示例

JSON格式

{
  "RequestId": "885E117D-06A9-38A3-8DD2-40BDAC429FFC",
  "VpnGatewayId": "vpn-gw8gfb947ctddabja****",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 1,
  "RegionId": "eu-central-1",
  "ClientInfoList": [
    {
      "Status": "online",
      "PrivateIp": "10.10.10.10",
      "SendBytes": 57144,
      "ConnectedTime": 1670985008000,
      "CommonName": "CN=vsc-gw8gkh6gtilf1whgc****",
      "Ip": "8.XX.XX.15",
      "ReceiveBytes": 60782,
      "Port": "4****"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400InvalidVpnGatewayInstanceId.NotFoundThe specified vpn gateway instance id does not exist.指定的 VPN 网关不存在,请您检查 VPN 网关是否正确。
400InvalidInstanceId.NotFoundThe specified instance id does not exist.-
403Forbbiden.SubUserUser not authorized to operate on the specified resource as your account is created by another user.您没有权限操作该资源,请您申请操作权限后再试。
403ForbiddenUser not authorized to operate on the specified resource.您没有权限操作指定资源,请申请权限后再操作。

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈