DescribeSslVpnClients - VPN Gateway - Alibaba Cloud Documentation Center

Mengkueri informasi tentang klien yang telah membuat koneksi SSL-VPN ke Alibaba Cloud di bawah instans Gateway VPN tertentu dengan memanggil operasi DescribeSslVpnClients.

Deskripsi operasi

Jika instans Gateway VPN Anda dibuat sebelum 10 Desember 2022, Anda harus melakukan Peningkatan instans Gateway VPN ke versi terbaru sebelum dapat Tampilan informasi koneksi klien SSL. Untuk informasi lebih lanjut, lihat Upgrade a VPN gateway.

Instans Gateway VPN yang dibuat setelah 10 Desember 2022 secara default mendukung Tampilan informasi koneksi klien SSL.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

vpc:DescribeSslVpnClients

list

*VpnGateway

acs:vpc:{#regionId}:{#accountId}:vpngateway/{#VpnGatewayId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID wilayah instans Gateway VPN. Anda dapat memanggil operasi DescribeRegions untuk mengkueri ID wilayah.	eu-central-1
VpnGatewayId	string	Yes	ID instans Gateway VPN.	vpn-gw8gfb947ctddabja****
PageNumber	integer	No	Nomor halaman daftar. Nilai default: 1.	1
PageSize	integer	No	Jumlah maksimum entri per halaman dalam kueri berhalaman. Nilai valid: 1 hingga 50. Nilai default: 10.	10

Elemen respons

Element	Type	Description	Example
	object	Parameter tanggapan.
RequestId	string	ID permintaan.	885E117D-06A9-38A3-8DD2-40BDAC429FFC
VpnGatewayId	string	ID instans Gateway VPN.	vpn-gw8gfb947ctddabja****
PageNumber	integer	Nomor halaman daftar.	1
PageSize	integer	Jumlah maksimum entri per halaman dalam kueri berhalaman.	10
TotalCount	integer	Jumlah total entri dalam daftar.	1
RegionId	string	ID wilayah instans Gateway VPN.	eu-central-1
ClientInfoList	array<object>	Daftar informasi klien.
	object	Informasi klien.
Status	string	Status koneksi SSL-VPN. Nilai valid: online, yang menunjukkan bahwa klien telah berhasil membuat koneksi SSL-VPN ke Alibaba Cloud.	online
PrivateIp	string	Alamat IP privat yang ditetapkan Gateway VPN kepada klien saat klien membuat koneksi SSL-VPN ke Alibaba Cloud.	10.10.10.10
SendBytes	integer	Trafik yang dikirim Gateway VPN ke klien melalui koneksi SSL-VPN. Unit: bytes.	57144
ConnectedTime	integer	Pengatur waktu saat klien membuat koneksi SSL-VPN ke Alibaba Cloud. Unit: milidetik. Pengatur waktu dalam format UNIX dan merepresentasikan jumlah total milidetik yang telah berlalu sejak 1 Januari 1970, 00:00:00 UTC hingga waktu pembuatan koneksi SSL-VPN.	1670985008000
CommonName	string	Sertifikat klien SSL yang digunakan klien untuk membuat koneksi SSL-VPN ke Alibaba Cloud. Catatan Jika klien menggunakan otentikasi identitas dua faktor untuk membuat koneksi SSL-VPN ke Alibaba Cloud, nilai parameter ini adalah nama pengguna klien.	CN=vsc-gw8gkh6gtilf1whgc****
Ip	string	Alamat IP publik yang digunakan klien untuk membuat koneksi SSL-VPN ke Alibaba Cloud.	8.XX.XX.15
ReceiveBytes	integer	Trafik yang diterima Gateway VPN dari klien melalui koneksi SSL-VPN. Unit: bytes.	60782
Port	string	Nomor port yang digunakan klien untuk membuat koneksi SSL-VPN ke Alibaba Cloud.	4****

Contoh

Respons sukses

JSONformat

{
  "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****"
    }
  ]
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	InvalidVpnGatewayInstanceId.NotFound	ID instance vpn gateway yang ditentukan tidak ada.	Gateway VPN yang ditentukan tidak ada. Periksa apakah gateway VPN sudah benar.
400	InvalidInstanceId.NotFound	ID instance yang ditentukan tidak ada.	ID instance yang ditentukan tidak ada.
403	Forbbiden.SubUser	Pengguna tidak diizinkan untuk mengoperasikan resource yang ditentukan karena akun Anda dibuat oleh pengguna lain.
403	Forbidden	Pengguna tidak diizinkan untuk mengoperasikan resource yang ditentukan.	Anda tidak diizinkan untuk mengoperasikan resource yang ditentukan. Ajukan permintaan izin yang diperlukan dan coba lagi.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.