DescribeVcoRouteEntries - VPN Gateway - Alibaba Cloud Documentation Center

Mengkueri informasi entri 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

Tidak ada otorisasi untuk operasi ini. Jika Anda mengalami masalah saat menjalankan operasi ini, hubungi dukungan teknis.

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID wilayah koneksi IPsec-VPN. Anda dapat memanggil operasi DescribeRegions untuk mengkueri ID wilayah.	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 daftar. Nilai default: 1.	1
PageSize	integer	No	Jumlah entri per halaman untuk penomoran 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 token, tetapi Anda harus memastikan bahwa token tersebut unik di antara permintaan yang berbeda. Token klien hanya dapat berisi karakter ASCII. Catatan Jika Anda tidak menentukan parameter ini, sistem secara otomatis menggunakan nilai RequestId sebagai nilai ClientToken. RequestId dari setiap permintaan API berbeda.	123e4567-e89b-12d3-a456-4266****

Elemen respons

Element	Type	Description	Example
	object	Parameter tanggapan.
TotalCount	integer	Jumlah total entri yang dikembalikan.	1
PageNumber	integer	Nomor halaman daftar.	1
PageSize	integer	Jumlah entri per halaman untuk penomoran halaman.	10
VcoRouteEntries	array<object>	Daftar entri rute.
	object	Informasi entri rute.
VpnConnectionId	string	ID koneksi IPsec-VPN.	vco-p0w2jpkhi2eeop6q6****
RouteDest	string	Blok CIDR tujuan entri rute.	192.168.10.0/24
NextHop	string	Lompatan berikutnya entri rute.	vco-p0w2jpkhi2eeop6q6****
Weight	integer	Bobot entri rute tujuan. Catatan Parameter ini tidak digunakan.	100
State	string	Status entri rute. published: Entri rute tujuan telah dipublikasikan ke instans Router transit. Active: Entri rute BGP tersedia.	published
RouteEntryType	string	Tipe rute. custom: Rute entri rute tujuan. bgp: Rute entri rute BGP.	custom
CreateTime	integer	Stempel waktu saat entri rute tujuan dibuat. Stempel waktu dalam format UNIX dan merepresentasikan jumlah milidetik yang telah berlalu sejak 1 Januari 1970, 00:00:00 UTC.	1658217008000
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
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
NextHopTunnelIdList	array	Daftar saluran data lompatan berikutnya. Catatan Informasi ini hanya dikembalikan untuk koneksi IPsec-VPN saluran data ganda. 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 entri rute untuk koneksi IPsec-VPN saluran data ganda. Catatan Informasi ini hanya dikembalikan untuk 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 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

{
  "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
400	IllegalParam.RouteEntryType	The specified RouteEntryType is invalid.
400	Vco.StatusNotSupport	The current VPN connection state does not support this operation.
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.
404	InvalidVpnConnectionInstanceId.NotFound	The specified vpn connection instance id does not exist.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.