Memanggil operasi CreateVpnAttachment untuk membuat koneksi IPsec-VPN yang diikat ke instans transit router.
Deskripsi operasi
-
Dalam skenario pengikatan ke transit router, koneksi IPsec-VPN telah ditingkatkan ke mode dual-tunnel. Saat membuat koneksi IPsec-VPN, selain parameter wajib, hanya parameter permintaan mode dual-tunnel berikut yang didukung: ClientToken, Name, NetworkType, EffectImmediately, array Tags, ResourceGroupId, array TunnelOptionsSpecification, dan EnableTunnelsBgp. Untuk informasi lebih lanjut, lihat Penjelasan koneksi IPsec-VPN dual-tunnel untuk skenario pengikatan ke transit router.
-
Koneksi IPsec-VPN yang dibuat dengan memanggil operasi
CreateVpnAttachmenttidak terikat ke sumber daya apa pun secara default. Selanjutnya, Anda dapat memanggil operasi CreateTransitRouterVpnAttachment untuk mengikat koneksi IPsec-VPN ke instans transit router. Setelah diikat ke instans transit router, sistem akan menetapkan alamat IP gateway ke koneksi IPsec-VPN. Anda dapat memanggil operasi DescribeVpnConnection untuk melihatnya.
Prasyarat
Sebelum membuat koneksi IPsec-VPN, pastikan Anda telah membuat customer gateway di wilayah tempat koneksi IPsec-VPN berada. Untuk informasi lebih lanjut, lihat CreateCustomerGateway.
Jika Anda perlu menambahkan konfigurasi BGP ke koneksi IPsec-VPN, pastikan customer gateway telah dikonfigurasi dengan ASN.
Coba sekarang
Test
RAM authorization
Parameter permintaan
|
Parameter |
Type |
Required |
Description |
Example |
| RegionId |
string |
Yes |
ID wilayah koneksi IPsec-VPN. Anda dapat memanggil operasi DescribeRegions untuk menanyakan ID wilayah. |
cn-hangzhou |
| Name |
string |
No |
Nama koneksi IPsec-VPN. Nama harus terdiri dari 1 hingga 100 karakter dan tidak boleh dimulai dengan |
nametest |
| CustomerGatewayId |
string |
No |
ID customer gateway. Catatan
Parameter ini hanya diperlukan saat Anda membuat koneksi IPsec-VPN single-tunnel, dan wajib dalam kasus tersebut. |
cgw-p0w2jemrcj5u61un8**** |
| NetworkType |
string |
No |
Jenis jaringan koneksi IPsec-VPN. Nilai yang valid:
|
public |
| LocalSubnet |
string |
Yes |
Blok CIDR di sisi VPC yang perlu berkomunikasi dengan pusat data lokal. Ini digunakan untuk negosiasi Fase 2. Pisahkan beberapa blok CIDR dengan koma (,). Contoh: 192.168.1.0/24,192.168.2.0/24. Catatan tentang mode routing koneksi IPsec-VPN:
|
10.1.1.0/24,10.1.2.0/24 |
| RemoteSubnet |
string |
Yes |
Blok CIDR di sisi pusat data lokal yang perlu berkomunikasi dengan VPC. Ini digunakan untuk negosiasi Fase 2. Pisahkan beberapa blok CIDR dengan koma (,). Contoh: 192.168.3.0/24,192.168.4.0/24. Catatan tentang mode routing koneksi IPsec-VPN:
|
10.1.3.0/24,10.1.4.0/24 |
| EffectImmediately |
boolean |
No |
Menentukan apakah konfigurasi koneksi IPsec-VPN langsung berlaku. Nilai yang valid:
|
false |
| IkeConfig |
string |
No |
Parameter ini didukung saat membuat koneksi IPsec-VPN single-tunnel. Konfigurasi negosiasi Fase 1:
|
{"Psk":"1234****","IkeVersion":"ikev1","IkeMode":"main","IkeEncAlg":"aes","IkeAuthAlg":"sha1","IkePfs":"group2","IkeLifetime":86400,"LocalId":"47.XX.XX.1","RemoteId":"47.XX.XX.2"} |
| IpsecConfig |
string |
No |
Parameter ini didukung saat membuat koneksi IPsec-VPN single-tunnel. Konfigurasi negosiasi Fase 2:
|
{"IpsecEncAlg":"aes","IpsecAuthAlg":"sha1","IpsecPfs":"group2","IpsecLifetime":86400} |
| BgpConfig |
string |
No |
Parameter ini didukung saat membuat koneksi IPsec-VPN single-tunnel. Konfigurasi BGP:
Catatan
|
{"EnableBgp":"true","LocalAsn":"45104","TunnelCidr":"169.254.11.0/30","LocalBgpIp":"169.254.11.1"} |
| HealthCheckConfig |
string |
No |
Parameter ini didukung saat membuat koneksi IPsec-VPN single-tunnel. Konfigurasi health check:
|
{"enable":"true","dip":"192.168.1.1","sip":"10.1.1.1","interval":"3","retry":"3","Policy": "revoke_route"} |
| AutoConfigRoute |
boolean |
No |
Menentukan apakah akan mengonfigurasi rute secara otomatis. Nilai yang valid:
|
true |
| EnableDpd |
boolean |
No |
Parameter ini didukung saat membuat koneksi IPsec-VPN single-tunnel. Menentukan apakah akan mengaktifkan fitur Dead Peer Detection (DPD). Nilai yang valid:
|
true |
| EnableNatTraversal |
boolean |
No |
Parameter ini didukung saat membuat koneksi IPsec-VPN single-tunnel. Menentukan apakah akan mengaktifkan NAT traversal. Nilai yang valid:
|
true |
| RemoteCaCert |
string |
No |
Sertifikat CA dari peer. Catatan
Parameter ini saat ini tidak berlaku. |
-----BEGIN CERTIFICATE----- MIIB7zCCAZW**** -----END CERTIFICATE----- |
| 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 klien hanya dapat 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**** |
| Tags |
array<object> |
No |
Daftar tag yang akan ditambahkan ke koneksi IPsec-VPN. Anda dapat menambahkan hingga 20 tag ke koneksi IPsec-VPN sekaligus. |
|
|
object |
No |
Informasi tag. |
||
| Key |
string |
No |
Kunci tag. Setelah nilai ditentukan, tidak boleh berupa string kosong. Kunci tag dapat terdiri hingga 64 karakter dan tidak boleh dimulai dengan Anda dapat menentukan hingga 20 kunci tag sekaligus. |
TagKey |
| Value |
string |
No |
Nilai tag. Nilai tag dapat terdiri hingga 128 karakter dan dapat berupa string kosong. Tidak boleh dimulai dengan Setiap kunci tag sesuai dengan satu nilai tag. Anda dapat menentukan hingga 20 nilai tag sekaligus. |
TagValue |
| ResourceGroupId |
string |
No |
ID grup sumber daya tempat koneksi IPsec-VPN berada.
|
rg-acfmzs372yg**** |
| TunnelOptionsSpecification |
array<object> |
No |
Konfigurasi tunnel.
|
|
|
array<object> |
No |
Informasi konfigurasi tunnel. |
||
| CustomerGatewayId |
string |
No |
ID customer gateway yang terkait dengan tunnel. Catatan
Parameter ini diperlukan saat membuat koneksi IPsec-VPN dual-tunnel. |
cgw-p0w2jemrcj5u61un8**** |
| EnableDpd |
boolean |
No |
Menentukan apakah akan mengaktifkan DPD (Dead Peer Detection) untuk tunnel. Nilai yang valid:
|
true |
| EnableNatTraversal |
boolean |
No |
Menentukan apakah akan mengaktifkan NAT traversal untuk tunnel. Nilai yang valid:
|
true |
| TunnelIndex |
integer |
No |
Urutan pembuatan tunnel.
|
1 |
| TunnelBgpConfig |
object |
No |
Konfigurasi BGP untuk tunnel. Catatan
Parameter ini diperlukan ketika BGP diaktifkan untuk koneksi IPsec-VPN (ketika parameter EnableTunnelsBgp diatur ke true). |
|
| LocalAsn |
integer |
No |
Autonomous system number (ASN) di sisi lokal (Alibaba Cloud) tunnel. Nilai yang valid: 1 hingga 4294967295. Nilai default: 45104. Catatan
Kami sarankan Anda menggunakan ASN privat untuk membuat koneksi BGP dengan Alibaba Cloud. Lihat dokumentasi terkait untuk rentang ASN privat. |
65530 |
| LocalBgpIp |
string |
No |
Alamat BGP di sisi lokal (Alibaba Cloud) tunnel. Alamat ini harus berupa alamat IP dalam blok CIDR BGP. |
169.254.10.1 |
| TunnelCidr |
string |
No |
Blok CIDR BGP tunnel. Blok CIDR harus berupa subnet /30 dalam 169.254.0.0/16 dan tidak boleh 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 tunnel dari dua tunnel di bawah koneksi IPsec-VPN yang sama harus berbeda. |
169.254.10.0/30 |
| TunnelIkeConfig |
object |
No |
Konfigurasi negosiasi Fase 1. |
|
| IkeAuthAlg |
string |
No |
Algoritma autentikasi untuk negosiasi Fase 1. Nilai yang valid: md5, sha1, sha256, sha384, sha512. Nilai default: sha1. |
sha1 |
| IkeEncAlg |
string |
No |
Algoritma enkripsi untuk negosiasi Fase 1. Nilai yang valid: aes, aes192, aes256, des, atau 3des. Nilai default: aes. |
aes |
| IkeLifetime |
integer |
No |
Masa berlaku SA yang dihasilkan oleh negosiasi Fase 1. Unit: detik. Nilai yang valid: 0 hingga 86400. Nilai default: 86400. |
86400 |
| IkeMode |
string |
No |
Mode negosiasi versi IKE. Nilai yang valid: main atau aggressive. Nilai default: main.
|
main |
| IkePfs |
string |
No |
Algoritma pertukaran kunci Diffie-Hellman yang digunakan dalam negosiasi Fase 1. Nilai default: group2. Nilai yang valid: group1, group2, group5, group14. |
group2 |
| IkeVersion |
string |
No |
Versi protokol IKE. Nilai yang valid: ikev1 atau ikev2. Nilai default: ikev2. Dibandingkan dengan IKEv1, IKEv2 menyederhanakan proses negosiasi SA dan memberikan dukungan yang lebih baik untuk skenario multi-blok-CIDR. |
ikev2 |
| LocalId |
string |
No |
Pengidentifikasi di sisi lokal (Alibaba Cloud) tunnel, digunakan untuk negosiasi Fase 1. Pengidentifikasi maksimal 100 karakter dan tidak boleh mengandung spasi. Nilai default: alamat IP tunnel. LocalId mendukung format FQDN. Jika Anda menggunakan format FQDN, kami sarankan Anda mengatur mode negosiasi ke aggressive. |
47.XX.XX.1 |
| Psk |
string |
No |
Kunci pra-berbagi yang digunakan untuk autentikasi identitas antara tunnel dan peer tunnel.
Catatan
Kunci pra-berbagi tunnel dan peer tunnel harus sama. Jika tidak, sistem tidak dapat membuat tunnel. |
123456**** |
| RemoteId |
string |
No |
Pengidentifikasi di sisi peer tunnel, digunakan untuk negosiasi Fase 1. Pengidentifikasi maksimal 100 karakter dan tidak boleh mengandung spasi. Nilai default: alamat IP customer gateway yang terkait dengan tunnel. RemoteId mendukung format FQDN. Jika Anda menggunakan format FQDN, kami sarankan Anda mengatur mode negosiasi ke aggressive. |
47.XX.XX.2 |
| TunnelIpsecConfig |
object |
No |
Konfigurasi negosiasi Fase 2. |
|
| IpsecAuthAlg |
string |
No |
Algoritma autentikasi untuk negosiasi Fase 2. Nilai yang valid: md5, sha1, sha256, sha384, sha512. Nilai default: sha1. |
sha1 |
| IpsecEncAlg |
string |
No |
Algoritma enkripsi untuk negosiasi Fase 2. Nilai yang valid: aes, aes192, aes256, des, atau 3des. Nilai default: aes. |
aes |
| IpsecLifetime |
integer |
No |
Masa berlaku SA yang dihasilkan oleh negosiasi Fase 2. Unit: detik. Nilai yang valid: 0 hingga 86400. Nilai default: 86400. |
86400 |
| IpsecPfs |
string |
No |
Algoritma pertukaran kunci Diffie-Hellman yang digunakan dalam negosiasi Fase 2. Nilai default: group2. Nilai yang valid: disabled, group1, group2, group5, group14. |
group2 |
| EnableTunnelsBgp |
boolean |
No |
Parameter ini didukung saat membuat koneksi IPsec-VPN dual-tunnel. Menentukan apakah akan mengaktifkan BGP untuk tunnel. Nilai yang valid: true atau false (default). Catatan
Sebelum mengonfigurasi BGP, kami sarankan Anda mempelajari mekanisme kerja dan batasan fitur routing dinamis BGP. Untuk informasi lebih lanjut, lihat Konfigurasi routing dinamis BGP. |
false |
| DryRun |
boolean |
No |
Menentukan apakah hanya melakukan dry run, tanpa menjalankan permintaan yang sebenarnya. Nilai yang valid:
|
false |
| TunnelBandwidth |
string |
No |
Spesifikasi bandwidth tunnel VPN tunggal. Nilai yang valid: Standard (default): Tipe standar, dengan bandwidth default 1 Gbps. Large: Tipe besar, dengan bandwidth default 3 Gbps. |
Standard |
Elemen respons
|
Element |
Type |
Description |
Example |
|
object |
Parameter respons. |
||
| RequestId |
string |
ID permintaan. |
88187252-0E26-3C4D-9D1D-32A04454EBBA |
| VpnConnectionId |
string |
ID koneksi IPsec-VPN. |
vco-p0wb09rama8qwwgfn**** |
| Name |
string |
Nama koneksi IPsec-VPN. |
nametest |
| CreateTime |
integer |
Timestamp saat koneksi IPsec-VPN dibuat. Unit: milidetik. Timestamp mengikuti format waktu Unix, yang merepresentasikan jumlah total milidetik yang telah berlalu sejak 1 Januari 1970, 00:00:00 UTC hingga waktu pembuatan koneksi IPsec-VPN. |
1658201810000 |
| Code |
string |
Kode status yang dikembalikan oleh tugas saat ini. 200 menunjukkan bahwa tugas berhasil. |
200 |
| Message |
string |
Pesan yang dikembalikan oleh tugas saat ini. |
successful |
| Success |
boolean |
Menunjukkan apakah tugas saat ini berhasil dijalankan.
|
true |
Contoh
Respons sukses
JSONformat
{
"RequestId": "88187252-0E26-3C4D-9D1D-32A04454EBBA",
"VpnConnectionId": "vco-p0wb09rama8qwwgfn****",
"Name": "nametest",
"CreateTime": 1658201810000,
"Code": "200",
"Message": "successful",
"Success": true
}
Kode kesalahan
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | Resource.QuotaFull | The quota of resource is full | |
| 400 | InvalidVpnConnection.AlreadyExists | Vpn connection already exists. | |
| 400 | VpnRouteEntry.AlreadyExists | The specified route entry is already exist. | |
| 400 | VpnRouteEntry.Conflict | The specified route entry has conflict. | |
| 400 | NotSupportVpnConnectionParameter.IpsecPfs | The specified vpn connection ipsec Ipsec Pfs is not support. | |
| 400 | NotSupportVpnConnectionParameter.IpsecAuthAlg | The specified vpn connection ipsec Auth Alg is not support. | |
| 400 | VpnRouteEntry.BackupRoute | Validate backup route entry failed. | |
| 400 | VpnRouteEntry.InvalidWeight | Invalid route entry weight value. | |
| 400 | InvalidParameter.VpnConnectionName | The specified vpn connection name is invalid. | |
| 400 | QuotaExceeded.PolicyBasedRoute | The maximum number of policy-based routes is exceeded. Existing routes: %s. Routes to be created: %s. Maximum routes: %s. | |
| 400 | MissingParameter.TunnelCidr | The parameter TunnelCidr is mandatory when BGP is enabled. | |
| 400 | OperationUnsupported.EnableBgp | Current region does not support enable BGP. | |
| 400 | MissingParam.CustomerGatewayAsn | Asn of customer gateway is mandatory when BGP is enabled. | |
| 400 | IllegalParam.LocalAsn | The specified LocalAsn is invalid. | |
| 400 | InvalidParameter.BgpConfig | The specified BgpConfig is invalid. | |
| 400 | IllegalParam.EnableBgp | VPN connection must enable BGP when VPN gateway has enabled BGP. | |
| 400 | IllegalParam.TunnelCidr | The specified TunnelCidr is invalid. | |
| 400 | InvalidLocalBgpIp.Malformed | The specified LocalBgpIp is malformed. | |
| 400 | IllegalParam.LocalBgpIp | The specified LocalBgpIp is invalid. | |
| 400 | IllegalParam.LocalSubnet | The specified "LocalSubnet" (%s) is invalid. | |
| 400 | IllegalParam.RemoteSubnet | The specified "RemoteSubnet" (%s) is invalid. | |
| 400 | OperationFailed.MissCertificate | The VPN connecton has not associated any certificates. | |
| 400 | MissingParam.RemoteId | The remote ID is mandatory when creating national standard VPN connection. | |
| 400 | CustomerGateway.ConflictRouteEntry | The specified customer gateway has conflict with route entry. | |
| 400 | VpnTask.CONFLICT | Vpn task has conflict. | |
| 400 | Forbidden.TagKey.Duplicated | The specified tag key already exists. | |
| 400 | OperationFailed.NoAvailableAmount | The available amount of your account is less than 0, please recharge before attempting to purchase. | |
| 400 | SizeLimitExceeded.TagNum | The maximum number of tags is exceeded. | |
| 400 | InvalidParameter.TagValue | The specified parameter TagValue is invalid. | |
| 400 | InvalidParameter.TagKey | The specified parameter TagKey is invalid. | |
| 400 | Duplicated.TagKey | The specified parameter TagKey is duplicated. | |
| 400 | InternalError | The request processing has failed due to some unknown error, exception or failure. | |
| 400 | InvalidTunnelCidr.Malformed | The specified TunnelCidr is malformed. | |
| 400 | CustomerGateway.ConflictVpnIp | The customer gateway associated with the IPSec connection should not have the same IP address as the VPN gateway. | |
| 400 | MissingParameter.TunnelOptionsSpecification | The required parameters are missing when creating a tunnel for dual-tunnel VPN. | |
| 400 | CreateDbrRoutesQuotaFull.QuotaFull | The number of created destination routes exceeds the quota limit. | |
| 400 | DryRunOperation | Request validation has been passed with DryRun flag set. | |
| 400 | VpnConnection.InvalidCreateTunnelOptions | The master and slave tunnels must be created at the same time. | |
| 400 | OperationUnsupported.LargeTunnelBandwidth | Large tunnelBandwidth VpnAttachment is unsupported. | |
| 400 | IllegalParam.TunnelBandwidth | TunnelBandwidth is illegal. | |
| 400 | EncAlgInvalid.DesIncompatible | Des/3des in IkeEncAlg and IpsecEncAlg does not support multi algorithm. | |
| 400 | OperationFailed.OpenCdtServiceFirst | The operation is failed because of %s. | |
| 400 | IkeVersionInvalid.GcmIncompatible | Ikev1 does not support IkeEncAlg of gcm16. | |
| 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. | |
| 404 | InvalidCustomerGatewayInstanceId.NotFound | The specified customer gateway instance id does not exist. |
Lihat Error Codes untuk daftar lengkap.
Catatan rilis
Lihat Release Notes untuk daftar lengkap.