DescribeVpnGateway - VPN Gateway - Alibaba Cloud Documentation Center

Mengambil detail Gateway 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:DescribeVpnGateway

get

*VpnGateway.

acs:vpc:{#regionId}:{#accountId}:vpngateway/{#VpnGatewayId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID wilayah Gateway VPN. Anda dapat memanggil operasi DescribeRegions untuk menanyakan ID wilayah.	cn-hangzhou
VpnGatewayId	string	Yes	ID instans Gateway VPN.	vpn-bp1r3v1xqkl0w519g****
IncludeReservationData	boolean	No	Menentukan apakah akan menyertakan data pesanan tertunda. Nilai yang valid: false (default): tidak menyertakan data pesanan tertunda. true: menyertakan data pesanan tertunda.	true

Elemen respons

Element	Type	Description	Example
	object	Parameter respons.
VpnType	string	Jenis Gateway VPN. Nilai: Normal, yang menunjukkan Gateway VPN standar.	Normal
Status	string	Status Gateway VPN. Nilai yang valid: init: sedang diinisialisasi. provisioning: sedang dipersiapkan. active: Normal. updating: sedang diperbarui. deleting: sedang dihapus.	init
VpcId	string	ID VPC tempat Gateway VPN berada.	vpc-bp19m2yx1m5q0avyq****
SslMaxConnections	integer	Jumlah maksimum koneksi SSL-VPN bersamaan.	5
Spec	string	Spesifikasi bandwidth Gateway VPN. Satuan: Mbit/s.	5
InternetIp	string	Jika instans Gateway VPN mendukung pembuatan koneksi IPsec-VPN satu saluran data, alamat ini adalah alamat IP instans Gateway VPN dan dapat digunakan untuk membuat koneksi IPsec-VPN atau SSL-VPN. Jika instans Gateway VPN mendukung pembuatan koneksi IPsec-VPN dua saluran data, 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 dua saluran data, sistem akan menetapkan dua alamat IP IPsec ke instans Gateway VPN untuk membuat koneksi IPsec-VPN dua saluran data.	47.22.XX.XX
CreateTime	integer	Timestamp saat Gateway VPN dibuat. Satuan: milidetik. Timestamp mengikuti format UNIX, yang merepresentasikan jumlah total milidetik yang telah berlalu sejak 1 Januari 1970 pukul 00:00:00 UTC.	1495382400000
AutoPropagate	boolean	Menunjukkan apakah propagasi otomatis diaktifkan untuk Gateway VPN. Nilai yang valid: true: diaktifkan. false: dinonaktifkan.	true
ChargeType	string	Metode penagihan. Nilai: POSTPAY: metode penagihan bayar sesuai pemakaian.	中国站示例值：Prepay，国际站示例值：POSTPAY
VpnGatewayId	string	ID instans Gateway VPN.	vpn-bp1r3v1xqkl0w519g****
Tag	string	Label yang dihasilkan sistem untuk Gateway VPN. VpnEnableBgp: menunjukkan apakah Gateway VPN mendukung fitur BGP. true: didukung. false: tidak didukung. VisuallySsl: menunjukkan apakah Gateway VPN mendukung melihat informasi koneksi klien SSL. true: didukung. false: tidak didukung. PbrPriority: menunjukkan apakah Gateway VPN mendukung konfigurasi prioritas kebijakan untuk perutean berbasis kebijakan. true: didukung. false: tidak didukung. VpnNewImage: menunjukkan apakah Gateway VPN merupakan Gateway VPN generasi baru. true: ya. false: tidak. description: deskripsi Gateway VPN, hanya digunakan untuk keperluan internal sistem. VpnVersion: nomor versi Gateway VPN. IDaaSNewVersion: menunjukkan apakah Gateway VPN mendukung penyambungan ke instans EIAM 2.0. true: didukung. false: tidak didukung.	{\"VpnEnableBgp\":\"true\",\"VisuallySsl\":\"true\",\"PbrPriority\":\"true\",\"VpnNewImage\":\"true\",\"description\":\"转发1.3.24\",\"VpnVersion\":\"v1.2.4\",\"IDaaSNewVersion\":\"true\"}
IpsecVpn	string	Menunjukkan apakah IPsec-VPN diaktifkan. Nilai yang valid: enable: diaktifkan. disable: dinonaktifkan.	enable
EndTime	integer	Timestamp saat Gateway VPN kedaluwarsa. Satuan: milidetik. Timestamp mengikuti format UNIX, yang merepresentasikan jumlah total milidetik yang telah berlalu sejak 1 Januari 1970 pukul 00:00:00 UTC.	1544666102000
VSwitchId	string	ID vSwitch tempat Gateway VPN berada.	vsw-bp1dmzugdikc6hdgx****
RequestId	string	ID permintaan.	27E4E088-8DE0-4672-BF5C-0A412389DB9E
Description	string	Deskripsi Gateway VPN.	vpngatewaydescription
EnableBgp	boolean	Status aktif fitur BGP untuk Gateway VPN. Nilai yang valid: true: diaktifkan. false: dinonaktifkan.	true
BusinessStatus	string	Status pembayaran Gateway VPN. Nilai yang valid: Normal: Normal. FinancialLocked: terkunci karena pembayaran tertunda.	Normal
SslVpn	string	Status aktif fitur SSL-VPN. Nilai yang valid: enable: diaktifkan. disable: dinonaktifkan.	enable
Name	string	Nama Gateway VPN.	vpngatewayname
ReservationData	object	Data pesanan tertunda. Catatan Parameter ini hanya dikembalikan ketika IncludeReservationData diatur ke true.
Status	string	Status pesanan tertunda. Nilai yang valid: 1: pesanan perpanjangan atau perpanjangan dengan perubahan spesifikasi belum berlaku. 2: pesanan peningkatan sementara telah berlaku. Setelah waktu pemulihan tercapai, sistem akan memulihkan Gateway VPN ke spesifikasi sebelum peningkatan sementara. Dalam kasus ini, ReservationIpsec, ReservationMaxConnections, ReservationSpec, dan ReservationSsl menunjukkan spesifikasi sebelum peningkatan sementara.	1
ReservationOrderType	string	Jenis pesanan tertunda. Nilai yang valid: RENEWCHANGE: perpanjangan dengan perubahan spesifikasi. TEMP_UPGRADE: peningkatan sementara. RENEW: perpanjangan.	TEMP_UPGRADE
ReservationIpsec	string	Status aktif fitur IPsec-VPN untuk pesanan tertunda. Nilai yang valid: enable: diaktifkan. disable: dinonaktifkan.	enable
ReservationSpec	string	Spesifikasi bandwidth untuk pesanan tertunda. Satuan: Mbit/s.	5
ReservationSsl	string	Status aktif fitur SSL-VPN untuk pesanan tertunda. Nilai yang valid: enable: diaktifkan. disable: dinonaktifkan.	enable
ReservationMaxConnections	integer	Jumlah maksimum koneksi SSL-VPN bersamaan untuk pesanan tertunda.	5
ReservationEndTime	string	Jika jenis pesanan tertunda adalah TEMP_UPGRADE (peningkatan sementara), parameter ini menunjukkan waktu pengembalian dari peningkatan sementara. Jika jenis pesanan tertunda adalah RENEWCHANGE (perpanjangan dengan Upgrade/Downgrade) atau RENEW (perpanjangan), parameter ini menunjukkan periode berlaku saat perpanjangan atau perpanjangan dengan perubahan spesifikasi mulai berlaku.	2020-07-20T16:00:00Z
Tags	object
Tag	array<object>	Daftar tag yang ditautkan ke instans Gateway VPN.
	object	Daftar tag yang ditautkan ke instans Gateway VPN.
Key	string	Kunci tag.	aaa
Value	string	Nilai tag.	bbb
NetworkType	string	Jenis jaringan Gateway VPN. public: Gateway VPN publik. private: Gateway VPN privat.	public
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 dua saluran data.	47.91.XX.XX
DisasterRecoveryVSwitchId	string	ID vSwitch kedua yang dikaitkan dengan instans Gateway VPN. Parameter ini hanya dikembalikan untuk instans Gateway VPN yang mendukung pembuatan koneksi IPsec-VPN dua saluran data.	vsw-p0w95ql6tmr2ludkt****
SslVpnInternetIp	string	Alamat IP koneksi SSL-VPN. Parameter ini hanya dikembalikan ketika fitur SSL-VPN diaktifkan pada instans Gateway VPN yang memiliki jenis jaringan publik dan mendukung pembuatan koneksi IPsec-VPN dua saluran data.	47.74.XX.XX
ResourceGroupId	string	ID kelompok sumber daya tempat Gateway VPN berada. Anda dapat memanggil operasi ListResourceGroups untuk menanyakan informasi kelompok sumber daya.	rg-acfmzs372yg****
EniInstanceIds	object
EniInstanceId	array	Daftar elastic network interfaces (ENIs) yang dibuat oleh sistem untuk instans Gateway VPN.
	string	ID ENI. Parameter ini hanya dikembalikan untuk instans Gateway VPN yang mendukung pembuatan koneksi IPsec-VPN dua saluran data.	eni-7xvcxgmd4y2ypibn****
GatewayType	string	Jenis Gateway VPN. Nilai yang valid: Traditional: Gateway VPN tradisional yang mendukung fitur IPsec dan SSL. Enhanced.SiteToSite: Gateway VPN site-to-cloud yang ditingkatkan yang hanya mendukung fitur IPsec.	Enhanced.SiteToSite

Contoh

Respons sukses

JSONformat

{
  "VpnType": "Normal",
  "Status": "init",
  "VpcId": "vpc-bp19m2yx1m5q0avyq****",
  "SslMaxConnections": 5,
  "Spec": "5",
  "InternetIp": "47.22.XX.XX",
  "CreateTime": 1495382400000,
  "AutoPropagate": true,
  "ChargeType": "中国站示例值：Prepay，国际站示例值：POSTPAY",
  "VpnGatewayId": "vpn-bp1r3v1xqkl0w519g****",
  "Tag": "{\\\"VpnEnableBgp\\\":\\\"true\\\",\\\"VisuallySsl\\\":\\\"true\\\",\\\"PbrPriority\\\":\\\"true\\\",\\\"VpnNewImage\\\":\\\"true\\\",\\\"description\\\":\\\"转发1.3.24\\\",\\\"VpnVersion\\\":\\\"v1.2.4\\\",\\\"IDaaSNewVersion\\\":\\\"true\\\"}",
  "IpsecVpn": "enable",
  "EndTime": 1544666102000,
  "VSwitchId": "vsw-bp1dmzugdikc6hdgx****",
  "RequestId": "27E4E088-8DE0-4672-BF5C-0A412389DB9E",
  "Description": "vpngatewaydescription",
  "EnableBgp": true,
  "BusinessStatus": "Normal",
  "SslVpn": "enable",
  "Name": "vpngatewayname",
  "ReservationData": {
    "Status": "1",
    "ReservationOrderType": "TEMP_UPGRADE",
    "ReservationIpsec": "enable",
    "ReservationSpec": "5",
    "ReservationSsl": "enable",
    "ReservationMaxConnections": 5,
    "ReservationEndTime": "2020-07-20T16:00:00Z"
  },
  "Tags": {
    "Tag": [
      {
        "Key": "aaa",
        "Value": "bbb"
      }
    ]
  },
  "NetworkType": "public",
  "DisasterRecoveryInternetIp": "47.91.XX.XX",
  "DisasterRecoveryVSwitchId": "vsw-p0w95ql6tmr2ludkt****",
  "SslVpnInternetIp": "47.74.XX.XX",
  "ResourceGroupId": "rg-acfmzs372yg****",
  "EniInstanceIds": {
    "EniInstanceId": [
      "eni-7xvcxgmd4y2ypibn****"
    ]
  },
  "GatewayType": "Enhanced.SiteToSite"
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	InvalidVpnGatewayInstanceId.NotFound	The specified vpn gateway instance id does not exist.	Gateway VPN yang ditentukan tidak ada. Periksa apakah Gateway VPN sudah benar.
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	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.