DescribeRouteEntryList - Virtual Private Cloud - Alibaba Cloud Documentation Center

Mengkueri daftar entri rute.

Deskripsi operasi

Sebelum memanggil operasi DeleteRouteEntry untuk menghapus entri rute, Anda dapat memanggil operasi ini untuk mengkueri informasi lompatan berikutnya dari entri rute yang akan dihapus.

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

get

*RouteTable

acs:vpc:{#regionId}:{#accountId}:routetable/{#RouteTableId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID wilayah tabel rute tempat entri rute berada. Anda dapat memanggil operasi DescribeRegions untuk mengkueri ID wilayah.	cn-hangzhou
RouteTableId	string	Yes	ID tabel rute yang akan dikueri.	vtb-bp1r9pvl4xen8s9ju****
RouteEntryId	string	No	ID entri rute yang akan dikueri.	rte-bp1mnnr2al0naomnp****
DestinationCidrBlock	string	No	Blok CIDR tujuan entri rute. Blok CIDR IPv4 dan IPv6 didukung.	192.168.2.0/24
RouteEntryName	string	No	Nama entri rute. Panjang nama harus 1 hingga 128 karakter dan tidak boleh diawali dengan `http://` atau `https://`.	abc
IpVersion	string	No	Versi protokol IP. Nilai valid: ipv4: Protokol IPv4. ipv6: Protokol IPv6.	ipv4
RouteEntryType	string	No	Tipe entri rute. Nilai valid: Custom: Rute kustom. System: Rute sistem. BGP: Rute BGP. CEN: Rute Cloud Enterprise Network (CEN). ECR: Rute Express Connect Router.	System
NextHopId	string	No	ID instans lompatan berikutnya.	vpn-bp10zyaph5cc8b7c7****
NextHopType	string	No	Tipe lompatan berikutnya. Nilai valid: Instance (default): Instance ECS. HaVip: Alamat IP virtual ketersediaan tinggi (HAVIP). VpnGateway: Gateway VPN. NatGateway: Gateway NAT. NetworkInterface: Antarmuka jaringan elastis sekunder. RouterInterface: Antarmuka router. IPv6Gateway: Gateway IPv6. Attachment: Router transit. Ipv4Gateway: Gateway IPv4. GatewayEndpoint: Titik akhir gerbang. Ecr: Express Connect Router.	Instance
MaxResult	integer	No	Jumlah entri yang dikembalikan per halaman. Nilai valid: 1 hingga 100. Nilai default: 10.	10
NextToken	string	No	Token paginasi. Nilai valid: Anda tidak perlu menentukan parameter ini untuk kueri pertama atau jika tidak ada kueri berikutnya. Jika ada kueri berikutnya, atur nilai ke nilai NextToken yang dikembalikan dari panggilan API sebelumnya.	FFmyTO70tTpLG6I3FmYAXGKPd****
RegionId	string	Yes	The region ID of the route table to which the route entry belongs. You can call the DescribeRegions operation to query the region ID.	cn-hangzhou
ServiceType	string	No	Tipe layanan rute. Jika bidang ini kosong, rute tidak dikelola. Nilai valid: TR, yang menunjukkan bahwa tipe yang dikelola adalah router transit.	TR
DestCidrBlockList	array	No	Daftar blok CIDR tujuan entri rute.
	string	No	Informasi daftar blok CIDR tujuan entri rute. Maksimal 20 blok CIDR tujuan dapat ditentukan.	192.168.0.0/24

Elemen respons

Element	Type	Description	Example
	object	Informasi detail tentang entri rute.
NextToken	string	Apakah token kueri berikutnya (Token) ada. Nilai valid: Jika NextToken kosong, tidak ada kueri berikutnya. Jika NextToken memiliki nilai yang dikembalikan, nilai tersebut menunjukkan token untuk kueri berikutnya.	FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId	string	ID permintaan.	14A07460-EBE7-47CA-9757-12CC4761D47A
RouteEntrys	object
RouteEntry	array<object>	Informasi entri rute.
	array<object>	Informasi entri rute.
Status	string	Status entri rute. Nilai valid: Pending: sedang dikonfigurasi. Available: tersedia. Modifying: sedang dimodifikasi. Deleting: sedang dihapus.	Available
Type	string	Tipe entri rute. Nilai valid: Custom: rute kustom. System: Rute sistem. BGP: rute BGP. CEN: rute Cloud Enterprise Network (CEN). ECR: rute Express Connect Router.	System
IpVersion	string	Versi protokol IP. Nilai valid: ipv4: IPv4. ipv6: IPv6.	ipv4
Description	string	Deskripsi entri rute.	RouteEntryDescription
RouteEntryName	string	Nama entri rute.	aaa
DestinationCidrBlock	string	Blok CIDR tujuan entri rute.	192.168.2.0/24
RouteEntryId	string	ID entri rute.	rte-bp1mnnr2al0naomnp****
RouteTableId	string	ID tabel rute.	vtb-bp15w5q90d2rk3bww****
GmtModified	string	Waktu entri rute dimodifikasi. Waktu ditampilkan dalam UTC dengan format `YYYY-MM-DDThh:mm:ssZ`.	2022-05-09T03:00:07Z
NextHops	object
NextHop	array<object>	Informasi tentang lompatan berikutnya.
	array<object>	Informasi tentang lompatan berikutnya.
NextHopRegionId	string	ID wilayah instans lompatan berikutnya. Catatan Parameter ini hanya dikembalikan ketika tipe lompatan berikutnya adalah RouterInterface.	cn-hangzhou
Weight	integer	Bobot entri rute. Catatan Parameter ini hanya dikembalikan ketika tipe lompatan berikutnya adalah RouterInterface.	100
NextHopId	string	ID instans lompatan berikutnya.	vpn-bp10zyaph5cc8b7c7****
Enabled	integer	Apakah entri rute tersedia. Nilai valid: 0: tidak tersedia. 1: tersedia. Catatan Parameter ini hanya dikembalikan ketika tipe lompatan berikutnya adalah RouterInterface.	1
NextHopType	string	Tipe lompatan berikutnya. Nilai valid: Instance: Instans ECS. HaVip: alamat IP virtual ketersediaan tinggi (HAVIP). VpnGateway: Gateway VPN. NatGateway: Gateway Network Address Translation (NAT). NetworkInterface: antarmuka jaringan elastis sekunder (ENI). RouterInterface: antarmuka router. IPv6Gateway: gateway IPv6. Attachment: Router transit. Ipv4Gateway: gateway IPv4. GatewayEndpoint: titik akhir gerbang. Ecr: Express Connect Router.	Instance
NextHopRelatedInfo	object	Informasi tentang lompatan berikutnya.
InstanceId	string	ID instans yang terkait dengan lompatan berikutnya.	vpc-bp1t36rn9l53iwbsf****
InstanceType	string	Tipe instans yang terkait dengan lompatan berikutnya. Nilai valid: VPC: virtual private cloud (VPC). VBR: virtual border router (VBR). PCONN: sirkuit Express Connect.	VPC
RegionId	string	ID wilayah instans yang terkait dengan lompatan berikutnya.	ch-hangzhou
ServiceType	string	Tipe hosting entri rute. Jika bidang ini kosong, entri rute tidak di-host. Nilai valid: TR, yang menunjukkan bahwa tipe hosting adalah Router transit.	TR
Origin	string	Sumber entri rute. Nilai valid: RoutePropagation: dibuat oleh propagasi dinamis. SystemCreate: dibuat oleh sistem. CustomCreate: dibuat secara kustom.	RoutePropagation

Contoh

Respons sukses

JSONformat

{
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "14A07460-EBE7-47CA-9757-12CC4761D47A",
  "RouteEntrys": {
    "RouteEntry": [
      {
        "Status": "Available",
        "Type": "System",
        "IpVersion": "ipv4",
        "Description": "RouteEntryDescription",
        "RouteEntryName": "aaa",
        "DestinationCidrBlock": "192.168.2.0/24",
        "RouteEntryId": "rte-bp1mnnr2al0naomnp****",
        "RouteTableId": "vtb-bp15w5q90d2rk3bww****",
        "GmtModified": "2022-05-09T03:00:07Z",
        "NextHops": {
          "NextHop": [
            {
              "NextHopRegionId": "cn-hangzhou",
              "Weight": 100,
              "NextHopId": "vpn-bp10zyaph5cc8b7c7****",
              "Enabled": 1,
              "NextHopType": "Instance",
              "NextHopRelatedInfo": {
                "InstanceId": "vpc-bp1t36rn9l53iwbsf****",
                "InstanceType": "VPC",
                "RegionId": "ch-hangzhou"
              }
            }
          ]
        },
        "ServiceType": "TR",
        "Origin": "RoutePropagation"
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	IllegalParam.NextToken	User nextToken is illegal.
400	InvalidNextHop.NotFound	The specified route entry nexthop does not exist in our records.
400	OperationFailed.QueryCenEntry	Operation is denied because getting CEN route entry has failed.	The query failed because the CEN route cannot be obtained at this time.
400	OperationDenied.UseGatewayRouteEntryQueryInterface	Use listGatewayRouteTableEntries to describe gateway route entries.	To query gateway route table entries, use the listGatewayRouteTableEntries operation.
400	InvalidRouteTable.NotFound	The specified RouteTable was not found.	The specified route table was not found.
400	IllegalParam.RouteEntryType	The parameter of RouteEntryType is illegal.	The parameter RouteEntryType is invalid.
400	MissingParam.context	The param of context is missing.	The parameter context is missing.
400	MissingParam.aliUid	The param of aliUid is missing.	The parameter aliUid is missing.
400	MissingParam.bid	The param of bid is missing.	The parameter bid is missing.
400	IllegalParam.IpVersion	Param IpVersion illegal.	Invalid parameter: IpVersion.
400	OperationFailed.FilterParamUnderWrongRouteType	Operation failed because only custom type support filter by routeEntryId or routeEntryName	The operation failed because only custom route entries support filtering by route entry ID or route entry name.
400	IllegalParam.NextTokenExpired	The parameter of NextTokenExpired is illegal.	The parameter NextTokenExpired is invalid.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.