DescribeVpnRouteEntries - VPN Gateway - Alibaba Cloud Documentation Center

Mengkueri informasi entri rute tujuan dan entri rute BGP instans Gateway VPN.

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

get

*VpnGateway

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID wilayah instans Gateway VPN. Anda dapat memanggil operasi DescribeRegions untuk mengkueri ID wilayah.	cn-hangzhou
VpnGatewayId	string	Yes	ID instans Gateway VPN.	vpn-bp1cmw7jh1nfe43m9****
PageNumber	integer	No	Nomor halaman. Nilai default: 1.	1
PageSize	integer	No	Jumlah entri per halaman. Nilai maksimum: 50. Nilai default: 10.	10
RouteEntryType	string	No	Jenis entri rute. Nilai valid: custom (default): entri rute tujuan instans Gateway VPN. bgp: entri rute BGP instans Gateway VPN.	custom

Elemen respons

Element	Type	Description	Example
	object	Parameter tanggapan.
PageSize	integer	Jumlah entri per halaman dalam kueri penomoran halaman.	10
RequestId	string	ID permintaan.	BF3995A6-FA4F-4C74-B90F-89ECF4BFF4D5
PageNumber	integer	Nomor halaman daftar.	1
TotalCount	integer	Jumlah total entri dalam daftar.	1
VpnRouteEntries	object
VpnRouteEntry	array<object>	Daftar entri rute.
	object	Detail entri rute.
RouteEntryType	string	Tipe entri rute. custom: entri rute tujuan dari gateway VPN. bgp: entri rute BGP dari gateway VPN.	custom
NextHop	string	Hop berikutnya dari entri rute.	vco-bp1tui07ob10fmuro****
Weight	integer	Bobot rute tujuan. Untuk gateway VPN yang mendukung mode dual-tunnel dari koneksi IPsec-VPN, bobot rute tujuan secara default adalah 100 dan tidak bermakna. Untuk gateway VPN yang mendukung mode single-tunnel dari koneksi IPsec-VPN, bobot rute tujuan menunjukkan prioritas rute tujuan: 100: prioritas tinggi. Jika terdapat beberapa rute tujuan dengan blok CIDR tujuan yang sama, koneksi IPsec-VPN yang terkait dengan rute tujuan tersebut berfungsi sebagai tautan aktif. 0: prioritas rendah. Jika terdapat beberapa rute tujuan dengan blok CIDR tujuan yang sama, koneksi IPsec-VPN yang terkait dengan rute tujuan tersebut berfungsi sebagai tautan standby.	100
RouteDest	string	Blok CIDR tujuan dari entri rute.	10.0.0.0/24
AsPath	string	Jalur AS yang dilewati oleh entri rute.	65501,65001,60011
State	string	Status entri rute. Nilai yang valid: published: dipublikasikan. normal: tidak dipublikasikan.	normal
CreateTime	integer	Stempel waktu saat entri rute dibuat. Stempel waktu ditampilkan dalam format stempel waktu UNIX. Ini menunjukkan total durasi waktu dari 00:00:00 (UTC) pada 1 Januari 1970 hingga waktu saat entri rute dibuat.	1563874074000
Community	string	Nilai atribut community dari entri rute.	65001:1000,65501:2000
Source	string	Sumber dari entri rute BGP. CLOUD: menunjukkan bahwa rute saat ini disebarkan melalui layanan Alibaba Cloud yang terkait dengan gateway VPN. VPN_BGP: menunjukkan bahwa rute saat ini dipelajari melalui protokol routing BGP dari gateway VPN. Misalnya, rute dari pusat data on-premises dipelajari melalui protokol routing BGP.	CLOUD
VpnInstanceId	string	ID gateway VPN.	vpn-bp1cmw7jh1nfe43m9****
NextHopTunnelId	string	ID tunnel yang terkait dengan hop berikutnya dari entri rute. Catatan Parameter ini hanya dikembalikan oleh gateway VPN yang mendukung mode dual-tunnel dari koneksi IPsec-VPN.	tun-36cfgpwjn58axj****
VpnRouteCounts	object
VpnRouteCount	array<object>	Statistik entri rute instans Gateway VPN dalam mode saluran data ganda. Catatan Informasi ini hanya dikembalikan untuk instans Gateway VPN yang mendukung koneksi IPsec-VPN saluran data ganda.
	object	Statistik entri rute.
RouteEntryType	string	Tipe entri rute. custom: entri rute tujuan. bgp: entri rute BGP.	bgp
RouteCount	integer	Jumlah entri rute.	3
Source	string	Sumber dari entri rute BGP. CLOUD: menunjukkan bahwa rute saat ini disebarkan melalui layanan Alibaba Cloud yang terkait dengan gateway VPN. VPN_BGP: menunjukkan bahwa rute saat ini dipelajari melalui protokol routing BGP dari gateway VPN. Misalnya, rute dari pusat data on-premises dipelajari melalui protokol routing BGP.	VPN_BGP

Contoh

Respons sukses

JSONformat

{
  "PageSize": 10,
  "RequestId": "BF3995A6-FA4F-4C74-B90F-89ECF4BFF4D5",
  "PageNumber": 1,
  "TotalCount": 1,
  "VpnRouteEntries": {
    "VpnRouteEntry": [
      {
        "RouteEntryType": "custom",
        "NextHop": "vco-bp1tui07ob10fmuro****",
        "Weight": 100,
        "RouteDest": "10.0.0.0/24",
        "AsPath": "65501,65001,60011",
        "State": "normal",
        "CreateTime": 1563874074000,
        "Community": "65001:1000,65501:2000",
        "Source": "CLOUD",
        "VpnInstanceId": "vpn-bp1cmw7jh1nfe43m9****",
        "NextHopTunnelId": "tun-36cfgpwjn58axj****"
      }
    ]
  },
  "VpnRouteCounts": {
    "VpnRouteCount": [
      {
        "RouteEntryType": "bgp",
        "RouteCount": 3,
        "Source": "VPN_BGP"
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	IllegalParam.RouteEntryType	"RouteEntryType" yang ditentukan tidak valid.
400	InvalidVpnInstanceId.NotFound	VPN yang ditentukan tidak ditemukan.	Instance VPN yang ditentukan tidak ditemukan.
400	InvalidVpnGatewayInstanceId.NotFound	ID instance gateway vpn yang ditentukan tidak ada.	Gateway VPN yang ditentukan tidak ada. Periksa apakah gateway VPN sudah benar.
403	Forbbiden.SubUser	Pengguna tidak diizinkan untuk mengoperasikan sumber daya yang ditentukan karena akun Anda dibuat oleh pengguna lain.
403	Forbidden	Pengguna tidak diizinkan untuk mengoperasikan sumber daya yang ditentukan.	Anda tidak memiliki izin untuk mengoperasikan sumber daya yang ditentukan. Ajukan izin yang diperlukan dan coba lagi.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.