UpdateIpsecServer - VPN Gateway - Alibaba Cloud Documentation Center

Memanggil operasi UpdateIpsecServer untuk memperbarui konfigurasi server IPsec.

Deskripsi operasi

Jika Anda hanya mengubah IpsecServerName server IPsec, operasi ini bersifat sinkron. Jika Anda mengubah konfigurasi lain server IPsec, operasi ini bersifat asinkron.
Ketika UpdateIpsecServer merupakan operasi asinkron, sistem mengembalikan ID permintaan, tetapi konfigurasi server IPsec belum diubah. Tugas modifikasi masih berjalan di latar belakang. Anda dapat memanggil operasi DescribeVpnGateway untuk mengkueri status instans Gateway VPN dan menentukan status modifikasi konfigurasi server IPsec:
- Ketika instans Gateway VPN berada dalam status updating, konfigurasi server IPsec sedang dimodifikasi.
- Ketika instans Gateway VPN berada dalam status active, konfigurasi server IPsec telah dimodifikasi.
Operasi UpdateIpsecServer tidak mendukung modifikasi konkuren pada 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

Tidak ada otorisasi untuk operasi ini. Jika Anda mengalami masalah saat menjalankan operasi ini, hubungi dukungan teknis.

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID wilayah tempat server IPsec berada. Anda dapat memanggil operasi DescribeRegions untuk mengkueri 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 NIC virtual klien. Catatan Blok CIDR klien tidak boleh bertabrakan dengan blok CIDR di sisi VPC.	10.0.0.0/24
IpsecServerName	string	No	Nama server IPsec. Panjang nama harus 1 hingga 100 karakter.	test
EffectImmediately	boolean	No	Apakah akan menghapus Terowongan IPsec yang sedang dinegosiasikan dan memulai kembali negosiasi. Nilai valid: true: Negosiasi dimulai segera setelah konfigurasi selesai. false: Negosiasi dimulai ketika lalu lintas masuk terdeteksi.	false
IkeConfig	string	No	Konfigurasi negosiasi Fase 1: IkeVersion: versi protokol IKE. Nilai valid: ikev1 dan ikev2. IkeMode: mode 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: masa berlaku SA yang ditentukan oleh negosiasi Fase 1. Unit: detik. Nilai valid: 0 hingga 86400. Nilai default: 86400. LocalId: pengenal server IPsec. Nilai dapat berupa format FQDN atau alamat IP. RemoteId: pengenal peer. Nilai dapat berupa format FQDN atau alamat IP.	{"IkeVersion":"ikev2","IkeMode":"main","IkeEncAlg":"aes","IkeAuthAlg":"sha1","IkePfs":"group2","IkeLifetime":86400}
IpsecConfig	string	No	Konfigurasi negosiasi Fase 2: IpsecEncAlg: algoritma enkripsi yang digunakan dalam negosiasi Fase 2. Nilai default: aes. IpsecAuthAlg: algoritma autentikasi yang digunakan dalam negosiasi Fase 2. Nilai default: sha1. IpsecPfs: meneruskan paket dari semua protokol. Algoritma pertukaran kunci Diffie-Hellman yang digunakan dalam negosiasi Fase 2. Nilai default: group2. IpsecLifetime: masa berlaku SA yang ditentukan oleh negosiasi Fase 2. Unit: detik. Nilai valid: 0 hingga 86400. Nilai default: 86400.	{"IpsecEncAlg":"aes","IpsecAuthAlg":"sha1","IpsecPfs":"group2","IpsecLifetime":86400}
PskEnabled	boolean	No	Apakah akan mengaktifkan otentikasi kunci bersama. Nilai true menunjukkan bahwa otentikasi kunci bersama diaktifkan.	true
Psk	string	No	Kunci bersama. Kunci bersama digunakan untuk otentikasi identitas antara server IPsec dan klien. Panjang kunci harus 1 hingga 100 karakter. Anda dapat memanggil operasi ListIpsecServers untuk mengkueri kunci yang dihasilkan secara otomatis oleh sistem. Catatan Kunci bersama server IPsec harus sama dengan kunci autentikasi klien. Jika tidak, server IPsec tidak dapat membuat koneksi dengan klien.	Cfd123****
ClientToken	string	No	Token klien yang digunakan untuk memastikan idempotensi permintaan. Anda dapat menggunakan klien untuk menghasilkan nilai ini, tetapi Anda harus memastikan bahwa nilai tersebut unik di antara permintaan yang berbeda. Token hanya dapat berisi karakter ASCII. Catatan Jika Anda tidak menentukan parameter ini, sistem secara otomatis menggunakan RequestId dari permintaan API sebagai ClientToken. RequestId dari setiap permintaan API berbeda.	e4567-e89b-12d3-a456-42665544****
DryRun	string	No	Apakah hanya akan melakukan pemeriksaan awal pada permintaan. Nilai valid: true: hanya melakukan pemeriksaan awal pada permintaan dan tidak mengubah konfigurasi server IPsec. Sistem memeriksa parameter wajib, format permintaan, dan batas layanan. Jika permintaan gagal dalam pemeriksaan awal, Paket error akan dikembalikan. Jika permintaan lulus pemeriksaan awal, `DryRunOperation` akan dikembalikan. false (default): mengirimkan permintaan. Setelah permintaan lulus pemeriksaan awal, konfigurasi server IPsec akan dimodifikasi.	false

Elemen respons

Element	Type	Description	Example
	object	Hasil yang dikembalikan.
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
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.
400	IllegalParam.AuthMethod	One authentication method (Psk or IDaaS) should be specified at least.
400	IllegalParam.LocalSubnet	The specified "LocalSubnet" (%s) is invalid.
400	IllegalParam.ClientIpPool	The specified "ClientIpPool" (%s) is invalid.
400	MissingParam.IDaaSInstanceId	The input parameter IDaaSInstanceId is mandatory when enable multi-factor authentication.
400	OperationFailed.NoRamPermission	Vpn Service has no permission to operate your IDaaS instances.
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.
400	VpnRouteEntry.Conflict	The specified client IP pool conflicts with VPN connection or SSL server.
400	ClientIpPool.SubnetInvalid	The specified client IP pool cannot be used.
400	InvalidClientIpPool.Conflict	The specified client IP pool conflicts with other resources in the same VPC.
400	SystemBusy	The system is busy. Please try again later.
403	Forbidden	User not authorized to operate on the specified resource.
404	InvalidIpsecServerId.NotFound	The specified IPsec server ID (%s) does not exist.
404	InvalidIDaaSInstanceId.NotFound	The specified IDaaS instance ID does not exist.
409	OperationConflict	The operation against this instance is too frequent, please try again later.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.