DescribeVpnConnection - VPN Gateway - Alibaba Cloud Documentation Center

Mengambil informasi mengenai koneksi IPsec-VPN tertentu.

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

get

*VpnConnection.

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID wilayah dari koneksi IPsec-VPN. Anda dapat memanggil operasi DescribeRegions untuk menanyakan ID wilayah.	cn-hangzhou
VpnConnectionId	string	Yes	ID koneksi IPsec-VPN.	vco-bp1bbi27hojx80nck****

Elemen respons

Element	Type	Description	Example
	object	Parameter respons.
Status	string	Status koneksi IPsec-VPN. ike_sa_not_established: Negosiasi Fase 1 gagal. ike_sa_established: Negosiasi Fase 1 berhasil. ipsec_sa_not_established: Negosiasi Fase 2 gagal. ipsec_sa_established: Negosiasi Fase 2 berhasil.	ike_sa_not_established
RemoteCaCertificate	string	Sertifikat CA peer.	-----BEGIN CERTIFICATE----- MIIB7zCCAZW****
EnableNatTraversal	boolean	Menunjukkan apakah Penelusuran NAT diaktifkan untuk koneksi IPsec-VPN. true: Penelusuran NAT diaktifkan. false: Penelusuran NAT dinonaktifkan. Setelah Penelusuran NAT diaktifkan, proses negosiasi IKE menghapus verifikasi nomor port UDP dan dapat mendeteksi perangkat gateway NAT sepanjang saluran data VPN.	true
CreateTime	integer	Timestamp saat koneksi IPsec-VPN dibuat. Satuan: milidetik. Timestamp mengikuti format UNIX dan merepresentasikan jumlah milidetik yang telah berlalu sejak 1 Januari 1970 pukul 00:00:00 UTC.	1492753817000
EffectImmediately	boolean	Menunjukkan apakah konfigurasi koneksi IPsec-VPN langsung berlaku. true: Konfigurasi langsung berlaku. Koneksi ulang dipicu setelah konfigurasi diubah. false: Konfigurasi tidak langsung berlaku. Koneksi ulang dipicu ketika trafik terdeteksi.	true
VpnGatewayId	string	ID instans Gateway VPN.	vpn-bp1q8bgx4xnkm2ogj****
LocalSubnet	string	Blok CIDR di sisi Alibaba Cloud dari koneksi IPsec-VPN. Blok CIDR ganda dipisahkan dengan koma (,).	10.0.0.0/8
RequestId	string	ID permintaan.	F2310D45-BCF6-4E2E-9082-B4503844BA4C
VpnConnectionId	string	ID koneksi IPsec-VPN.	vco-bp1bbi27hojx80nck****
RemoteSubnet	string	Blok CIDR di sisi pusat data lokal. Blok CIDR ganda dipisahkan dengan koma (,).	192.168.0.0/16
CustomerGatewayId	string	ID gateway pelanggan yang terkait dengan koneksi IPsec-VPN.	cgw-bp1mvj4g9kogwwcxk****
Name	string	Nama koneksi IPsec-VPN.	ipsec1
EnableDpd	boolean	Menunjukkan apakah Pendeteksian Peer Mati (DPD) diaktifkan untuk koneksi IPsec-VPN. false: DPD dinonaktifkan. true: DPD diaktifkan. Setelah DPD diaktifkan, inisiator IPsec mengirim paket DPD untuk memeriksa apakah perangkat peer masih aktif. Jika tidak ada respons yang benar diterima dalam periode waktu tertentu, peer dianggap terputus. SA ISAKMP dan SA IPsec yang sesuai kemudian dihapus, dan saluran keamanan juga dihapus.	true
IkeConfig	object	Konfigurasi negosiasi Fase 1.
RemoteId	string	Identifier di sisi pusat data lokal dari koneksi IPsec-VPN.	139.34.XX.XX
IkeLifetime	integer	Masa berlaku fase IKE. Satuan: detik.	86400
IkeEncAlg	string	Algoritma enkripsi pada fase IKE.	aes
LocalId	string	Identifier di sisi Alibaba Cloud dari koneksi IPsec-VPN.	116.28.XX.XX
IkeMode	string	Mode negosiasi IKE. main: Mode utama. Proses negosiasi lebih aman. aggressive: Mode agresif. Negosiasi lebih cepat dan memiliki tingkat keberhasilan lebih tinggi.	main
IkeVersion	string	Versi protokol IKE. ikev1 ikev2 Dibandingkan dengan IKEv1, IKEv2 menyederhanakan proses negosiasi SA dan memberikan dukungan lebih baik untuk skenario multi-blok CIDR.	ikev1
IkePfs	string	Grup DH pada fase IKE.	group2
Psk	string	Kunci pra-bersama.	pgw6dy****
IkeAuthAlg	string	Algoritma autentikasi pada fase IKE.	sha1
IpsecConfig	object	Konfigurasi negosiasi Fase 2.
IpsecAuthAlg	string	Algoritma autentikasi pada fase IPsec.	sha1
IpsecLifetime	integer	Masa berlaku fase IPsec. Satuan: detik.	86400
IpsecEncAlg	string	Algoritma enkripsi pada fase IPsec.	aes
IpsecPfs	string	Grup DH pada fase IPsec.	group2
VcoHealthCheck	object	Informasi pemeriksaan kesehatan koneksi IPsec-VPN.
Status	string	Status pemeriksaan kesehatan. failed: Tidak normal. success: Normal.	failed
Dip	string	Alamat IP tujuan.	10.0.0.1
Interval	integer	Interval pengulangan pemeriksaan kesehatan. Satuan: detik.	3
Retry	integer	Jumlah paket pengulangan yang dikirim untuk pemeriksaan kesehatan.	3
Sip	string	Alamat IP sumber.	192.168.1.1
Enable	string	Menunjukkan apakah pemeriksaan kesehatan diaktifkan untuk koneksi IPsec-VPN. false: Pemeriksaan kesehatan dinonaktifkan. true: Pemeriksaan kesehatan diaktifkan.	true
Policy	string	Menentukan apakah entri rute ditarik saat pemeriksaan kesehatan gagal. revoke_route: Entri rute ditarik. reserve_route: Entri rute tidak ditarik.	revoke_route
VpnBgpConfig	object	Konfigurasi protokol routing BGP koneksi IPsec-VPN.
Status	string	Status negosiasi protokol routing BGP. success: Normal. failed: Tidak normal.	success
PeerBgpIp	string	Alamat BGP peer.	169.254.11.1
TunnelCidr	string	Blok CIDR BGP koneksi IPsec-VPN. Blok CIDR merupakan subnet dari 169.254.0.0/16 dengan panjang masker subnet 30.	169.254.11.0/30
EnableBgp	string	Status aktif protokol routing BGP. true: Routing BGP diaktifkan. false: Routing BGP dinonaktifkan.	true
LocalBgpIp	string	Alamat BGP di sisi Alibaba Cloud.	169.254.11.2
PeerAsn	integer	Nomor sistem otonom peer.	65530
LocalAsn	integer	Nomor sistem otonom di sisi Alibaba Cloud.	65531
AuthKey	string	Kunci autentikasi protokol routing BGP.	AuthKey****
AttachType	string	Jenis resource tempat koneksi IPsec-VPN disambungkan. CEN: Koneksi IPsec-VPN disambungkan ke instans router transit di bawah instans Cloud Enterprise Network (CEN). NO_ASSOCIATED: Koneksi IPsec-VPN tidak disambungkan ke resource apa pun. VPNGW: Koneksi IPsec-VPN disambungkan ke instans Gateway VPN.	CEN
NetworkType	string	Jenis jaringan koneksi IPsec-VPN. public: Koneksi IPsec-VPN membuat saluran komunikasi terenkripsi melalui Internet. private: Koneksi IPsec-VPN membuat saluran komunikasi terenkripsi melalui jaringan pribadi.	public
AttachInstanceId	string	ID instans CEN tempat instans router transit berada.	cen-lxxpbpalc776qz****
Spec	string	Spesifikasi bandwidth koneksi IPsec-VPN. Satuan: Mbps.	1000M
State	string	Status pengikatan koneksi IPsec-VPN dan instans router transit. active: Koneksi IPsec-VPN disambungkan ke instans Gateway VPN dan dalam kondisi normal. init: Koneksi IPsec-VPN tidak disambungkan ke resource apa pun dan dalam kondisi inisialisasi. attaching: Koneksi IPsec-VPN sedang disambungkan ke instans router transit. attached: Koneksi IPsec-VPN sudah disambungkan ke instans router transit. detaching: Koneksi IPsec-VPN sedang dilepas dari instans router transit. financialLocked: Terkunci secara finansial karena pembayaran tertunda. provisioning: Resource sedang dipersiapkan. updating: Koneksi IPsec-VPN sedang diperbarui. upgrading: Koneksi IPsec-VPN sedang ditingkatkan. deleted: Koneksi IPsec-VPN telah dihapus.	attached
ZoneNo	string	ID zona tempat koneksi IPsec-VPN ditempatkan. Anda dapat memanggil operasi DescribeZones untuk menanyakan pemetaan antara ID zona dan zona.	cn-hangzhou-h
InternetIp	string	Alamat IP gateway koneksi IPsec-VPN.	47.XX.XX.162
TransitRouterId	string	ID instans router transit tempat koneksi IPsec-VPN disambungkan.	tr-p0we2edef9qr44a85****
TransitRouterName	string	Nama instans router transit.	nametest
CrossAccountAuthorized	boolean	Menunjukkan apakah koneksi IPsec-VPN disambungkan ke instans router transit yang dimiliki oleh Akun Alibaba Cloud berbeda. true: Koneksi IPsec-VPN disambungkan ke instans router transit lintas akun. false: Koneksi IPsec-VPN tidak disambungkan ke instans router transit lintas akun.	false
Tags	object
Tag	array<object>	Daftar tag yang dilampirkan pada koneksi IPsec-VPN.
	object	Informasi tag.
Key	string	Kunci tag.	TagKey
Value	string	Nilai tag.	TagValue
TunnelOptionsSpecification	object
TunnelOptions	array<object>	Konfigurasi saluran data koneksi IPsec-VPN. Parameter di bawah TunnelOptionsSpecification hanya dikembalikan saat Anda menanyakan koneksi IPsec-VPN dalam mode dual-tunnel.
	array<object>	Konfigurasi saluran data.
TunnelId	string	ID saluran data.	tun-opsqc4d97wni27****
CustomerGatewayId	string	ID gateway pelanggan yang terkait dengan saluran data.	cgw-p0wy363lucf1uyae8****
EnableDpd	string	Menunjukkan apakah Pendeteksian Peer Mati (DPD) diaktifkan untuk saluran data. false: DPD dinonaktifkan. true: DPD diaktifkan.	true
EnableNatTraversal	string	Menunjukkan apakah Penelusuran NAT diaktifkan untuk saluran data. false: Penelusuran NAT dinonaktifkan. true: Penelusuran NAT diaktifkan.	true
InternetIp	string	Alamat IP saluran data.	47.21.XX.XX
RemoteCaCertificate	string	Sertifikat CA peer saluran data. Parameter ini hanya dikembalikan saat instans Gateway VPN menggunakan Algoritma Kriptografi Tiongkok (SM).	-----BEGIN CERTIFICATE----- MIIB7zCCAZW**** -----END CERTIFICATE-----
Role	string	Peran saluran data. master: Saluran data adalah saluran aktif. slave: Saluran data adalah saluran cadangan.	master
TunnelIndex	integer	Urutan pembuatan saluran data. 1: Saluran data pertama. 2: Saluran data kedua. Catatan Parameter ini hanya dikembalikan saat koneksi IPsec-VPN disambungkan ke instans router transit.	1
State	string	Status saluran data. active: Saluran data dalam kondisi normal. updating: Saluran data sedang diperbarui. deleting: Saluran data sedang dihapus.	active
Status	string	Status koneksi IPsec-VPN. ike_sa_not_established: Negosiasi Fase 1 gagal. ike_sa_established: Negosiasi Fase 1 berhasil. ipsec_sa_not_established: Negosiasi Fase 2 gagal. ipsec_sa_established: Negosiasi Fase 2 berhasil.	ipsec_sa_established
TunnelBgpConfig	object	Konfigurasi BGP saluran data.
BgpStatus	string	Status negosiasi BGP. success: Normal. failed: Tidak normal.	success
LocalAsn	string	Nomor sistem otonom di ujung lokal (sisi Alibaba Cloud) saluran data.	65530
LocalBgpIp	string	Alamat BGP di ujung lokal (sisi Alibaba Cloud) saluran data.	169.254.10.1
PeerAsn	string	Nomor sistem otonom peer saluran data.	65531
PeerBgpIp	string	Alamat BGP peer saluran data.	169.254.10.2
TunnelCidr	string	Blok CIDR BGP saluran data.	169.254.10.0/30
TunnelIkeConfig	object	Konfigurasi negosiasi Fase 1.
IkeAuthAlg	string	Algoritma autentikasi pada fase IKE.	sha1
IkeEncAlg	string	Algoritma enkripsi pada fase IKE.	aes
IkeLifetime	string	Masa berlaku fase IKE. Satuan: detik.	86400
IkeMode	string	Mode negosiasi IKE. main: Mode utama. Proses negosiasi lebih aman. aggressive: Mode agresif. Negosiasi lebih cepat dan memiliki tingkat keberhasilan lebih tinggi.	main
IkePfs	string	Grup DH pada fase IKE.	group2
IkeVersion	string	Versi protokol IKE.	ikev1
LocalId	string	Identifier di ujung lokal (sisi Alibaba Cloud) saluran data.	47.21.XX.XX
Psk	string	Kunci pra-bersama.	123456****
RemoteId	string	Identifier untuk tunnel peer.	47.42.XX.XX
TunnelIpsecConfig	object	Konfigurasi negosiasi Fase 2.
IpsecAuthAlg	string	Algoritma autentikasi pada fase IPsec.	sha1
IpsecEncAlg	string	Algoritma enkripsi pada fase IPsec.	aes
IpsecLifetime	string	Masa berlaku fase IPsec. Satuan: detik.	86400
IpsecPfs	string	Grup DH pada fase IPsec.	group2
ZoneNo	string	Zona tempat saluran data ditempatkan. Anda dapat memanggil operasi DescribeZones untuk menanyakan pemetaan antara ID zona dan zona.	cn-hangzhou-i
EnableTunnelsBgp	boolean	Status aktif BGP untuk saluran data. true: BGP diaktifkan. false: BGP dinonaktifkan.	true
ResourceGroupId	string	ID kelompok sumber daya tempat koneksi IPsec-VPN berada. Anda dapat memanggil operasi ListResourceGroups untuk menanyakan informasi kelompok sumber daya.	rg-acfmzs372yg****
TunnelBandwidth	string	Spesifikasi bandwidth satu saluran data VPN. Nilai yang valid: Standard (default): Jenis Standar dengan bandwidth default 1 Gbps. Large: Jenis Large dengan bandwidth default 3 Gbps.	Standard

Contoh

Respons sukses

JSONformat

{
  "Status": "ike_sa_not_established",
  "RemoteCaCertificate": "-----BEGIN CERTIFICATE----- MIIB7zCCAZW****",
  "EnableNatTraversal": true,
  "CreateTime": 1492753817000,
  "EffectImmediately": true,
  "VpnGatewayId": "vpn-bp1q8bgx4xnkm2ogj****",
  "LocalSubnet": "10.0.0.0/8",
  "RequestId": "F2310D45-BCF6-4E2E-9082-B4503844BA4C",
  "VpnConnectionId": "vco-bp1bbi27hojx80nck****",
  "RemoteSubnet": "192.168.0.0/16",
  "CustomerGatewayId": "cgw-bp1mvj4g9kogwwcxk****",
  "Name": "ipsec1",
  "EnableDpd": true,
  "IkeConfig": {
    "RemoteId": "139.34.XX.XX",
    "IkeLifetime": 86400,
    "IkeEncAlg": "aes",
    "LocalId": "116.28.XX.XX",
    "IkeMode": "main",
    "IkeVersion": "ikev1",
    "IkePfs": "group2",
    "Psk": "pgw6dy****",
    "IkeAuthAlg": "sha1"
  },
  "IpsecConfig": {
    "IpsecAuthAlg": "sha1",
    "IpsecLifetime": 86400,
    "IpsecEncAlg": "aes",
    "IpsecPfs": "group2"
  },
  "VcoHealthCheck": {
    "Status": "failed",
    "Dip": "10.0.0.1",
    "Interval": 3,
    "Retry": 3,
    "Sip": "192.168.1.1",
    "Enable": "true",
    "Policy": "revoke_route"
  },
  "VpnBgpConfig": {
    "Status": "success",
    "PeerBgpIp": "169.254.11.1",
    "TunnelCidr": "169.254.11.0/30",
    "EnableBgp": "true",
    "LocalBgpIp": "169.254.11.2",
    "PeerAsn": 65530,
    "LocalAsn": 65531,
    "AuthKey": "AuthKey****"
  },
  "AttachType": "CEN",
  "NetworkType": "public",
  "AttachInstanceId": "cen-lxxpbpalc776qz****",
  "Spec": "1000M",
  "State": "attached",
  "ZoneNo": "cn-hangzhou-h",
  "InternetIp": "47.XX.XX.162",
  "TransitRouterId": "tr-p0we2edef9qr44a85****",
  "TransitRouterName": "nametest",
  "CrossAccountAuthorized": false,
  "Tags": {
    "Tag": [
      {
        "Key": "TagKey",
        "Value": "TagValue"
      }
    ]
  },
  "TunnelOptionsSpecification": {
    "TunnelOptions": [
      {
        "TunnelId": "tun-opsqc4d97wni27****",
        "CustomerGatewayId": "cgw-p0wy363lucf1uyae8****",
        "EnableDpd": "true",
        "EnableNatTraversal": "true",
        "InternetIp": "47.21.XX.XX",
        "RemoteCaCertificate": "-----BEGIN CERTIFICATE----- MIIB7zCCAZW**** -----END CERTIFICATE-----",
        "Role": "master",
        "TunnelIndex": 1,
        "State": "active",
        "Status": "ipsec_sa_established",
        "TunnelBgpConfig": {
          "BgpStatus": "success",
          "LocalAsn": "65530",
          "LocalBgpIp": "169.254.10.1",
          "PeerAsn": "65531",
          "PeerBgpIp": "169.254.10.2",
          "TunnelCidr": "169.254.10.0/30"
        },
        "TunnelIkeConfig": {
          "IkeAuthAlg": "sha1",
          "IkeEncAlg": "aes",
          "IkeLifetime": "86400",
          "IkeMode": "main",
          "IkePfs": "group2",
          "IkeVersion": "ikev1",
          "LocalId": "47.21.XX.XX",
          "Psk": "123456****",
          "RemoteId": "47.42.XX.XX"
        },
        "TunnelIpsecConfig": {
          "IpsecAuthAlg": "sha1",
          "IpsecEncAlg": "aes",
          "IpsecLifetime": "86400",
          "IpsecPfs": "group2"
        },
        "ZoneNo": "cn-hangzhou-i"
      }
    ]
  },
  "EnableTunnelsBgp": true,
  "ResourceGroupId": "rg-acfmzs372yg****",
  "TunnelBandwidth": "Standard"
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
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.	EIP bukan milik pemanggil saat ini. Periksa apakah Anda memiliki izin untuk mengakses EIP ini.
404	InvalidVpnConnectionInstanceId.NotFound	The specified vpn connection instance id does not exist.	Koneksi VPN yang ditentukan tidak ada. Periksa apakah ID koneksi VPN sudah benar.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.