DescribeSslVpnClients - VPN Gateway - Alibaba Cloud ドキュメントセンター

DescribeSslVpnClients 操作を呼び出して、指定された VPN ゲートウェイインスタンスで Alibaba Cloud への SSL-VPN 接続を確立したクライアントの情報を照会します。

操作説明

VPN ゲートウェイインスタンスが 2022 年 12 月 10 日より前に作成された場合、SSL クライアント接続情報を表示するには、VPN ゲートウェイインスタンスを最新バージョンにスペックアップする必要があります。詳細については、「VPN ゲートウェイのスペックアップ」をご参照ください。

2022 年 12 月 10 日以降に作成された VPN ゲートウェイインスタンスは、デフォルトで SSL クライアント接続情報の表示をサポートしています。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

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 ページあたりのエントリの最大値。有効な値: 1 ～ 50。デフォルト値: 10。	10

レスポンスフィールド

フィールド	型	説明	例
	object	応答パラメーター。
RequestId	string	リクエスト ID。	885E117D-06A9-38A3-8DD2-40BDAC429FFC
VpnGatewayId	string	VPN ゲートウェイインスタンスの ID。	vpn-gw8gfb947ctddabja****
PageNumber	integer	リストのページ番号。	1
PageSize	integer	ページングクエリにおける 1 ページあたりのエントリの最大値。	10
TotalCount	integer	リスト内のエントリの総数。	1
RegionId	string	VPN ゲートウェイインスタンスのリージョン ID。	eu-central-1
ClientInfoList	array<object>	クライアント情報のリスト。
	object	クライアント情報。
Status	string	SSL-VPN 接続のステータス。有効な値: online。クライアントが Alibaba Cloud への SSL-VPN 接続を正常に確立したことを示します。	online
PrivateIp	string	クライアントが Alibaba Cloud への SSL-VPN 接続を確立した際に、VPN ゲートウェイがクライアントに割り当てた非公開 IP アドレス。	10.10.10.10
SendBytes	integer	VPN ゲートウェイが SSL-VPN 接続を介してクライアントに送信したトラフィック。単位: バイト。	57144
ConnectedTime	integer	クライアントが Alibaba Cloud への SSL-VPN 接続を確立した時のタイムスタンプ。単位: ミリ秒。タイムスタンプは UNIX フォーマットで、1970 年 1 月 1 日 00:00:00 協定世界時 (UTC) から SSL-VPN 接続が確立された時間までに経過したミリ秒の合計数を表します。	1670985008000
CommonName	string	クライアントが Alibaba Cloud への SSL-VPN 接続を確立する際に使用した SSL クライアント証明書。説明クライアントが二要素身分認証を使用して Alibaba Cloud への SSL-VPN 接続を確立した場合、このパラメーターの値はクライアントのユーザー名です。	CN=vsc-gw8gkh6gtilf1whgc****
Ip	string	クライアントが Alibaba Cloud への SSL-VPN 接続を確立する際に使用したパブリック IP アドレス。	8.XX.XX.15
ReceiveBytes	integer	VPN ゲートウェイが SSL-VPN 接続を介してクライアントから受信したトラフィック。単位: バイト。	60782
Port	string	クライアントが Alibaba Cloud への SSL-VPN 接続を確立する際に使用したポート番号。	4****

例

成功レスポンス

JSONJSON

{
  "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 ステータスコード	エラーコード	エラーメッセージ
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.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。