ModifySslVpnServer - VPN Gateway - Alibaba Cloud Documentation Center

Memodifikasi konfigurasi server SSL-VPN dengan memanggil operasi ModifySslVpnServer.

Deskripsi operasi

Untuk mengaktifkan otentikasi identitas dua faktor pada server SSL, pastikan instans gateway VPN mendukung fitur ini. Anda mungkin perlu melakukan upgrade pada instans gateway VPN tersebut. Untuk informasi selengkapnya, lihat Otentikasi dua faktor SSL-VPN mendukung IDaaS EIAM 2.0.
Jika hanya memodifikasi Name server SSL-VPN, operasi ini bersifat sinkron. Namun, jika memodifikasi konfigurasi lain selain Name, operasi ini bersifat asinkron.
Ketika operasi ModifySslVpnServer bersifat asinkron, sistem akan segera mengembalikan ID permintaan meskipun konfigurasi server SSL-VPN belum diperbarui. Tugas modifikasi berjalan di latar belakang. Anda dapat memanggil operasi DescribeVpnGateway untuk memantau status modifikasi melalui status instans gateway VPN yang terkait dengan server SSL-VPN:
- Jika instans gateway VPN berada dalam status updating, konfigurasi server SSL-VPN sedang dimodifikasi.
- Jika instans gateway VPN berada dalam status active, konfigurasi server SSL-VPN telah berhasil dimodifikasi.
Operasi ModifySslVpnServer tidak mendukung modifikasi konkuren terhadap konfigurasi server SSL-VPN di bawah gateway VPN yang sama.

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

update

*SslVpnServer.

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
ClientToken	string	No	Token klien yang digunakan untuk memastikan idempotensi permintaan. Anda dapat menggunakan klien untuk menghasilkan token, tetapi harus memastikan bahwa token tersebut unik di antara permintaan yang berbeda. Token klien hanya boleh berisi karakter ASCII. Catatan Jika Anda tidak menentukan parameter ini, sistem secara otomatis menggunakan RequestId dari permintaan API sebagai ClientToken. RequestId dapat berbeda untuk setiap permintaan API.	02fb3da4-130e-11e9-8e44-0016e04115b
RegionId	string	Yes	ID wilayah gateway VPN. Anda dapat memanggil operasi DescribeRegions untuk mengecek daftar wilayah terbaru.	cn-hangzhou
SslVpnServerId	string	Yes	ID instans server SSL-VPN.	vss-bp18q7hzj6largv4v****
Name	string	No	Nama server SSL-VPN. Nama harus terdiri dari 1 hingga 100 karakter dan tidak boleh diawali dengan `http://` atau `https://`.	test
ClientIpPool	string	No	Blok CIDR klien. Blok CIDR klien digunakan untuk mengalokasikan alamat IP ke network interface controller (NIC) virtual klien. Blok ini bukan blok CIDR jaringan internal klien yang sudah ada. Ketika klien mengakses ujung lokal melalui koneksi SSL-VPN, gateway VPN akan mengalokasikan alamat IP dari blok CIDR klien yang ditentukan kepada klien. Klien kemudian menggunakan alamat IP tersebut untuk mengakses sumber daya cloud. Saat menentukan blok CIDR klien, pastikan jumlah alamat IP dalam blok tersebut minimal empat kali lipat dari jumlah koneksi SSL yang didukung oleh gateway VPN. Klik untuk melihat alasannya. Sebagai contoh, jika Anda menentukan 192.168.0.0/24 sebagai blok CIDR klien, sistem pertama-tama akan mengalokasikan subnet dengan masker subnet 30 bit dari blok CIDR 192.168.0.0/24, misalnya 192.168.0.4/30, lalu menetapkan satu alamat IP dari 192.168.0.4/30 kepada klien. Tiga alamat IP lainnya digunakan oleh sistem untuk memastikan komunikasi jaringan. Dalam kasus ini, satu klien mengonsumsi empat alamat IP. Oleh karena itu, untuk memastikan semua klien mendapatkan alamat IP, pastikan jumlah alamat IP dalam blok CIDR klien minimal empat kali lipat dari jumlah koneksi SSL yang didukung oleh gateway VPN. Klik untuk melihat blok CIDR yang tidak didukung. 100.64.0.0 hingga 100.127.255.255 127.0.0.0 hingga 127.255.255.255 169.254.0.0 hingga 169.254.255.255 224.0.0.0 hingga 239.255.255.255 255.0.0.0 hingga 255.255.255.255 Klik untuk melihat rekomendasi blok CIDR klien berdasarkan jumlah koneksi SSL. Jika jumlah koneksi SSL adalah 5, masker subnet blok CIDR klien harus 27 bit atau kurang. Contohnya: 10.0.0.0/27 atau 10.0.0.0/26. Jika jumlah koneksi SSL adalah 10, masker subnet blok CIDR klien harus 26 bit atau kurang. Contohnya: 10.0.0.0/26 atau 10.0.0.0/25. Jika jumlah koneksi SSL adalah 20, masker subnet blok CIDR klien harus 25 bit atau kurang. Contohnya: 10.0.0.0/25 atau 10.0.0.0/24. Jika jumlah koneksi SSL adalah 50, masker subnet blok CIDR klien harus 24 bit atau kurang. Contohnya: 10.0.0.0/24 atau 10.0.0.0/23. Jika jumlah koneksi SSL adalah 100, masker subnet blok CIDR klien harus 23 bit atau kurang. Contohnya: 10.0.0.0/23 atau 10.0.0.0/22. Jika jumlah koneksi SSL adalah 200, masker subnet blok CIDR klien harus 22 bit atau kurang. Contohnya: 10.0.0.0/22 atau 10.0.0.0/21. Jika jumlah koneksi SSL adalah 500, masker subnet blok CIDR klien harus 21 bit atau kurang. Contohnya: 10.0.0.0/21 atau 10.0.0.0/20. Jika jumlah koneksi SSL adalah 1000, masker subnet blok CIDR klien harus 20 bit atau kurang. Contohnya: 10.0.0.0/20 atau 10.0.0.0/19. Catatan Masker subnet blok CIDR klien harus memiliki panjang 16 hingga 29 bit. Pastikan blok CIDR klien tidak tumpang tindih dengan blok CIDR lokal, blok CIDR virtual private cloud (VPC), atau blok CIDR routing apa pun yang terkait dengan terminal klien. Gunakan 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16, atau subnet-nya sebagai blok CIDR klien. Jika Anda ingin menentukan blok CIDR publik sebagai blok CIDR klien, tetapkan blok CIDR publik tersebut sebagai blok CIDR pengguna VPC agar VPC dapat mengakses blok CIDR publik tersebut. Untuk informasi lebih lanjut tentang blok CIDR pengguna, lihat FAQ virtual private cloud. Setelah server SSL dibuat, sistem secara otomatis menambahkan rute blok CIDR klien ke tabel rute instans VPC. Jangan menambahkan rute blok CIDR klien secara manual ke tabel rute instans VPC. Jika tidak, trafik koneksi SSL-VPN mungkin tidak normal.	10.30.30.0/24
LocalSubnet	string	No	Blok CIDR lokal. Blok CIDR lokal adalah blok CIDR yang perlu diakses klien melalui koneksi SSL-VPN. Blok CIDR lokal dapat berupa blok CIDR VPC, blok CIDR vSwitch, blok CIDR pusat data lokal yang terhubung ke VPC melalui Sirkuit Express Connect, atau blok CIDR layanan cloud seperti Object Storage Service (OSS). Masker subnet blok CIDR lokal harus memiliki panjang 8 hingga 32 bit. Blok CIDR berikut tidak dapat ditentukan sebagai blok CIDR lokal: 127.0.0.0 hingga 127.255.255.255 169.254.0.0 hingga 169.254.255.255 224.0.0.0 hingga 239.255.255.255 255.0.0.0 hingga 255.255.255.255	10.20.20.0/24
Proto	string	No	Protokol yang digunakan oleh server SSL-VPN. Nilai yang valid: TCP (default): protokol TCP. UDP: protokol UDP.	UDP
Cipher	string	No	Algoritma enkripsi yang digunakan oleh server SSL-VPN. Nilai yang valid: AES-128-CBC (default): algoritma AES-128-CBC. AES-192-CBC: algoritma AES-192-CBC. AES-256-CBC: algoritma AES-256-CBC. none: tidak menggunakan algoritma enkripsi.	AES-128-CBC
Port	integer	No	Port yang digunakan oleh server SSL-VPN. Nilai yang valid: 1 hingga 65535. Nilai default: 1194. Port berikut tidak didukung: 22, 2222, 22222, 9000, 9001, 9002, 7505, 80, 443, 53, 68, 123, 4510, 4560, 500, dan 4500.	1194
Compress	boolean	No	Menentukan apakah kompresi komunikasi diaktifkan. Nilai yang valid: true (default): Kompresi diaktifkan. false: Kompresi dinonaktifkan.	true
EnableMultiFactorAuth	boolean	No	Menentukan apakah otentikasi dua faktor diaktifkan. Jika Anda mengaktifkan otentikasi dua faktor, Anda juga harus mengonfigurasi IDaaSInstanceId, IDaaSRegionId, dan IDaaSApplicationId. Nilai yang valid: true: Diaktifkan. false: Tidak diaktifkan. Catatan Jika Anda menggunakan otentikasi dua faktor untuk pertama kalinya, lengkapi proses otorisasi sebelum membuat server SSL. Saat membuat server SSL di wilayah UAE (Dubai), kami menyarankan Anda mengikat instans IDaaS EIAM 2.0 di wilayah Singapura untuk mengurangi latensi cross-region. Instans IDaaS EIAM 1.0 tidak lagi tersedia untuk pembelian. Jika Akun Alibaba Cloud Anda memiliki instans IDaaS EIAM 1.0 yang sudah ada, Anda masih dapat mengikat instans IDaaS EIAM 1.0 setelah mengaktifkan otentikasi dua faktor. Jika Akun Alibaba Cloud Anda tidak memiliki instans IDaaS EIAM 1.0, Anda hanya dapat mengikat instans IDaaS EIAM 2.0 setelah mengaktifkan otentikasi dua faktor.	false
IDaaSInstanceId	string	No	ID instans dari instans IDaaS EIAM.	idaas-cn-hangzhou-****
IDaaSRegionId	string	No	ID wilayah instans IDaaS EIAM.	cn-hangzhou
IDaaSApplicationId	string	No	ID aplikasi IDaaS. Jika Anda mengikat instans IDaaS EIAM 2.0, Anda harus memasukkan ID aplikasi IDaaS. Jika Anda mengikat instans IDaaS EIAM 1.0, Anda tidak perlu memasukkan ID aplikasi IDaaS.	app_my6g4qmvnwxzj2f****
DryRun	boolean	No	Menentukan apakah akan menjalankan dry run tanpa benar-benar mengirim permintaan. Nilai yang valid: true: hanya menjalankan dry run. Sistem akan memeriksa potensi masalah dalam permintaan, termasuk nilai parameter yang hilang, format permintaan yang salah, dan batasan layanan. Jika permintaan gagal dalam dry run, kode kesalahan akan dikembalikan. Jika permintaan lolos dry run, kode kesalahan `DryRunOperation` akan dikembalikan. false (default): menjalankan dry run dan mengirim permintaan. Jika permintaan lolos dry run, kode status HTTP 2xx akan dikembalikan dan konfigurasi server SSL akan dimodifikasi.	false
DnsServers	string	No

Elemen respons

Element	Type	Description	Example
	object	Parameter respons.
InternetIp	string	Alamat IP publik.	47.98.XX.XX
IDaaSInstanceId	string	ID instans dari instans IDaaS EIAM.	idaas-cn-hangzhou-****
CreateTime	integer	Waktu saat server SSL-VPN dibuat.	1492753580000
VpnGatewayId	string	ID instans gateway VPN.	vpn-bp1q8bgx4xnkm2ogj****
Compress	boolean	Menunjukkan apakah komunikasi dikompresi.	false
Port	integer	Port server SSL-VPN.	1194
LocalSubnet	string	Blok CIDR lokal.	10.20.20.0/24
RegionId	string	ID wilayah server SSL-VPN.	cn-hangzhou
Cipher	string	Algoritma enkripsi yang digunakan.	AES-128-CBC
RequestId	string	ID permintaan.	DF11D6F6-E35A-41C3-9B20-6FC8A901FE65
Connections	integer	Jumlah koneksi saat ini.	0
SslVpnServerId	string	ID server SSL-VPN.	vss-bp18q7hzj6largv4v****
MaxConnections	integer	Jumlah maksimum koneksi.	5
Name	string	Nama server SSL-VPN.	test
EnableMultiFactorAuth	boolean	Menunjukkan apakah otentikasi dua faktor diaktifkan. true: Diaktifkan. false (default): Tidak diaktifkan.	false
ClientIpPool	string	Blok CIDR klien.	10.30.30.0/24
Proto	string	Protokol yang digunakan oleh server SSL-VPN.	UDP
ResourceGroupId	string	ID kelompok sumber daya tempat server SSL-VPN berada. Server SSL-VPN berada dalam kelompok sumber daya yang sama dengan instans gateway VPN terkait. Anda dapat memanggil operasi ListResourceGroups untuk mengecek informasi kelompok sumber daya.	rg-acfmzs372yg****
IDaaSApplicationId	string	ID aplikasi IDaaS.	app_my6g4qmvnwxzj2f****
IDaaSInstanceVersion	string	Versi instans IDaaS EIAM. Parameter ini hanya dikembalikan ketika server SSL diikat ke instans IDaaS EIAM 2.0. Nilainya hanya bisa EIAM 2.0. Jika server SSL diikat ke instans IDaaS EIAM 1.0, parameter ini tidak dikembalikan.	EIAM 2.0

Contoh

Respons sukses

JSONformat

{
  "InternetIp": "47.98.XX.XX",
  "IDaaSInstanceId": "idaas-cn-hangzhou-****",
  "CreateTime": 1492753580000,
  "VpnGatewayId": "vpn-bp1q8bgx4xnkm2ogj****",
  "Compress": false,
  "Port": 1194,
  "LocalSubnet": "10.20.20.0/24",
  "RegionId": "cn-hangzhou",
  "Cipher": "AES-128-CBC",
  "RequestId": "DF11D6F6-E35A-41C3-9B20-6FC8A901FE65",
  "Connections": 0,
  "SslVpnServerId": "vss-bp18q7hzj6largv4v****",
  "MaxConnections": 5,
  "Name": "test",
  "EnableMultiFactorAuth": false,
  "ClientIpPool": "10.30.30.0/24",
  "Proto": "UDP",
  "ResourceGroupId": "rg-acfmzs372yg****",
  "IDaaSApplicationId": "app_my6g4qmvnwxzj2f****",
  "IDaaSInstanceVersion": "EIAM 2.0"
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	InvalidName	The name is not valid
400	VpnGateway.Configuring	The specified service is configuring.
400	VpnGateway.FinancialLocked	The specified service is financial locked.
400	IpConflict	Client IP pool conflict with local IP range.	Pool IP klien bertabrakan dengan rentang IP lokal.
400	SslVpnServer.AddRouteError	Add route error whose destination is client IP pool, please check vpc route entry and relevant quota.	Gagal menambahkan rute ke blok CIDR klien. Periksa entri rute VPC dan kuota terkait.
400	ClientIpPool.NetmaskInvalid	The netmask length of client IP pool must be greater than or equal to 16 and less than or equal to 29.	Panjang masker jaringan dari pool IP klien harus lebih besar atau sama dengan 16 dan kurang dari atau sama dengan 29.
400	ClientIpPool.SubnetInvalid	The specified client IP pool cannot be used.	Blok CIDR klien yang ditentukan tidak tersedia.
400	MissingParameter.IDaaSInstanceId	The input parameter IDaaSInstanceId is mandatory when enable multi-factor authentication.	Parameter IDaaSInstanceId harus ditentukan saat otentikasi dua faktor diaktifkan.
400	OperationFailed.GetIDaaSInfo	Failed to get secret key from your IDaaS instance.
400	OperationFailed.NoRamPermission	Vpn Service has no permission to operate your IDaaS instances.	Layanan VPN tidak memiliki izin untuk beroperasi pada instans IDaaS Anda.
400	OperationUnsupported.NotSupportMultiFactorAuth	Current version of the VPN does not support multi-factor authentication.
400	SystemBusy	The system is busy. Please try again later.
400	SslVpnServerPort.Illegal	The server port is not in the range of [1-65535].	Nomor port server SSL VPN harus berada dalam rentang 1 hingga 65535.
400	EnableHaCheck.SslVpnServerClientCidrContainsVpcRouteDest	Ssl vpn client cidr contains vpc route prefix. The vpc route prefix is %s.	Entri rute dengan awalan %s dalam tabel rute VPC termasuk dalam blok CIDR klien SSL-VPN.
400	InvalidInstanceId.NotFound	InstanceId is not found.	ID instans yang ditentukan tidak ada.
400	VpnRouteEntry.Conflict	The specified route entry has conflict.	Pool IP klien yang ditentukan berkonflik dengan koneksi VPN atau server SSL.
400	IllegalParam.IDaaSApplicationId	The specified IDaaS application Id is not illegal, the application instance needs to be created based on the dedicated SSL VPN template.	ID instans aplikasi IDaaS yang ditentukan tidak valid. Instans aplikasi harus dibuat berdasarkan templat SSL VPN khusus.
400	MissingParam.IDaaSApplicationId	The input parameter IDaaSApplicationId is mandatory when enable multi-factor authentication.	Tentukan parameter IDaaSApplicationId saat otentikasi dua faktor diaktifkan.
400	SslVpnIDaaS2.NotSupport	Current version of the VPN does not support IDaaS2.0.	Versi instans VPN saat ini tidak mendukung IDaaS 2.0.
400	MissingParam.IDaaSRegionId	The input parameter IDaaSRegionId is mandatory when enable multi-factor authentication.	Tentukan parameter IDaaSRegionId saat otentikasi dua faktor diaktifkan.
400	DryRunOperation	Request validation has been passed with DryRun flag set.	Validasi dry run berhasil.
400	IllegalParam.LocalSubnet	The specified "LocalSubnet" (%s) is invalid.	Blok CIDR lokal (%s) tidak valid.
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.
404	InvalidIDaaSInstanceId.NotFound	The specified IDaaS instance ID does not exist.	ID instans IDaaS yang ditentukan tidak ada.
404	InvalidIDaaSApplicationId.NotFound	The specified IDaaS application Id does not exist.	ID instans aplikasi IDaaS yang ditentukan tidak ada.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.