DescribeSslVpnClients - VPN Gateway

呼叫 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

返回參數

名稱	類型	描述	樣本值
	object	返回結果。
RequestId	string	請求 ID。	885E117D-06A9-38A3-8DD2-40BDAC429FFC
VpnGatewayId	string	VPN 閘道執行個體 ID。	vpn-gw8gfb947ctddabja****
PageNumber	integer	列表的頁碼。	1
PageSize	integer	分頁查詢時每頁可顯示的最大條目數。	10
TotalCount	integer	列表條目數。	1
RegionId	string	VPN 閘道執行個體所屬的地域 ID。	eu-central-1
ClientInfoList	array<object>	用戶端資訊列表。
	object	用戶端資訊。
Status	string	SSL-VPN 連線的狀態。取值：online，表示用戶端和阿里雲已成功建立 SSL-VPN 連線。	online
PrivateIp	string	用戶端與阿里雲建立 SSL-VPN 連線時，VPN 閘道為用戶端分配的私網 IP 位址。	10.10.10.10
SendBytes	integer	指 VPN 閘道透過 SSL-VPN 連線向用戶端傳送的流量。單位：Byte。	57144
ConnectedTime	integer	用戶端與阿里雲建立 SSL-VPN 連線時的時間戳記。單位：毫秒。時間戳記的格式採用 Unix 時間戳記，表示從格林威治時間 1970 年 01 月 01 日 00 時 00 分 00 秒至建立 SSL-VPN 連線時的總時長。	1670985008000
CommonName	string	用戶端與阿里雲建立 SSL-VPN 連線時，使用的 SSL 用戶端憑證。說明如果用戶端使用雙因子認證功能與阿里雲建立 SSL-VPN 連線，則當前參數的返回值為用戶端的使用者名稱。	CN=vsc-gw8gkh6gtilf1whgc****
Ip	string	用戶端與阿里雲建立 SSL-VPN 連線時，用戶端實際使用的公網 IP 位址。	8.XX.XX.15
ReceiveBytes	integer	指 VPN 閘道透過 SSL-VPN 連線從用戶端接收的流量。單位：Byte。	60782
Port	string	用戶端與阿里雲建立 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	錯誤碼	錯誤資訊
400	InvalidVpnGatewayInstanceId.NotFound	The specified vpn gateway instance id does not exist.
400	InvalidInstanceId.NotFound	The specified instance id does not exist.
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.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。