ModifyVpnGatewayAttribute - VPN Gateway - Alibaba Cloud Documentation Center

Operasi ModifyVpnGatewayAttribute digunakan untuk mengubah nama, deskripsi, atau fitur propagasi otomatis perutean gateway VPN.

Deskripsi operasi

ModifyVpnGatewayAttribute adalah operasi asinkron. Setelah operasi ini dipanggil, sistem akan segera mengembalikan informasi gateway VPN meskipun konfigurasi belum diterapkan. Tugas modifikasi berjalan di latar belakang. Untuk memantau status modifikasi, Anda dapat memanggil DescribeVpnGateway:
- Jika gateway VPN berada dalam status updating, konfigurasi sedang dalam proses modifikasi.
- Jika gateway VPN berada dalam status active, konfigurasi telah berhasil dimodifikasi.
ModifyVpnGatewayAttribute tidak mendukung modifikasi konkuren terhadap konfigurasi 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:ModifyVpnGatewayAttribute

update

*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 DescribeRegions untuk mengecek daftar wilayah terbaru.	cn-hangzhou
ClientToken	string	No	Token klien yang digunakan untuk memastikan idempotensi permintaan. Anda dapat menghasilkan token ini dari sisi klien, 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 mungkin berbeda untuk setiap permintaan API.	123e4567-e89b-12d3-a456-4266****
VpnGatewayId	string	Yes	ID instans gateway VPN.	vpn-bp1q8bgx4xnkm2ogj****
Name	string	No	Nama baru gateway VPN. Nama harus terdiri dari 2 hingga 100 karakter. Nama tidak boleh diawali dengan `http://` atau `https://`. Nama harus diawali dengan huruf (besar atau kecil) dan hanya boleh berisi huruf (besar/kecil), angka, garis bawah (_), tanda hubung (-), dan titik (.). Karakter khusus lainnya tidak didukung.	myvpn
Description	string	No	Deskripsi baru gateway VPN. Deskripsi harus terdiri dari 1 hingga 100 karakter.	test
AutoPropagate	boolean	No	Menentukan apakah akan mengaktifkan propagasi otomatis perutean untuk gateway VPN. Nilai yang valid: true: diaktifkan. Setelah propagasi otomatis perutean diaktifkan, instans gateway VPN melakukan pembelajaran otomatis entri rute sistem pada tabel rute sistem instans terhubung-VPC dan secara otomatis menyebarkan rute pusat data lokal ke tabel rute sistem instans terhubung-VPC. false: dinonaktifkan. Sebelum menonaktifkan propagasi otomatis perutean, pastikan fitur rute dinamis BGP telah dinonaktifkan untuk semua koneksi IPsec-VPN di bawah gateway VPN tersebut.	true

Elemen respons

Element	Type	Description	Example
	object	Parameter respons.
VpcId	string	ID VPC tempat instans gateway VPN berada.	vpc-bp1ub1yt9cvakoel****
Status	string	Status gateway VPN. Nilai yang valid: init: sedang diinisialisasi. provisioning: sedang dipersiapkan. active: Normal. updating: sedang diperbarui. deleting: sedang dihapus.	active
InternetIp	string	Jika instans gateway VPN mendukung pembuatan koneksi IPsec-VPN saluran data tunggal, alamat ini adalah alamat IP instans gateway VPN dan dapat digunakan untuk membuat koneksi IPsec-VPN atau koneksi SSL-VPN. Jika instans gateway VPN mendukung pembuatan koneksi IPsec-VPN saluran data ganda, alamat ini adalah alamat IP pertama yang digunakan untuk membuat koneksi IPsec-VPN dan tidak dapat digunakan untuk membuat koneksi SSL-VPN. Jika instans gateway VPN mendukung pembuatan koneksi IPsec-VPN saluran data ganda, sistem akan menetapkan dua alamat IP IPsec ke instans gateway VPN untuk membuat koneksi IPsec-VPN saluran data ganda.	116.62.XX.XX
Spec	string	Spesifikasi bandwidth instans gateway VPN. Satuan: Mbit/s.	5M
CreateTime	integer	Timestamp saat instans gateway VPN dibuat. Satuan: milidetik. Timestamp dalam format UNIX dan merepresentasikan jumlah milidetik sejak 1 Januari 1970 pukul 00:00:00 UTC.	1492753580000
AutoPropagate	boolean	Menunjukkan apakah propagasi otomatis perutean diaktifkan untuk rute BGP ke VPC. Nilai yang valid: true: propagasi otomatis diaktifkan. false: propagasi otomatis tidak diaktifkan.	true
VpnGatewayId	string	ID instans gateway VPN.	vpn-bp1q8bgx4xnkm2ogj****
IntranetIp	string	Alamat IP pribadi vSwitch yang ditempati oleh sistem saat men-deploy instans gateway VPN. Parameter ini hanya dikembalikan untuk instans gateway VPN yang mendukung koneksi IPsec-VPN saluran data tunggal dan memiliki fitur IPsec-VPN yang diaktifkan.	172.16.10.46
EndTime	integer	Timestamp saat instans gateway VPN kedaluwarsa. Satuan: milidetik. Timestamp dalam format UNIX dan merepresentasikan jumlah milidetik sejak 1 Januari 1970 pukul 00:00:00 UTC.	1495382400000
VSwitchId	string	ID vSwitch yang terkait dengan instans gateway VPN.	vsw-bp1y9ovl1cu9ou4tv****
RequestId	string	ID permintaan.	54B48E3D-DF70-471B-AA93-08E683A1B457
Description	string	Deskripsi instans gateway VPN.	test
EnableBgp	boolean	Status pengaktifan fitur BGP untuk gateway VPN. Nilai yang valid: true: diaktifkan. false: tidak diaktifkan.	true
BusinessStatus	string	Status pembayaran instans gateway VPN. Nilai yang valid: Normal: Normal. FinancialLocked: terkunci karena pembayaran tertunda.	Normal
Name	string	Nama instans gateway VPN.	test
DisasterRecoveryInternetIp	string	Alamat IP kedua yang ditetapkan oleh sistem ke instans gateway VPN untuk membuat koneksi IPsec-VPN. Parameter ini hanya dikembalikan untuk instans gateway VPN yang mendukung pembuatan koneksi IPsec-VPN saluran data ganda.	116.11.XX.XX
DisasterRecoveryVSwitchId	string	ID vSwitch kedua yang terkait dengan instans gateway VPN. Parameter ini hanya dikembalikan untuk instans gateway VPN yang mendukung pembuatan koneksi IPsec-VPN saluran data ganda.	vsw-p0w95ql6tmr2ludkt****
SslVpnInternetIp	string	Alamat IP koneksi SSL-VPN. Parameter ini hanya dikembalikan ketika fitur SSL-VPN diaktifkan untuk instans gateway VPN yang mendukung pembuatan koneksi IPsec-VPN saluran data ganda dan menggunakan jenis jaringan publik.	116.33.XX.XX
ResourceGroupId	string	ID kelompok sumber daya tempat instans gateway VPN berada. Anda dapat memanggil ListResourceGroups untuk mengecek informasi kelompok sumber daya.	rg-acfmzs372yg****

Contoh

Respons sukses

JSONformat

{
  "VpcId": "vpc-bp1ub1yt9cvakoel****",
  "Status": "active",
  "InternetIp": "116.62.XX.XX",
  "Spec": "5M",
  "CreateTime": 1492753580000,
  "AutoPropagate": true,
  "VpnGatewayId": "vpn-bp1q8bgx4xnkm2ogj****",
  "IntranetIp": "172.16.10.46",
  "EndTime": 1495382400000,
  "VSwitchId": "vsw-bp1y9ovl1cu9ou4tv****",
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B457",
  "Description": "test",
  "EnableBgp": true,
  "BusinessStatus": "Normal",
  "Name": "test",
  "DisasterRecoveryInternetIp": "116.11.XX.XX",
  "DisasterRecoveryVSwitchId": "vsw-p0w95ql6tmr2ludkt****",
  "SslVpnInternetIp": "116.33.XX.XX",
  "ResourceGroupId": "rg-acfmzs372yg****"
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	InvalidName	The name is not valid
400	InvalidDescription	The description is not valid
400	OperationUnsupported.EnableBgp	Current version of the VPN does not support enable BGP.	Wilayah saat ini tidak mendukung pengaktifan BGP.
400	OperationFailed.VpnConnectionExist	Auto propagate cannot be closed when VPN connections with BGP enabled exist.	Propagasi perutean otomatis tidak dapat dinonaktifkan ketika koneksi VPN dengan BGP yang diaktifkan ada.
400	InvalidVpnGatewayInstanceId.NotFound	The specified vpn gateway instance id does not exist.	Gateway VPN yang ditentukan tidak ada. Periksa apakah Gateway VPN sudah benar.
400	VpnGateway.Configuring	The specified service is configuring.
400	OperationFailed.CenLevelNotSupport	When the VPC to which the VPN gateway belongs is attached to a FULL-mode CEN, the VPN gateway cannot enable BGP.	BGP tidak dapat diaktifkan pada Gateway VPN ketika VPC tempat Gateway VPN berada telah bergabung dengan Instans CEN dengan Sinkronisasi rute diaktifkan.
400	OperationFailed.VpcRoutePropagationDisable	The VPC system routing table does not enable the acceptance of propagated routes.	Tabel rute sistem VPC tidak memiliki propagasi entri rute yang diaktifkan.
400	OperationFailed.VpcRoutePublishEnabledInTR	A VPC supports at most one dynamic route learning source. In the forwarding router, disable route synchronization for the VPC.	VPC hanya mendukung satu sumber pembelajaran Rute dinamis. Nonaktifkan sinkronisasi entri rute untuk VPC ini di router transit.
400	OperationFailed.VpcRoutePublishEnabledInECR	VPC supports only one dynamic route learning source at most. Please remove the VPC from ECR.	VPC hanya mendukung satu sumber pembelajaran Rute dinamis. Hapus VPC dari ECR.
400	OperationFailed.BondingVpnNotSupportBGP	The architecture does not support BGP capabilities (single tunnel bonding architecture VPN gateway).	Arsitektur tidak mendukung kemampuan BGP (Gateway VPN arsitektur bonding saluran data tunggal).
400	OperationFailed.StaleBGPRoutes	BGP routes are still there and automatic route propagation cannot be disabled.	Entri rute BGP masih ada. Propagasi otomatis tidak dapat dinonaktifkan.
403	Forbidden.SubUser	User not authorized to operate on the specified resource as your account is created by another user.	Anda tidak memiliki izin untuk beroperasi pada Sumber daya ini. Ajukan izin yang diperlukan dan coba lagi.
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	InvalidVpnGatewayInstanceId.NotFound	The specified vpn gateway instance id does not exist.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.