Membuat koneksi IPsec-VPN dengan memanggil operasi CreateVpnConnection.
Deskripsi operasi
-
Jika instans VPN gateway mendukung pembuatan koneksi IPsec-VPN dalam mode tunnel ganda, Anda dapat mengonfigurasi parameter permintaan berikut selain parameter yang wajib diisi saat memanggil operasi
CreateVpnConnection:ClientToken, Name, EffectImmediately, AutoConfigRoute, array Tags, array TunnelOptionsSpecification, dan EnableTunnelsBgp.
Untuk informasi tentang region dan zona yang mendukung koneksi IPsec-VPN dalam mode tunnel ganda, lihat Meningkatkan koneksi IPsec-VPN ke mode tunnel ganda.
-
Jika instans VPN gateway hanya mendukung pembuatan koneksi IPsec-VPN dalam mode tunnel tunggal, Anda dapat mengonfigurasi parameter permintaan berikut selain parameter yang wajib diisi saat memanggil operasi
CreateVpnConnection:ClientToken, CustomerGatewayId, Name, EffectImmediately, IkeConfig, IpsecConfig, HealthCheckConfig, AutoConfigRoute, EnableDpd, EnableNatTraversal, BgpConfig, RemoteCaCertificate, dan array Tags.
-
Operasi CreateVpnConnection bersifat asinkron. Setelah Anda mengirim permintaan, sistem mengembalikan ID instans, tetapi koneksi IPsec-VPN belum dibuat. Tugas pembuatan masih berjalan di latar belakang. Anda dapat memanggil DescribeVpnGateway untuk menanyakan status instans VPN gateway guna menentukan status pembuatan koneksi IPsec-VPN:
Jika instans VPN gateway dalam status updating, koneksi IPsec-VPN sedang dibuat.
Jika instans VPN gateway dalam status active, koneksi IPsec-VPN telah dibuat.
-
Operasi CreateVpnConnection tidak mendukung pembuatan koneksi IPsec-VPN secara bersamaan di bawah VPN gateway yang sama.
Coba sekarang
Test
RAM authorization
Parameter permintaan
|
Parameter |
Type |
Required |
Description |
Example |
| RegionId |
string |
Yes |
ID region koneksi IPsec-VPN. Anda dapat memanggil operasi DescribeRegions untuk menanyakan daftar region terbaru. |
cn-shanghai |
| 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. |
02fb3da4-130e-11e9-8e44-001**** |
| CustomerGatewayId |
string |
No |
Parameter ini didukung saat Anda membuat koneksi IPsec-VPN dalam mode tunnel tunggal, dan parameter ini wajib diisi. ID customer gateway. |
cgw-p0w2jemrcj5u61un8**** |
| VpnGatewayId |
string |
Yes |
ID instans VPN gateway. |
vpn-bp1q8bgx4xnkm**** |
| Name |
string |
No |
Nama koneksi IPsec-VPN. Nama harus terdiri dari 1 hingga 100 karakter dan tidak boleh diawali dengan |
IPsec |
| LocalSubnet |
string |
Yes |
Blok CIDR di sisi VPC yang perlu berkomunikasi dengan pusat data lokal. Blok CIDR ini digunakan dalam negosiasi Fase 2. Pisahkan beberapa blok CIDR dengan koma (,). Contoh: 192.168.1.0/24,192.168.2.0/24. Mode routing berikut didukung untuk koneksi IPsec-VPN:
|
10.10.1.0/24,10.10.2.0/24 |
| RemoteSubnet |
string |
Yes |
Blok CIDR di sisi pusat data lokal yang perlu berkomunikasi dengan VPC. Blok CIDR ini digunakan dalam negosiasi Fase 2. Pisahkan beberapa blok CIDR dengan koma (,). Contoh: 192.168.3.0/24,192.168.4.0/24. Mode routing berikut didukung untuk koneksi IPsec-VPN:
|
10.10.3.0/24,10.10.4.0/24 |
| EffectImmediately |
boolean |
No |
Menentukan apakah konfigurasi koneksi IPsec-VPN segera berlaku. Nilai yang valid:
|
false |
| IkeConfig |
string |
No |
Parameter ini didukung saat Anda membuat koneksi IPsec-VPN dalam mode tunnel tunggal. 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 Anda membuat koneksi IPsec-VPN dalam mode tunnel tunggal. Konfigurasi negosiasi Fase 2:
|
{"IpsecEncAlg":"aes","IpsecAuthAlg":"sha1","IpsecPfs":"group2","IpsecLifetime":86400} |
| HealthCheckConfig |
string |
No |
Parameter ini didukung saat Anda membuat koneksi IPsec-VPN dalam mode tunnel tunggal. Konfigurasi pemeriksaan kesehatan:
|
{"enable":"true","dip":"192.168.10.1","sip":"10.10.1.1","interval":"3","retry":"3"} |
| AutoConfigRoute |
boolean |
No |
Menentukan apakah akan mengonfigurasi rute secara otomatis. Nilai yang valid:
|
true |
| EnableDpd |
boolean |
No |
Parameter ini didukung saat Anda membuat koneksi IPsec-VPN dalam mode tunnel tunggal. Menentukan apakah akan mengaktifkan fitur Dead Peer Detection (DPD). Nilai yang valid:
|
true |
| EnableNatTraversal |
boolean |
No |
Parameter ini didukung saat Anda membuat koneksi IPsec-VPN dalam mode tunnel tunggal. Menentukan apakah akan mengaktifkan NAT traversal. Nilai yang valid:
|
true |
| BgpConfig |
string |
No |
Parameter ini didukung saat Anda membuat koneksi IPsec-VPN dalam mode tunnel tunggal. Konfigurasi BGP:
Catatan
|
{"EnableBgp":"true","LocalAsn":"45104","TunnelCidr":"169.254.11.0/30","LocalBgpIp":"169.254.11.1"} |
| RemoteCaCertificate |
string |
No |
Parameter ini didukung saat Anda membuat koneksi IPsec-VPN dalam mode tunnel tunggal. Jika instans VPN gateway saat ini adalah VPN gateway berbasis SM Nasional, Anda harus mengonfigurasi sertifikat CA peer.
|
-----BEGIN CERTIFICATE----- MIIB7zCCAZW**** -----END CERTIFICATE----- |
| 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 ditentukan, kunci tag tidak boleh berupa string kosong. Kunci tag dapat terdiri hingga 64 karakter dan tidak boleh diawali 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. Nilai tidak boleh diawali dengan Setiap kunci tag memiliki satu nilai tag yang sesuai. Anda dapat menentukan hingga 20 nilai tag sekaligus. |
TagValue |
| TunnelOptionsSpecification |
array<object> |
No |
Konfigurasi tunnel.
|
|
|
array<object> |
No |
Konfigurasi tunnel. |
||
| CustomerGatewayId |
string |
No |
ID customer gateway yang terkait dengan tunnel. Catatan
|
cgw-p0wy363lucf1uyae8**** |
| EnableDpd |
boolean |
No |
Menentukan apakah akan mengaktifkan fitur Dead Peer Detection (DPD) untuk tunnel. Nilai yang valid:
|
true |
| EnableNatTraversal |
boolean |
No |
Menentukan apakah akan mengaktifkan NAT traversal untuk tunnel. Nilai yang valid:
|
true |
| RemoteCaCertificate |
string |
No |
Jika instans VPN gateway saat ini adalah VPN gateway berbasis SM Nasional, Anda harus mengonfigurasi sertifikat CA peer untuk tunnel.
|
-----BEGIN CERTIFICATE----- MIIB7zCCAZW**** -----END CERTIFICATE----- |
| Role |
string |
No |
Peran tunnel. Nilai yang valid:
|
master |
| TunnelBgpConfig |
object |
No |
Konfigurasi BGP untuk tunnel. |
|
| LocalAsn |
integer |
No |
Nomor sistem otonom (ASN) di ujung lokal (sisi Alibaba Cloud) tunnel. Nilai yang valid: 1 hingga 4294967295. Nilai default: 45104. Catatan
|
65530 |
| LocalBgpIp |
string |
No |
Alamat BGP di ujung lokal (sisi Alibaba Cloud) tunnel. Alamat ini merupakan alamat IP dalam blok CIDR BGP tunnel. |
169.254.10.1 |
| TunnelCidr |
string |
No |
Blok CIDR BGP tunnel. Blok CIDR harus merupakan blok CIDR dalam 169.254.0.0/16 dengan panjang mask 30 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 BGP dari setiap tunnel di bawah instans VPN gateway harus unik. |
169.254.10.0/30 |
| TunnelIkeConfig |
object |
No |
Konfigurasi negosiasi Fase 1. |
|
| IkeAuthAlg |
string |
No |
Algoritma autentikasi yang digunakan dalam negosiasi Fase 1. Nilai yang valid: md5, sha1, sha256, sha384, dan sha512. Nilai default: md5. . |
md5 |
| IkeEncAlg |
string |
No |
Algoritma enkripsi yang digunakan dalam negosiasi Fase 1. Nilai yang valid: aes, aes192, aes256, des, dan 3des. Nilai default: aes. . |
aes |
| IkeLifetime |
integer |
No |
Masa berlaku SA yang dinegosiasikan dalam 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 dan aggressive. Nilai default: main.
. |
main |
| IkePfs |
string |
No |
Algoritma pertukaran kunci Diffie-Hellman yang digunakan dalam negosiasi Fase 1. Nilai default: group2. |
group2 |
| IkeVersion |
string |
No |
Versi protokol IKE. Nilai yang valid: ikev1 dan ikev2. Nilai default: ikev1. Dibandingkan dengan IKEv1, IKEv2 menyederhanakan proses negosiasi SA dan memberikan dukungan yang lebih baik untuk skenario multi-blok-CIDR. . |
ikev1 |
| LocalId |
string |
No |
Pengidentifikasi ujung lokal (sisi Alibaba Cloud) tunnel, yang digunakan dalam negosiasi Fase 1. Pengidentifikasi dapat terdiri hingga 100 karakter dan tidak boleh mengandung spasi. Nilai default adalah alamat IP tunnel. LocalId mendukung format FQDN. Jika Anda menggunakan format FQDN, kami sarankan Anda mengatur mode negosiasi ke aggressive. |
47.21.XX.XX |
| Psk |
string |
No |
Kunci pra-berbagi yang digunakan untuk autentikasi identitas antara tunnel dan peer tunnel.
Catatan
Kunci pra-berbagi tunnel harus sama dengan kunci pra-berbagi peer tunnel. Jika tidak, tunnel tidak dapat dibuat. |
123456**** |
| RemoteId |
string |
No |
Pengidentifikasi peer tunnel, yang digunakan dalam negosiasi Fase 1. Pengidentifikasi dapat terdiri hingga 100 karakter dan tidak boleh mengandung spasi. Nilai default adalah 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.42.XX.XX |
| TunnelIpsecConfig |
object |
No |
Konfigurasi negosiasi Fase 2. |
|
| IpsecAuthAlg |
string |
No |
Algoritma autentikasi yang digunakan dalam negosiasi Fase 2. Nilai yang valid: md5, sha1, sha256, sha384, dan sha512. Nilai default: md5. . |
md5 |
| IpsecEncAlg |
string |
No |
Algoritma enkripsi yang digunakan dalam negosiasi Fase 2. Nilai yang valid: aes, aes192, aes256, des, dan 3des. Nilai default: aes. . |
aes |
| IpsecLifetime |
integer |
No |
Masa berlaku SA yang dinegosiasikan dalam 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, dan group14. |
group2 |
| EnableTunnelsBgp |
boolean |
No |
Parameter ini didukung saat Anda membuat koneksi IPsec-VPN dalam mode tunnel ganda. Menentukan apakah akan mengaktifkan BGP untuk tunnel. Nilai yang valid: true dan false (default). |
true |
| DryRun |
boolean |
No |
Menentukan apakah akan melakukan uji coba. Nilai yang valid:
|
false |
Elemen respons
|
Element |
Type |
Description |
Example |
|
object |
Parameter respons. |
||
| RequestId |
string |
ID permintaan. |
082AD562-B8DB-4BB2-861F-DA1FCA01FD76 |
| VpnConnectionId |
string |
ID koneksi IPsec-VPN. |
vco-bp15oes1py4i6**** |
| Name |
string |
Nama koneksi IPsec-VPN. |
test |
| CreateTime |
integer |
Stempel waktu saat koneksi IPsec-VPN dibuat. Unit: milidetik. Stempel waktu mengikuti format UNIX dan mewakili jumlah milidetik yang telah berlalu sejak 1 Januari 1970, 00:00:00 UTC. |
1544666102000 |
Contoh
Respons sukses
JSONformat
{
"RequestId": "082AD562-B8DB-4BB2-861F-DA1FCA01FD76",
"VpnConnectionId": "vco-bp15oes1py4i6****",
"Name": "test",
"CreateTime": 1544666102000
}
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 | VpnGateway.Configuring | The specified service is configuring. | |
| 400 | VpnGateway.FinancialLocked | The specified service is financial locked. | |
| 400 | VpnGateway.IpsecVpnDisabled | The vpn gateway does not enable IPSec VPN. | |
| 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.ConflictSSL | The specified route entry has conflict with SSL client. | |
| 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 | OperationUnsupported.SetDPD | Current version of the VPN does not support setting DPD. | |
| 400 | OperationUnsupported.SetNatTraversal | Current version of the VPN does not support setting NAT traversal. | |
| 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 version of the VPN 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 | IllegalParam.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 gateway has not associated any certificates. | |
| 400 | MissingParam.RemoteId | The remote ID is mandatory when creating national standard VPN connection. | |
| 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. | |
| 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 | 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 | VpnConnectionParamInvalid.SameVpnAndCgwDifferentIkeConfigs | IPSec connections associated with the same user gateway and VPN gateway should have the same pre-shared key and IKE configuration. | |
| 400 | VpnConnectionParamInvalid.SameVpnAndCgwTrafficSelectorOverlap | Traffic selectors of IPSec connections associated with the same user gateway and VPN gateway should not overlap. | |
| 400 | CustomerGateway.ConflictVpnIp | The customer gateway associated with the IPSec connection should not have the same IP address as the VPN gateway. | |
| 400 | VpnGateway.IPsecServerAndVpnConnectionConflict | The IPSec connection and IPSec server cannot be configured on the same VPN gateway at the same time. | |
| 400 | InvalidSslVpnServerCertId.NotFound | The parameter is incorrect. The corresponding SSL VPN server certificate cannot be found. | |
| 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 | CreatePbrRoutesQuotaFull.QuotaFull | The number of policy routes exceeds the quota limit. | |
| 400 | CreateVpnConnectionsQuotaFull.QuotaFull | The number of VPN connections exceeds the quota limit. | |
| 400 | DryRunOperation | Request validation has been passed with DryRun flag set. | |
| 400 | OperationFailed.OpenCdtServiceFirst | The operation is failed because of %s. | |
| 400 | EncAlgInvalid.DesIncompatible | Des/3des in IkeEncAlg and IpsecEncAlg does not support multi algorithm. | |
| 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. | |
| 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.