UpdateIpsecServer - VPN Gateway - Alibaba Cloud Documentation Center

Memperbarui konfigurasi server IPsec dengan memanggil operasi UpdateIpsecServer.

Deskripsi operasi

Jika hanya mengubah IpsecServerName pada server IPsec, operasi ini bersifat sinkron. Namun, jika mengubah konfigurasi selain IpsecServerName, operasi ini bersifat asinkron.
Ketika operasi UpdateIpsecServer bersifat asinkron, sistem terlebih dahulu mengembalikan ID permintaan, meskipun konfigurasi server IPsec belum dimodifikasi karena tugas modifikasi masih berjalan di latar belakang. Anda dapat memanggil DescribeVpnGateway untuk memeriksa status instans gateway VPN guna menentukan status modifikasi konfigurasi server IPsec:
- Jika instans gateway VPN berada dalam status updating, konfigurasi server IPsec sedang dimodifikasi.
- Jika instans gateway VPN berada dalam status active, konfigurasi server IPsec telah berhasil dimodifikasi.
Operasi UpdateIpsecServer tidak mendukung modifikasi konkuren terhadap konfigurasi server IPsec 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:UpdateIpsecServer

update

*All resources.

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID wilayah dari server IPsec. Anda dapat memanggil operasi DescribeRegions untuk menanyakan ID wilayah.	cn-shanghai
IpsecServerId	string	Yes	ID server IPsec.	iss-bp1bo3xuvcxo7ixll****
LocalSubnet	string	No	Blok CIDR lokal, yaitu blok CIDR di sisi VPC yang perlu berkomunikasi dengan blok CIDR klien. Pisahkan beberapa blok CIDR dengan koma (,). Contoh: 192.168.1.0/24,192.168.2.0/24.	192.168.0.0/24,172.17.0.0/16
ClientIpPool	string	No	Blok CIDR klien, yaitu blok CIDR tempat alamat IP dialokasikan ke pengontrol antarmuka jaringan virtual (NIC) klien. Catatan Blok CIDR klien tidak boleh berkonflik dengan blok CIDR VPC.	10.0.0.0/24
IpsecServerName	string	No	Nama server IPsec. Nama harus terdiri dari 1 hingga 100 karakter.	test
EffectImmediately	boolean	No	Menentukan apakah akan menghapus terowongan IPsec yang saat ini dinegosiasikan dan memulai ulang negosiasi. Nilai yang valid: true: Negosiasi segera dimulai setelah konfigurasi selesai. false: Negosiasi dimulai ketika lalu lintas masuk terdeteksi.	false
IkeConfig	string	No	Pengaturan parameter negosiasi Fase 1. Nilai yang valid: IkeVersion: Versi protokol IKE. Nilai yang valid: ikev1 atau ikev2. IkeMode: Pola negosiasi versi IKE. Nilai default: main. IkeEncAlg: Algoritma enkripsi yang digunakan dalam negosiasi Fase 1. Nilai default: aes. IkeAuthAlg: Algoritma autentikasi yang digunakan dalam negosiasi Fase 1. Nilai default: sha1. IkePfs: Algoritma pertukaran kunci Diffie-Hellman yang digunakan dalam negosiasi Fase 1. Nilai default: group2. IkeLifetime: Epoch SA yang dinegosiasikan dalam Fase 1. Satuan: detik. Nilai yang valid: 0 hingga 86400. Nilai default: 86400. LocalId: Identitas server IPsec. Format FQDN dan alamat IP didukung. RemoteId: Identitas peer. Format FQDN dan alamat IP didukung.	{"IkeVersion":"ikev2","IkeMode":"main","IkeEncAlg":"aes","IkeAuthAlg":"sha1","IkePfs":"group2","IkeLifetime":86400}
IpsecConfig	string	No	Pengaturan parameter negosiasi Phase 2. Nilai yang valid: IpsecEncAlg: Algoritma enkripsi yang digunakan dalam negosiasi Phase 2. Nilai default: aes. IpsecAuthAlg: Algoritma autentikasi yang digunakan dalam negosiasi Phase 2. Nilai default: sha1. IpsecPfs: Perfect Forward Secrecy (PFS). Algoritma pertukaran kunci Diffie-Hellman yang digunakan dalam negosiasi Phase 2. Nilai default: group2. IpsecLifetime: Masa berlaku SA yang dinegosiasikan dalam Phase 2. Satuan: detik. Nilai yang valid: 0 hingga 86400. Nilai default: 86400.	{"IpsecEncAlg":"aes","IpsecAuthAlg":"sha1","IpsecPfs":"group2","IpsecLifetime":86400}
PskEnabled	boolean	No	Menentukan apakah akan mengaktifkan otentikasi kunci pra-bersama. Nilai yang valid: true, yang menunjukkan bahwa otentikasi kunci pra-bersama diaktifkan.	true
Psk	string	No	Kunci pra-bersama. Kunci pra-bersama digunakan untuk otentikasi identitas antara server IPsec dan klien. Kunci harus terdiri dari 1 hingga 100 karakter. Anda dapat memanggil operasi ListIpsecServers untuk menanyakan kunci yang dihasilkan oleh sistem. Catatan Kunci pra-bersama server IPsec harus sama dengan kunci autentikasi klien. Jika tidak, koneksi tidak dapat dibuat antara server IPsec dan klien.	Cfd123****
ClientToken	string	No	Token klien yang digunakan untuk memastikan idempotensi permintaan. Anda dapat menggunakan klien untuk menghasilkan token, tetapi Anda harus memastikan bahwa token tersebut unik di antara permintaan yang berbeda. Token hanya boleh berisi karakter ASCII. Catatan Jika Anda tidak menentukan parameter ini, sistem secara otomatis menggunakan RequestId dari permintaan API sebagai ClientToken. RequestId mungkin berbeda untuk setiap permintaan API.	e4567-e89b-12d3-a456-42665544****
DryRun	string	No	Menentukan apakah akan melakukan dry run. Nilai yang valid: true: Melakukan dry run tanpa memodifikasi konfigurasi server IPsec. Sistem memeriksa parameter yang diperlukan, format permintaan, dan batasan layanan. Jika pemeriksaan gagal, pesan error yang sesuai dikembalikan. Jika pemeriksaan berhasil, `DryRunOperation` dikembalikan. false (default): Melakukan dry run dan mengirim permintaan. Setelah pemeriksaan berhasil, konfigurasi server IPsec dimodifikasi.	false

Elemen respons

Element	Type	Description	Example
	object	Parameter respons.
RequestId	string	ID permintaan.	B61C08E5-403A-46A2-96C1-F7B1216DB10C

Contoh

Respons sukses

JSONformat

{
  "RequestId": "B61C08E5-403A-46A2-96C1-F7B1216DB10C"
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	VpnGateway.Configuring	The specified service is configuring.
400	VpnGateway.FinancialLocked	The specified service is financial locked.
400	OperationUnsupported.IpsecPfs	The specified IPsec Pfs is unsupported.	IPsec PFS yang ditentukan tidak didukung.
400	IllegalParam.AuthMethod	One authentication method (Psk or IDaaS) should be specified at least.	Setidaknya satu metode otentikasi (Psk atau IDaaS) harus ditentukan.
400	IllegalParam.LocalSubnet	The specified "LocalSubnet" (%s) is invalid.	Blok CIDR lokal (%s) tidak valid.
400	IllegalParam.ClientIpPool	The specified "ClientIpPool" (%s) is invalid.
400	MissingParam.IDaaSInstanceId	The input parameter IDaaSInstanceId is mandatory when enable multi-factor authentication.	ID instans IDaaS wajib diisi saat otentikasi dua faktor diaktifkan.
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	OperationFailed.AddVpcRoute	It's failed to add VPC route after this operation.
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	VpnRouteEntry.Conflict	The specified client IP pool conflicts with VPN connection or SSL server.	Pool IP klien yang ditentukan berkonflik dengan koneksi VPN atau server SSL.
400	ClientIpPool.SubnetInvalid	The specified client IP pool cannot be used.	Blok CIDR klien yang ditentukan tidak tersedia.
400	InvalidClientIpPool.Conflict	The specified client IP pool conflicts with other resources in the same VPC.	Blok CIDR klien berkonflik dengan Sumber daya lain di VPC.
400	SystemBusy	The system is busy. Please try again later.
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	InvalidIpsecServerId.NotFound	The specified IPsec server ID (%s) does not exist.
404	InvalidIDaaSInstanceId.NotFound	The specified IDaaS instance ID does not exist.	ID instans IDaaS yang ditentukan tidak ada.
409	OperationConflict	The operation against this instance is too frequent, please try again later.	Terjadi konflik permintaan. Coba lagi nanti.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.