DescribeSslVpnServers - VPN Gateway - Alibaba Cloud Documentation Center

Mengambil informasi mengenai server SSL VPN yang telah dibuat.

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:DescribeSslVpnServers

list

SslVpnServer.

acs:vpc:{#regionId}:{#accountId}:sslvpnserver/*

SslVpnServer.

acs:vpc:{#regionId}:{#accountId}:sslvpnserver/{#SslVpnServerId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID wilayah dari SSL server. Anda dapat memanggil operasi DescribeRegions untuk menanyakan ID wilayah.	cn-hangzhou
SslVpnServerId	string	No	ID dari SSL server.	vss-bp15j3du13gq1dgey****
VpnGatewayId	string	No	ID dari VPN gateway.	vpn-bp1on0xae9d771ggi****
Name	string	No	Nama dari SSL server. Nama harus terdiri dari 1 hingga 100 karakter dan tidak boleh diawali dengan `http://` atau `https://`.	test
PageNumber	integer	No	Nomor halaman. Nilai default: 1.	1
PageSize	integer	No	Jumlah entri per halaman untuk kueri berhalaman. Nilai maksimum: 50. Nilai default: 10.	10
ResourceGroupId	string	No	ID kelompok sumber daya tempat SSL server tersebut berada. SSL server berada dalam kelompok sumber daya yang sama dengan instans VPN gateway terkait. Anda dapat memanggil operasi DescribeVpnGateway untuk menanyakan ID kelompok sumber daya dari instans VPN gateway.	rg-acfmzs372yg****

Elemen respons

Element	Type	Description	Example
	object	Parameter respons.
PageSize	integer	Jumlah entri per halaman untuk kueri berhalaman.	10
RequestId	string	ID permintaan.	D350187B-EA41-4577-950B-95434C8302E1
PageNumber	integer	Nomor halaman.	1
TotalCount	integer	Total jumlah entri yang dikembalikan.	1
SslVpnServers	object
SslVpnServer	array<object>	Detail dari SSL server.
	object
InternetIp	string	Alamat IP publik dari VPN gateway.	47.5.XX.XX
IDaaSInstanceId	string	ID instans dari instans IDaaS EIAM.	idaas-cn-hangzhou-****
CreateTime	integer	Timestamp saat SSL server dibuat.	1613800884000
VpnGatewayId	string	ID dari VPN gateway.	vpn-bp1on0xae9d771ggi****
IDaaSRegionId	string	ID wilayah dari instans IDaaS EIAM.	cn-hangzhou
Compress	boolean	Menunjukkan apakah komunikasi dikompresi. Nilai yang valid: true false (default)	false
Port	integer	Port yang digunakan oleh SSL server.	1194
LocalSubnet	string	Blok CIDR lokal.	192.168.0.0/24
RegionId	string	ID wilayah dari SSL server.	cn-hangzhou
Cipher	string	Algoritma enkripsi yang digunakan.	AES-128-CBC
Connections	integer	Jumlah koneksi saat ini.	0
SslVpnServerId	string	ID dari SSL server.	vss-bp15j3du13gq1dgey****
MaxConnections	integer	Jumlah maksimum koneksi.	5
Name	string	Nama dari SSL server.	test
EnableMultiFactorAuth	boolean	Menunjukkan apakah otentikasi identitas dua faktor diaktifkan. Nilai yang valid: true false (default)	true
ClientIpPool	string	Blok CIDR klien.	10.10.1.0/24
Proto	string	Protokol yang digunakan oleh SSL server.	UDP
ResourceGroupId	string	ID kelompok sumber daya tempat SSL server tersebut berada. Anda dapat memanggil operasi ListResourceGroups untuk menanyakan informasi kelompok sumber daya.	rg-acfmzs372yg****
IDaaSApplicationId	string	ID aplikasi IDaaS.	app_my6g4qmvnwxzj2f****
IDaaSInstanceVersion	string	Versi instans IDaaS EIAM. Parameter ini hanya dikembalikan jika SSL server dikaitkan dengan instans IDaaS EIAM 2.0. Nilainya adalah EIAM 2.0. Jika SSL server dikaitkan dengan instans IDaaS EIAM 1.0, parameter ini tidak dikembalikan.	EIAM 2.0
DnsServers	string

Contoh

Respons sukses

JSONformat

{
  "PageSize": 10,
  "RequestId": "D350187B-EA41-4577-950B-95434C8302E1",
  "PageNumber": 1,
  "TotalCount": 1,
  "SslVpnServers": {
    "SslVpnServer": [
      {
        "InternetIp": "47.5.XX.XX",
        "IDaaSInstanceId": "idaas-cn-hangzhou-****",
        "CreateTime": 1613800884000,
        "VpnGatewayId": "vpn-bp1on0xae9d771ggi****",
        "IDaaSRegionId": "cn-hangzhou",
        "Compress": false,
        "Port": 1194,
        "LocalSubnet": "192.168.0.0/24",
        "RegionId": "cn-hangzhou",
        "Cipher": "AES-128-CBC",
        "Connections": 0,
        "SslVpnServerId": "vss-bp15j3du13gq1dgey****",
        "MaxConnections": 5,
        "Name": "test",
        "EnableMultiFactorAuth": true,
        "ClientIpPool": "10.10.1.0/24",
        "Proto": "UDP",
        "ResourceGroupId": "rg-acfmzs372yg****",
        "IDaaSApplicationId": "app_my6g4qmvnwxzj2f****",
        "IDaaSInstanceVersion": "EIAM 2.0",
        "DnsServers": ""
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
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.	EIP bukan milik pemanggil saat ini. Periksa apakah Anda memiliki izin untuk mengakses EIP ini.
404	InvalidRegionId.NotFound	The specified region is not found during access authentication.	Parameter tidak valid.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.