DescribeVcoRouteEntries - VPN Gateway - Alibaba Cloud Documentation Center

Mengkueri entri rute koneksi IPsec-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:DescribeVcoRouteEntries

list

*VpnConnections

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID wilayah koneksi IPsec-VPN. Anda dapat memanggil operasi DescribeRegions untuk mengkueri daftar wilayah terbaru.	cn-hangzhou
VpnConnectionId	string	Yes	ID koneksi IPsec-VPN.	vco-p0w2jpkhi2eeop6q6****
RouteEntryType	string	No	Tipe entri rute. Nilai valid: custom (default): entri rute tujuan. bgp: entri rute BGP.	custom
PageNumber	integer	No	Nomor halaman. Nilai default: 1.	1
PageSize	integer	No	Jumlah entri yang dikembalikan pada setiap halaman. Nilai default: 10. Nilai valid: 1 hingga 50.	10
ClientToken	string	No	Token klien yang digunakan untuk memastikan idempotensi permintaan. Anda dapat menggunakan klien untuk menghasilkan nilai ini, tetapi Anda harus memastikan nilainya 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 dari setiap permintaan API bersifat unik.	123e4567-e89b-12d3-a456-4266****

Elemen respons

Element	Type	Description	Example
	object	Tanggapan.
PageNumber	integer	Nomor halaman.	1
PageSize	integer	Jumlah entri yang dikembalikan per halaman.	10
RequestId	string	ID permintaan.	E18980E8-C8C2-31BD-8156-AE2BBDEC87E1
TotalCount	integer	Jumlah total entri.	1
VcoRouteEntries	array<object>	Daftar entri rute.
	object	Entri rute.
AsPath	string	Daftar nomor sistem otonom (AS) yang dilalui entri rute BGP.	[12000]
Community	string	Nilai komunitas yang dibawa oleh entri rute BGP.	65535:65510
CreateTime	integer	Pengatur waktu saat entri rute tujuan dibuat. Pengatur waktu mengikuti format waktu UNIX. Ini mewakili jumlah total detik yang telah berlalu sejak 00:00:00 UTC pada 1 Januari 1970.	1658217008000
NextHop	string	Lompatan berikutnya dari entri rute.	vco-p0w2jpkhi2eeop6q6****
NextHopTunnelIdList	array	Daftar saluran data lompatan berikutnya. Catatan Informasi ini hanya dikembalikan untuk koneksi IPsec-VPN dalam mode dual-tunnel. Informasi saluran data hanya dikembalikan ketika status saluran data adalah Phase 2 negotiation succeeded.
	string	ID saluran data.	tun-0jothw962cp3bvhbw****
PrefixListId	string	ID instans daftar awalan.	pl-m5estsqsdqwg88hjf****
RouteDest	string	Blok CIDR tujuan entri rute.	192.168.10.0/24
RouteEntryType	string	Tipe entri rute. custom: Entri rute adalah entri rute tujuan. bgp: Entri rute adalah entri rute BGP.	custom
Source	string	Sumber entri rute BGP. CLOUD: Entri rute BGP dipelajari oleh koneksi IPsec-VPN dari Router transit. VPN_BGP: Entri rute BGP dipelajari oleh koneksi IPsec-VPN dari Pusat data lokal.	CLOUD
State	string	Status entri rute. published: Entri rute tujuan dipublikasikan ke Router transit. Active: Entri rute BGP tersedia.	published
VpnConnectionId	string	ID koneksi IPsec-VPN.	vco-p0w2jpkhi2eeop6q6****
Weight	integer	Bobot entri rute tujuan. Catatan Parameter ini tidak berlaku.	100
VpnRouteCounts	array<object>	Statistik entri rute untuk koneksi IPsec-VPN dalam mode dua saluran data. Catatan Informasi ini hanya dikembalikan untuk koneksi IPsec-VPN dalam mode dua saluran data.
	object	Statistik entri rute.
RouteCount	integer	Jumlah entri rute.	3
RouteEntryType	string	Tipe entri rute. custom: entri rute tujuan. bgp: entri rute BGP.	bgp
Source	string	Sumber entri rute BGP. CLOUD: Entri rute BGP dipelajari oleh koneksi IPsec-VPN dari Router transit. VPN_BGP: Entri rute BGP dipelajari oleh koneksi IPsec-VPN dari Pusat data lokal.	VPN_BGP

Contoh

Respons sukses

JSONformat

{
  "PageNumber": 1,
  "PageSize": 10,
  "RequestId": "E18980E8-C8C2-31BD-8156-AE2BBDEC87E1",
  "TotalCount": 1,
  "VcoRouteEntries": [
    {
      "AsPath": "[12000]",
      "Community": "65535:65510",
      "CreateTime": 1658217008000,
      "NextHop": "vco-p0w2jpkhi2eeop6q6****",
      "NextHopTunnelIdList": [
        "tun-0jothw962cp3bvhbw****"
      ],
      "PrefixListId": "pl-m5estsqsdqwg88hjf****",
      "RouteDest": "192.168.10.0/24",
      "RouteEntryType": "custom",
      "Source": "CLOUD",
      "State": "published",
      "VpnConnectionId": "vco-p0w2jpkhi2eeop6q6****",
      "Weight": 100
    }
  ],
  "VpnRouteCounts": [
    {
      "RouteCount": 3,
      "RouteEntryType": "bgp",
      "Source": "VPN_BGP"
    }
  ]
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	IllegalParam.RouteEntryType	The specified RouteEntryType is invalid.	Tipe entri rute yang ditentukan tidak valid.
400	Vco.StatusNotSupport	The current VPN connection state does not support this operation.	Status instans saat ini tidak mendukung operasi ini.
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 memiliki izin untuk melakukan operasi pada sumber daya yang ditentukan. Ajukan izin yang diperlukan dan coba lagi.
404	InvalidVpnConnectionInstanceId.NotFound	The specified vpn connection instance id does not exist.	Koneksi IPsec-VPN yang ditentukan tidak ada. Periksa apakah ID koneksi VPN benar.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.