DescribeVpnGateway - VPN Gateway - Alibaba Cloud Documentation Center

Memanggil API DescribeVpnGateway untuk mengkueri 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 API DescribeRegions untuk mendapatkan ID wilayah.	cn-hangzhou
VpnGatewayId	string	Yes	ID instans Gateway VPN.	vpn-bp1r3v1xqkl0w519g****
IncludeReservationData	boolean	No	Apakah akan menyertakan data pesanan tertunda. Nilai valid: false (default): Tidak menyertakan data pesanan tertunda. true: Menyertakan data pesanan tertunda.	true

Elemen respons

Element	Type	Description	Example
	object	Parameter tanggapan.
VpnType	string	Tipe Gateway VPN. Nilai: Normal, menunjukkan tipe standar.	Normal
Status	string	Status Gateway VPN. Nilai valid: init: Menginisialisasi. provisioning: Menyiapkan. active: Normal. updating: Memperbarui. deleting: Menghapus.	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. Unit: Mbps.	5
InternetIp	string	Dalam skenario di mana instans Gateway VPN mendukung pembuatan koneksi IPsec-VPN mode saluran data tunggal, alamat ini adalah alamat IP instans Gateway VPN dan dapat digunakan untuk membuat koneksi IPsec-VPN atau koneksi SSL-VPN. Dalam skenario di mana instans Gateway VPN mendukung pembuatan koneksi IPsec-VPN mode saluran data ganda, alamat ini adalah alamat IP pertama yang digunakan untuk membuat koneksi IPsec-VPN dan tidak dapat digunakan untuk membuat koneksi SSL-VPN. Dalam skenario di mana instans Gateway VPN mendukung pembuatan koneksi IPsec-VPN mode saluran data ganda, sistem menetapkan dua alamat IPsec ke instans Gateway VPN untuk membuat koneksi IPsec-VPN mode saluran data ganda.	47.22.XX.XX
CreateTime	integer	Timestamp saat Gateway VPN dibuat. Unit: milidetik. Timestamp dalam format Unix, yang merepresentasikan jumlah total milidetik yang berlalu dari 1 Januari 1970, 00:00:00 UTC hingga waktu pembuatan Gateway VPN.	1495382400000
AutoPropagate	boolean	Apakah fitur propagasi entri rute otomatis diaktifkan untuk Gateway VPN. Nilai valid: true: Diaktifkan. false: Dinonaktifkan.	true
ChargeType	string	Metode penagihan. Nilai valid: POSTPAY: Bayar sesuai pemakaian.	Contoh nilai situs China: Prepay. Contoh nilai situs Internasional: POSTPAY
VpnGatewayId	string	ID instans Gateway VPN.	vpn-bp1r3v1xqkl0w519g****
Tag	string	Tag yang dihasilkan sistem untuk Gateway VPN. VpnEnableBgp: Apakah Gateway VPN mendukung fitur BGP. true: Didukung. false: Tidak didukung. VisuallySsl: Apakah Gateway VPN mendukung melihat informasi koneksi Klien SSL. true: Didukung. false: Tidak didukung. PbrPriority: Apakah Gateway VPN mendukung konfigurasi prioritas Kebijakan untuk entri rute berbasis Kebijakan. true: Didukung. false: Tidak didukung. VpnNewImage: Apakah Gateway VPN merupakan Gateway VPN generasi baru. true: Ya. false: Tidak. description: Deskripsi Gateway VPN, hanya digunakan untuk keperluan sistem internal. VpnVersion: Nomor versi Gateway VPN. IDaaSNewVersion: Apakah Gateway VPN mendukung pengikatan ke instans EIAM 2.0. true: Didukung. false: Tidak didukung.	{\"VpnEnableBgp\":\"true\",\"VisuallySsl\":\"true\",\"PbrPriority\":\"true\",\"VpnNewImage\":\"true\",\"description\":\"Penerusan 1.3.24\",\"VpnVersion\":\"v1.2.4\",\"IDaaSNewVersion\":\"true\"}
IpsecVpn	string	Apakah fitur IPsec-VPN diaktifkan. Nilai valid: enable: Diaktifkan. disable: Dinonaktifkan.	enable
EndTime	integer	Timestamp kedaluwarsa Gateway VPN. Unit: milidetik. Timestamp dalam format Unix, yang merepresentasikan jumlah total milidetik yang berlalu dari 1 Januari 1970, 00:00:00 UTC hingga waktu kedaluwarsa Gateway VPN.	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 fitur BGP Gateway VPN. Nilai valid: true: Diaktifkan. false: Dinonaktifkan.	true
BusinessStatus	string	Status penagihan Gateway VPN. Nilai valid: Normal: Normal. FinancialLocked: Terkunci karena Pembayaran tertunda.	Normal
SslVpn	string	Status fitur SSL-VPN. Nilai 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 valid: 1: Menunjukkan bahwa pesanan perpanjangan atau perpanjangan dengan perubahan spesifikasi belum berlaku. 2: Menunjukkan bahwa pesanan peningkatan sementara telah berlaku. Setelah waktu pemulihan tercapai, sistem akan memulihkan spesifikasi Gateway VPN ke spesifikasi sebelum peningkatan sementara. Dalam hal ini, ReservationIpsec, ReservationMaxConnections, ReservationSpec, dan ReservationSsl merepresentasikan spesifikasi sebelum peningkatan sementara Gateway VPN.	1
ReservationOrderType	string	Tipe pesanan tertunda. Nilai valid: RENEWCHANGE: Perpanjangan dengan perubahan spesifikasi. TEMP_UPGRADE: Peningkatan sementara. RENEW: Perpanjangan.	TEMP_UPGRADE
ReservationIpsec	string	Status fitur IPsec-VPN pesanan tertunda. Nilai valid: enable: Diaktifkan. disable: Dinonaktifkan.	enable
ReservationSpec	string	Spesifikasi bandwidth pesanan tertunda. Unit: Mbps.	5
ReservationSsl	string	Status fitur SSL-VPN pesanan tertunda. Nilai valid: enable: Diaktifkan. disable: Dinonaktifkan.	enable
ReservationMaxConnections	integer	Jumlah maksimum koneksi SSL-VPN bersamaan untuk pesanan tertunda.	5
ReservationEndTime	string	Jika tipe pesanan tertunda adalah TEMP_UPGRADE (peningkatan sementara), parameter ini pengatur waktu pemulihan untuk peningkatan sementara. Jika tipe pesanan tertunda adalah RENEWCHANGE (perpanjangan dengan perubahan spesifikasi) atau RENEW (perpanjangan), parameter ini pengatur waktu ketika perpanjangan atau perpanjangan dengan perubahan spesifikasi berlaku.	2020-07-20T16:00:00Z
Tags	object
Tag	array<object>	Daftar tag yang terikat pada instans Gateway VPN.
	object	Daftar tag yang terikat pada 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 mode saluran data ganda.	47.91.XX.XX
DisasterRecoveryVSwitchId	string	ID vSwitch kedua yang terkait dengan instans Gateway VPN. Parameter ini hanya dikembalikan untuk instans Gateway VPN yang mendukung pembuatan koneksi IPsec-VPN mode saluran data ganda.	vsw-p0w95ql6tmr2ludkt****
SslVpnInternetIp	string	Alamat IP untuk koneksi SSL-VPN. Parameter ini hanya dikembalikan ketika SSL-VPN diaktifkan pada instans Gateway VPN jaringan publik yang mendukung pembuatan koneksi IPsec-VPN mode saluran data ganda.	47.74.XX.XX
ResourceGroupId	string	ID kelompok sumber daya tempat Gateway VPN berada. Anda dapat memanggil API ListResourceGroups untuk mengkueri informasi kelompok sumber daya.	rg-acfmzs372yg****
EniInstanceIds	object
EniInstanceId	array	Daftar Elastic Network Interface (ENI) 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 mode saluran data ganda.	eni-7xvcxgmd4y2ypibn****
GatewayType	string	Tipe Gateway VPN. Nilai valid: Traditional: Gateway VPN tradisional, mencakup fitur IPsec dan SSL. Enhanced.SiteToSite: VPN site-to-cloud yang ditingkatkan, hanya mencakup 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": "Contoh nilai situs China: Prepay. Contoh nilai situs Internasional: POSTPAY",
  "VpnGatewayId": "vpn-bp1r3v1xqkl0w519g****",
  "Tag": "{\\\"VpnEnableBgp\\\":\\\"true\\\",\\\"VisuallySsl\\\":\\\"true\\\",\\\"PbrPriority\\\":\\\"true\\\",\\\"VpnNewImage\\\":\\\"true\\\",\\\"description\\\":\\\"Penerusan 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.	VPN gateway yang ditentukan tidak ada. Periksa apakah VPN gateway 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.	Anda tidak diizinkan untuk mengoperasikan resource yang ditentukan. Ajukan izin yang diperlukan sebelum melakukan operasi.
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.