DescribeVcoRouteEntries - VPN Gateway - Alibaba Cloud Documentation Center

Mengambil informasi rute koneksi IPsec-VPN dengan memanggil operasi DescribeVcoRouteEntries.

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 menanyakan ID wilayah.	cn-hangzhou
VpnConnectionId	string	Yes	ID koneksi IPsec-VPN.	vco-p0w2jpkhi2eeop6q6****
RouteEntryType	string	No	Jenis rute. Nilai yang valid: custom (default): rute tujuan. bgp: rute BGP.	custom
PageNumber	integer	No	Nomor halaman daftar. Nilai default: 1.	1
PageSize	integer	No	Jumlah entri per halaman untuk kueri berhalaman. Nilai default: 10. Nilai yang valid: 1 hingga 50.	10
ClientToken	string	No	Token client yang digunakan untuk memastikan idempotensi permintaan. Anda dapat menggunakan client untuk menghasilkan token, tetapi Anda harus memastikan bahwa token tersebut unik di antara permintaan yang berbeda. Nilai ClientToken hanya boleh berisi karakter ASCII. Catatan Jika Anda tidak menentukan parameter ini, sistem secara otomatis menggunakan RequestId dari permintaan API sebagai ClientToken. RequestId mungkin berbeda untuk setiap permintaan API.	123e4567-e89b-12d3-a456-4266****

Elemen respons

Element	Type	Description	Example
	object	Parameter respons.
TotalCount	integer	Total jumlah entri yang dikembalikan.	1
PageNumber	integer	Nomor halaman daftar.	1
PageSize	integer	Jumlah entri per halaman untuk kueri berhalaman.	10
VcoRouteEntries	array<object>	Daftar rute.
	object	Informasi rute.
VpnConnectionId	string	ID koneksi IPsec-VPN.	vco-p0w2jpkhi2eeop6q6****
RouteDest	string	Blok CIDR tujuan rute.	192.168.10.0/24
NextHop	string	Lompatan berikutnya rute.	vco-p0w2jpkhi2eeop6q6****
Weight	integer	Bobot rute tujuan. Catatan Parameter ini tidak sedang digunakan.	100
State	string	Status rute. Nilai yang valid: published: Rute tujuan dipublikasikan ke instans router transit. Active: Rute BGP tersedia.	published
RouteEntryType	string	Jenis rute. Nilai yang valid: custom: rute tujuan. bgp: rute BGP.	custom
CreateTime	integer	Timestamp saat rute tujuan dibuat. Timestamp dalam format Unix dan merepresentasikan jumlah milidetik yang telah berlalu sejak 1 Januari 1970 pukul 00:00:00 UTC.	1658217008000
AsPath	string	Daftar nomor sistem otonom (AS) yang dilewati rute BGP.	[12000]
Community	string	Nilai community yang dibawa oleh rute BGP.	65535:65510
Source	string	Sumber rute BGP. Nilai yang valid: CLOUD: Rute BGP dipelajari oleh koneksi IPsec-VPN dari router transit. VPN_BGP: Rute BGP dipelajari oleh koneksi IPsec-VPN dari pusat data lokal.	CLOUD
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 negotiations succeeded.
	string	ID saluran data.	tun-0jothw962cp3bvhbw****
RequestId	string	ID permintaan.	E18980E8-C8C2-31BD-8156-AE2BBDEC87E1
VpnRouteCounts	array<object>	Statistik rute koneksi IPsec-VPN dalam mode dual-tunnel. Catatan Informasi ini hanya dikembalikan untuk koneksi IPsec-VPN dalam mode dual-tunnel.
	object	Statistik rute.
RouteEntryType	string	Jenis rute. Nilai yang valid: custom: rute tujuan. bgp: rute BGP.	bgp
RouteCount	integer	Jumlah rute.	3
Source	string	Sumber rute BGP. Nilai yang valid: CLOUD: Rute BGP dipelajari oleh koneksi IPsec-VPN dari router transit. VPN_BGP: Rute BGP dipelajari oleh koneksi IPsec-VPN dari pusat data lokal.	VPN_BGP

Contoh

Respons sukses

JSONformat

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

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	IllegalParam.RouteEntryType	The specified RouteEntryType is invalid.	Parameter RouteEntryType tidak valid.
400	Vco.StatusNotSupport	The current VPN connection state does not support this operation.	Status saat ini dari gateway pelanggan VPN (VCO) tidak mendukung operasi seperti modifikasi atau penghapusan.
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.