调用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:DescribeSslVpnClients | list | *VpnGateway acs:vpc:{#regionId}:{#accountId}:vpngateway/{#VpnGatewayId} |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | VPN 网关实例所属的地域 ID。 您可以通过调用 DescribeRegions 接口获取地域 ID。 | eu-central-1 |
| VpnGatewayId | string | 是 | VPN 网关实例 ID。 | vpn-gw8gfb947ctddabja**** |
| PageNumber | integer | 否 | 列表的页码。默认值：1。 | 1 |
| PageSize | integer | 否 | 分页查询时每页可显示的最大条目数。取值范围：1~50。默认值：10。 | 10 |
返回参数
示例
正常返回示例
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 | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidVpnGatewayInstanceId.NotFound | The specified vpn gateway instance id does not exist. | 指定的 VPN 网关不存在，请您检查 VPN 网关是否正确。 |
| 400 | InvalidInstanceId.NotFound | The specified instance id does not exist. | 指定的实例ID不存在。 |
| 403 | Forbbiden.SubUser | User not authorized to operate on the specified resource as your account is created by another user. | 您没有权限操作该资源，请您申请操作权限后再试。 |
| 403 | Forbidden | User not authorized to operate on the specified resource. | 您没有权限操作指定资源，请申请权限后再操作。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|
暂无变更历史