ModifyTunnelAttribute - VPN Gateway - Alibaba Cloud Documentation Center

Memanggil operasi ModifyTunnelAttribute untuk mengubah konfigurasi saluran data pada Gateway VPN ketersediaan tinggi.

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

update

*VpnConnection

acs:vpc:{#regionId}:{#accountId}:vpnconnection/{#VpnConnectionId}

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 Anda harus memastikan bahwa token 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 sebagai ClientToken. RequestId mungkin berbeda untuk setiap permintaan.	02fb3da4-130e-11e9-8e44-0016e04115b
TunnelOptionsSpecification	object	No	Konfigurasi saluran data yang akan diubah.
EnableDpd	boolean	No	Apakah akan mengaktifkan fitur Dead Peer Detection (DPD). Nilai valid: true: Diaktifkan. Inisiator koneksi IPsec-VPN mengirimkan paket DPD untuk memeriksa apakah peer aktif. Jika tidak ada tanggapan yang benar yang diterima dalam periode pengatur waktu yang ditentukan, koneksi gagal. ISAKMP SA dan IPsec SA yang sesuai dihapus, dan saluran data juga dihapus. false: Dinonaktifkan. Inisiator koneksi IPsec-VPN tidak mengirimkan paket DPD.	true
EnableNatTraversal	boolean	No	Apakah akan mengaktifkan Penelusuran NAT. Nilai valid: true: Diaktifkan. Setelah Penelusuran NAT diaktifkan, verifikasi nomor Port UDP dihapus selama negosiasi IKE, dan Perangkat gateway NAT di saluran data VPN dapat ditemukan. false: Dinonaktifkan.	true
RemoteCaCertificate	string	No	Sertifikat CA peer saat Anda menggunakan koneksi IPsec-VPN dengan Gateway VPN SM Tiongkok.	-----BEGIN CERTIFICATE----- MIIB7zCCAZW**** -----END CERTIFICATE-----
TunnelBgpConfig	object	No	Konfigurasi BGP saluran data yang akan diubah. Jika BGP sebelumnya tidak diaktifkan untuk saluran data, panggil operasi ModifyVpnConnectionAttribute untuk mengaktifkan BGP pada saluran data dan menambahkan konfigurasi BGP.
LocalAsn	integer	No	Nomor sistem otonom (ASN) ujung lokal saluran data. Nilai valid: 1 hingga 4294967295.	65530
LocalBgpIp	string	No	Alamat IP BGP ujung lokal saluran data. Alamat IP harus berada dalam Blok CIDR TunnelCidr.	169.254.11.1
TunnelCidr	string	No	Blok CIDR alamat IP BGP pada ujung lokal saluran data. Blok CIDR harus berupa Blok CIDR dengan panjang mask 30 dalam 169.254.0.0/16 dan tidak boleh berupa 169.254.0.0/30, 169.254.1.0/30, 169.254.2.0/30, 169.254.3.0/30, 169.254.4.0/30, 169.254.5.0/30, 169.254.6.0/30, atau 169.254.169.252/30. Catatan Blok CIDR Terowongan IPsec dari setiap koneksi IPsec-VPN di bawah instans Gateway VPN harus unik.	169.254.11.0/30
TunnelIkeConfig	object	No	Konfigurasi fase IKE (Fase 1) saluran data yang akan diubah.
IkeAuthAlg	string	No	Algoritma autentikasi yang digunakan dalam negosiasi Fase 1. Nilai valid: md5, sha1, sha256, sha384, dan sha512. .	sha1
IkeEncAlg	string	No	Algoritma enkripsi yang digunakan dalam negosiasi Fase 1. Nilai valid: aes, aes192, aes256, des, dan 3des. .	aes
IkeLifetime	integer	No	Masa berlaku SA yang dinegosiasikan pada Fase 1. Unit: detik. Nilai valid: 0 hingga 86400.	86400
IkeMode	string	No	Mode negosiasi versi IKE. Nilai valid: main: mode utama. Mode ini menawarkan keamanan tinggi selama negosiasi. aggressive: mode agresif. Mode ini mendukung negosiasi cepat dan laju keberhasilan yang lebih tinggi.	main
IkePfs	string	No	Algoritma pertukaran kunci Diffie-Hellman yang digunakan dalam negosiasi Fase 1. Nilai valid: group1, group2, group5, dan group14.	group2
IkeVersion	string	No	Versi protokol IKE. Nilai valid: ikev1 dan ikev2.	ikev2
LocalId	string	No	Pengidentifikasi ujung lokal saluran data. Pengidentifikasi dapat memiliki panjang hingga 100 karakter dan tidak boleh mengandung spasi. Mendukung format FQDN dan IP. Nilai default: alamat IP saluran data.	47.XX.XX.87
Psk	string	No	Kunci bersama yang digunakan untuk otentikasi identitas antara saluran data dan peer. Kunci harus memiliki panjang 1 hingga 100 karakter dan dapat berisi angka, huruf besar, huruf kecil, serta karakter berikut. Tidak boleh mengandung spasi. ~!`@#$%^&()_-+={}[]\|;:',.<>/? Jika Anda tidak menentukan kunci bersama, sistem menghasilkan string acak sepanjang 16 karakter sebagai kunci bersama. Anda dapat memanggil operasi DescribeVpnConnection untuk mengkueri kunci bersama yang dihasilkan secara otomatis oleh sistem. Catatan* Kunci bersama yang dikonfigurasi pada saluran data dan peer harus sama. Jika tidak, saluran data tidak dapat dibuat.	123456****
RemoteId	string	No	Pengidentifikasi ujung peer saluran data. Pengidentifikasi dapat memiliki panjang hingga 100 karakter dan tidak boleh mengandung spasi. Mendukung format FQDN dan IP. Nilai default: alamat IP instans gateway pelanggan yang dikaitkan dengan saluran data.	47.XX.XX.207
TunnelIpsecConfig	object	No	Konfigurasi fase IPsec (Fase 2) saluran data yang akan diubah.
IpsecAuthAlg	string	No	Algoritma autentikasi yang digunakan dalam negosiasi Fase 2. Nilai valid: md5, sha1, sha256, sha384, dan sha512. .	sha1
IpsecEncAlg	string	No	Algoritma enkripsi yang digunakan dalam negosiasi Fase 2. Nilai valid: aes, aes192, aes256, des, dan 3des. .	aes
IpsecLifetime	integer	No	Masa berlaku SA yang dinegosiasikan pada Fase 2. Unit: detik. Nilai valid: 0 hingga 86400.	86400
IpsecPfs	string	No	Algoritma pertukaran kunci Diffie-Hellman yang digunakan dalam negosiasi Fase 2. Nilai valid: disabled, group1, group2, group5, dan group14.	group2
CustomerGatewayId	string	No	ID instans gateway pelanggan yang dikaitkan dengan saluran data.	cgw-1nmwbpgrp7ssqm1yn****
RegionId	string	No	ID wilayah koneksi IPsec-VPN. Anda dapat memanggil operasi DescribeRegions untuk mengkueri ID wilayah.	cn-hangzhou
VpnConnectionId	string	Yes	ID koneksi IPsec-VPN.	vco-gw69vm1i71y354****
TunnelId	string	Yes	ID saluran data.	tun-gbyz2e070xzo93****

Elemen respons

Element	Type	Description	Example
	object	Parameter tanggapan.
TunnelId	string	ID saluran data.	tun-gbyz2e070xzo93****
RequestId	string	ID permintaan.	E6F36FF0-9544-3AEE-8673-A4647D50064C
TunnelIkeConfig	object	Konfigurasi fase IKE (Fase 1) saluran data.
IkeAuthAlg	string	Algoritma autentikasi IKE.	sha1
IkeEncAlg	string	Algoritma enkripsi IKE.	aes
IkeLifetime	integer	Masa berlaku IKE. Unit: detik.	86400
IkeMode	string	Mode negosiasi IKE. main: mode utama. Mode ini menawarkan keamanan tinggi selama negosiasi. aggressive: mode agresif. Mode ini mendukung negosiasi cepat dan laju keberhasilan yang lebih tinggi.	main
IkePfs	string	Kelompok DH.	group2
IkeVersion	string	Versi protokol IKE. ikev1 ikev2 Dibandingkan dengan IKEv1, IKEv2 menyederhanakan proses negosiasi SA dan memberikan dukungan yang lebih baik untuk skenario multi-Blok CIDR.	ikev2
LocalId	string	Pengidentifikasi ujung lokal saluran data. Mendukung format FQDN dan IP. Nilai default: alamat IP saluran data saat ini.	47.XX.XX.87
Psk	string	Kunci bersama.	123456****
RemoteId	string	Pengidentifikasi ujung peer saluran data. Mendukung format FQDN dan IP. Nilai default: alamat IP instans gateway pelanggan yang dikaitkan dengan saluran data.	47.XX.XX.207
TunnelIpsecConfig	object	Konfigurasi fase IPsec (Fase 2) saluran data.
IpsecAuthAlg	string	Algoritma autentikasi IPsec.	sha1
IpsecEncAlg	string	Algoritma enkripsi IPsec.	aes
IpsecLifetime	integer	Masa berlaku IPsec. Unit: detik.	86400
IpsecPfs	string	Kelompok DH.	group2
TunnelBgpConfig	object	Konfigurasi BGP saluran data.
EnableBgp	boolean	Status aktif BGP. true: Diaktifkan. false: Dinonaktifkan.	true
LocalAsn	integer	Nomor sistem otonom (ASN) ujung lokal saluran data.	65530
LocalBgpIp	string	Alamat IP BGP ujung lokal saluran data.	169.254.11.1
PeerAsn	integer	Nomor sistem otonom (ASN) ujung peer saluran data.	65531
PeerBgpIp	string	Alamat IP BGP ujung peer saluran data.	169.254.11.2
TunnelCidr	string	Blok CIDR alamat IP BGP saluran data.	169.254.11.0/30
EnableNatTraversal	boolean	Apakah Penelusuran NAT diaktifkan. Nilai valid: false: dinonaktifkan. true: diaktifkan.	true
EnableDpd	boolean	Apakah fitur Dead Peer Detection (DPD) diaktifkan. false: dinonaktifkan. true: diaktifkan.	true
RemoteCaCertificate	string	Sertifikat CA peer saat koneksi IPsec-VPN dibuat dengan Gateway VPN SM Tiongkok.	-----BEGIN CERTIFICATE----- MIIB7zCCAZW**** -----END CERTIFICATE-----
CustomerGatewayId	string	ID instans gateway pelanggan yang dikaitkan dengan saluran data.	cgw-p0wx48ayhrygitm80****
Role	string	Peran saluran data. master: saluran data aktif. slave: saluran data cadangan.	master
ZoneNo	string	Zona saluran data.	cn-hangzhou-h
InternetIp	string	Alamat IP saluran data.	47.XX.XX.87
State	string	Status saluran data. active: tersedia. updating: sedang diperbarui. deleting: sedang dihapus.	active

Contoh

Respons sukses

JSONformat

{
  "TunnelId": "tun-gbyz2e070xzo93****",
  "RequestId": "E6F36FF0-9544-3AEE-8673-A4647D50064C",
  "TunnelIkeConfig": {
    "IkeAuthAlg": "sha1",
    "IkeEncAlg": "aes",
    "IkeLifetime": 86400,
    "IkeMode": "main",
    "IkePfs": "group2",
    "IkeVersion": "ikev2",
    "LocalId": "47.XX.XX.87",
    "Psk": "123456****",
    "RemoteId": "47.XX.XX.207"
  },
  "TunnelIpsecConfig": {
    "IpsecAuthAlg": "sha1",
    "IpsecEncAlg": "aes",
    "IpsecLifetime": 86400,
    "IpsecPfs": "group2"
  },
  "TunnelBgpConfig": {
    "EnableBgp": true,
    "LocalAsn": 65530,
    "LocalBgpIp": "169.254.11.1",
    "PeerAsn": 65531,
    "PeerBgpIp": "169.254.11.2",
    "TunnelCidr": "169.254.11.0/30"
  },
  "EnableNatTraversal": true,
  "EnableDpd": true,
  "RemoteCaCertificate": "-----BEGIN CERTIFICATE----- MIIB7zCCAZW**** -----END CERTIFICATE-----",
  "CustomerGatewayId": "cgw-p0wx48ayhrygitm80****",
  "Role": "master",
  "ZoneNo": "cn-hangzhou-h",
  "InternetIp": "47.XX.XX.87",
  "State": "active"
}

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	InvalidName	The name is not valid
400	VpnRouteEntry.AlreadyExists	The specified route entry is already exist.	Entri rute yang ditentukan sudah ada.
400	VpnRouteEntry.Conflict	The specified route entry has conflict.	Entri rute memiliki konflik.
400	NotSupportVpnConnectionParameter.IpsecPfs	The specified vpn connection ipsec Ipsec Pfs is not support.	Parameter Pfs yang ditentukan dalam koneksi IPsec-VPN tidak didukung.
400	NotSupportVpnConnectionParameter.IpsecAuthAlg	The specified vpn connection ipsec Auth Alg is not support.	Algoritma autentikasi yang ditentukan dalam koneksi IPsec-VPN tidak didukung.
400	VpnConnectionParamInvalid.SameVpnAndCgwDifferentIkeConfigs	IPSec connections associated with the same user gateway and VPN gateway should have the same pre-shared key and IKE configuration.	Koneksi IPSec yang terkait dengan gateway pengguna dan gateway VPN yang sama harus memiliki kunci pra-bersama dan konfigurasi IKE yang sama.
400	VpnConnectionParamInvalid.SameVpnAndCgwTrafficSelectorOverlap	Traffic selectors of IPSec connections associated with the same user gateway and VPN gateway should not overlap.	Penyeleksi lalu lintas dari koneksi IPSec yang terkait dengan gateway pengguna dan gateway VPN yang sama tidak boleh tumpang tindih.
400	IllegalParam.LocalAsn	The param of LocalAsn is illegal	Parameter LocalAsn tidak valid.
400	IllegalParam.LocalBgpIp	The specified LocalBgpIp is invalid.	LocalBgpIp yang ditentukan tidak valid.
400	VpnGateway.task.conflict	The VPN is in the configuration state, please wait a while before operating.	VPN dalam status konfigurasi. Silakan coba lagi nanti.
400	ModifyIkeV1WithMultiRoutes.Invalid	Failed to modify VPN connection parameters. Multi-network is configured while using IkeV1 protocol.	Gagal mengubah parameter koneksi VPN. Multi-jaringan dikonfigurasi saat menggunakan protokol IkeV1.
400	EncAlgInvalid.DesIncompatible	Des/3des in IkeEncAlg and IpsecEncAlg does not support multi algorithm.	Des/3des di IkeEncAlg dan IpsecEncAlg tidak mendukung multi algoritma.
400	IkeVersionInvalid.GcmIncompatible	Ikev1 does not support IkeEncAlg of gcm16.	Ikev1 tidak mendukung IkeEncAlg dari gcm16.
400	CustomerGateway.ConflictVpnIp	The specified customer gateway has conflict with vpn gateway ip.	Alamat IP gateway pelanggan bertentangan dengan alamat IP gateway VPN.
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.	Anda tidak berwenang mengelola sumber daya yang ditentukan. Ajukan permohonan izin yang diperlukan dan coba lagi.
404	InvalidVpnConnectionInstanceId.NotFound	The specified vpn connection instance id does not exist.	Koneksi IPsec-VPN yang ditentukan tidak ada. Periksa apakah ID koneksi IPsec-VPN sudah benar.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.