ListTransitRouterRouteEntries - Cloud Enterprise Network

Mengambil detail entri rute dalam tabel rute TransitRouter edisi perusahaan.

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

cen:ListTransitRouterRouteEntries

get

TransitRouterRouteEntry

acs:cen:*:{#accountId}:centransitrouterroutentry/{#centransitrouterroutentryId}

TransitRouterRouteTable

acs:cen:*:{#accountId}:centransitrouterroutetable/{#centransitrouterroutetableId}

TransitRouterRouteEntry

acs:cen:*:{#accountId}:centransitrouterroutentry/*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
MaxResults	integer	No	Jumlah entri per halaman. Nilai yang valid: 1 hingga 100. Nilai default: 20.	20
TransitRouterRouteEntryDestinationCidrBlock `deprecated`	string	No	Blok CIDR tujuan dari entri rute. Parameter ini akan ditinggalkan. Kami menyarankan Anda menggunakan parameter RouteFilter.	192.168.0.0/24
TransitRouterRouteEntryStatus	string	No	Status entri rute. Nilai yang valid: All Active (default) Rejected Prohibited Standby Candidate Jika Anda tidak menentukan nilai, entri rute dalam status aktif yang akan ditanyakan.	Active
TransitRouterRouteTableId	string	Yes	ID tabel rute router transit edisi perusahaan.	vtb-bp1dudbh2d5na6b50****
NextToken	string	No	Token paginasi yang digunakan dalam permintaan berikutnya untuk mengambil halaman hasil baru. Nilai yang valid: Anda tidak perlu menentukan parameter ini untuk permintaan pertama. Anda harus menentukan token yang diperoleh dari kueri sebelumnya sebagai nilai NextToken.	fce19****
TransitRouterRouteEntryNames	array	No	Nama entri rute.	testname
	string	No	Nama entri rute. Nama bersifat opsional. Jika Anda memasukkan nama, panjangnya harus antara 1 hingga 128 karakter, dan tidak boleh diawali dengan http:// atau https://. Catatan Anda dapat menggunakan parameter ini hanya untuk menanyakan route statis dalam tabel rute yang ditentukan. Parameter ini bertentangan dengan kondisi kueri lainnya kecuali TransitRouterRouteEntryIds.	testname
TransitRouterRouteEntryIds	array	No	ID entri rute.	rte-oklkgwmj97z6dn****
	string	No	ID entri rute. Catatan Anda dapat menggunakan parameter ini hanya untuk menanyakan route statis dalam tabel rute yang ditentukan. Parameter ini bertentangan dengan kondisi kueri lainnya kecuali TransitRouterRouteEntryNames.	rte-oklkgwmj97z6dn****
TransitRouterRouteEntryType	string	No	Tipe entri rute. Nilai yang valid: Propagated: dipelajari secara otomatis oleh tabel rute. Static: route statis.	Propagated
TransitRouterRouteEntryNextHopType	string	No	Tipe lompatan berikutnya. Nilai yang valid: BlackHole: mengarahkan network traffic ke black hole. Attachment: mengarahkan network traffic ke koneksi instans jaringan.	Attachment
TransitRouterRouteEntryNextHopId	string	No	ID koneksi instans jaringan yang ingin Anda tentukan sebagai lompatan berikutnya.	tr-attach-nls9fzkfat8934****
TransitRouterRouteEntryNextHopResourceId	string	No	ID lompatan berikutnya.	vpc-m5ent6du8deaq5*****
TransitRouterRouteEntryNextHopResourceType	string	No	Tipe lompatan berikutnya. Nilai yang valid: VPC VBR TR VPN	VPC
TransitRouterRouteEntryOriginResourceId	string	No	ID instans sumber.	vpc-m5ent6du8deaq5*****
TransitRouterRouteEntryOriginResourceType	string	No	Tipe instans sumber. Nilai yang valid: VPC VBR TR VPN	VPC
PrefixListId	string	No	ID daftar awalan.	pl-6ehtn5kqxgeyy08fi****
RouteFilter	array<object>	No	Kondisi filter.
	object	No	Kondisi filter.
Key	string	No	Pola pencocokan untuk memfilter blok CIDR. Nilai yang valid: PrefixExactMatchCidrs: pencocokan eksak. LongestPrefixMatchCidrs: pencocokan awalan terpanjang. Anda dapat menentukan alamat IP dan blok CIDR. SubnetOfMatchCidrs: pencocokan subnet. Subnet dari blok CIDR yang ditentukan, termasuk blok CIDR itu sendiri, dicocokkan terhadap kondisi pencocokan. SupernetOfMatchCidrs: pencocokan supernet. Supernet dari blok CIDR, termasuk blok CIDR itu sendiri, dicocokkan terhadap kondisi pencocokan. Secara default, operator logika di antara kondisi filter adalah AND. Informasi tentang entri rute hanya dikembalikan jika entri rute tersebut sesuai dengan semua kondisi filter. Kondisi filter harus unik.	PrefixExactMatchCidrs
Value	array	No	Nilai filter.
	string	No	Tentukan nilai filter berdasarkan Key. Anda dapat menentukan beberapa nilai untuk satu key. Operator logika di antara nilai-nilai tersebut adalah OR, yang berarti entri rute cocok jika permintaan sesuai dengan salah satu nilai tersebut. Anda dapat menentukan maksimal 500 nilai untuk setiap kondisi pencocokan. Alamat IPv4 dan blok CIDR serta alamat IPv6 dan blok CIDR didukung.	192.168.1.0/24

Elemen respons

Element	Type	Description	Example
	object	Parameter respons.
NextToken	string	Token paginasi. Token ini dapat digunakan dalam permintaan berikutnya untuk mengambil halaman hasil baru. Nilai yang valid: Jika NextToken kosong, tidak ada halaman berikutnya. Jika nilai dikembalikan untuk NextToken, nilai tersebut merupakan token yang menentukan titik awal kueri berikutnya.	fce19****
RequestId	string	ID permintaan.	C3835E5E-1504-4344-B1BB-98A4110F1079
TotalCount	integer	Total jumlah entri yang dikembalikan.	6
MaxResults	integer	Jumlah entri per halaman.	20
TransitRouterRouteEntries	array<object>	Daftar entri rute.
	array<object>	Informasi tentang entri rute.
TransitRouterRouteEntryId	string	ID entri rute. Catatan Parameter ini hanya dikembalikan untuk route statis.	rte-oklkgwmj97z6dn****
TransitRouterRouteEntryDestinationCidrBlock	string	Blok CIDR tujuan dari entri rute. Blok CIDR IPv4 atau IPv6 dikembalikan.	192.168.0.0/24
TransitRouterRouteEntryType	string	Tipe entri rute. Nilai yang valid: Static: route statis. Propagated: dipelajari secara otomatis oleh tabel rute.	Static
CreateTime	string	Waktu saat entri rute dibuat. Waktu mengikuti standar ISO8601 dalam format YYYY-MM-DDThh:mmZ. Waktu ditampilkan dalam UTC. Catatan Parameter ini hanya dikembalikan untuk route statis.	2021-06-15T07:01Z
TransitRouterRouteEntryName	string	Nama entri rute. Catatan Parameter ini hanya dikembalikan untuk route statis.	testname
TransitRouterRouteEntryStatus	string	Status entri rute. Nilai yang valid: Active Rejected Prohibited Standby Candidate Creating Deleting	Active
TransitRouterRouteEntryNextHopType	string	Tipe lompatan berikutnya. Nilai yang valid: BlackHole: route blackhole. Paket yang ditujukan ke blok CIDR tujuan entri rute akan dibuang. Attachment: koneksi instans jaringan. Paket yang ditujukan ke blok CIDR tujuan entri rute akan diteruskan ke koneksi instans jaringan yang ditentukan.	BlackHole
TransitRouterRouteEntryNextHopId	string	ID lompatan berikutnya. Parameter ini tidak dikembalikan jika entri rute merupakan route blackhole.	tr-attach-vx6iwhjr1x1j78****
TransitRouterRouteEntryDescription	string	Deskripsi entri rute. Catatan Parameter ini hanya dikembalikan untuk route statis.	CidrRoute
OperationalMode	boolean	Menunjukkan apakah entri rute dapat dikelola. Nilai yang valid: true: Entri rute dapat dikelola. Anda dapat menghapus entri rute tersebut. false: Entri rute tidak dapat dikelola karena dihasilkan secara otomatis oleh sistem.	false
Tag	string	Tag entri rute. Hanya PermitVbr yang mungkin dikembalikan, yang menunjukkan bahwa entri rute hanya diiklankan ke tabel rute Virtual Border Router (VBR) yang terhubung ke router transit. Catatan Parameter ini hanya dikembalikan untuk entri rute yang blok CIDR-nya dihasilkan secara otomatis oleh sistem.	PermitVbr
TransitRouterRouteEntryNextHopResourceId	string	ID lompatan berikutnya.	vpc-m5ent6du8deaq5*****
TransitRouterRouteEntryNextHopResourceType	string	Tipe lompatan berikutnya. Nilai yang valid: VPC VBR TR VPN	VPC
TransitRouterRouteEntryOriginResourceType	string	Tipe instans sumber. Nilai yang valid: VPC VBR TR VPN	VPC
TransitRouterRouteEntryOriginResourceId	string	ID instans sumber.	vpc-m5ent6du8deaq5*****
PrefixListId	string	ID daftar awalan.	pl-k1ainl66z3527773d****
PathAttributes	object	Atribut entri rute.
Communities	array	Komunitas entri rute.
	string	Atribut komunitas entri rute.	65501:1
AsPaths	array	Jalur AS entri rute.
	string	Jalur AS entri rute.	65501
OriginInstanceId	string	ID instans sumber.	vbr-m5ent6du8deaq5*****
OriginInstanceType	string	Tipe instans sumber. Nilai yang valid: VPC VBR TR VPN CCN	VBR
OriginRouteType	string	Tipe entri rute. Nilai yang valid: System Custom static BGP BlackHole	BGP
Preference	integer	Prioritas rute. Nilai yang lebih kecil menunjukkan prioritas yang lebih tinggi.	50

Contoh

Respons sukses

JSONformat

{
  "NextToken": "fce19****",
  "RequestId": "C3835E5E-1504-4344-B1BB-98A4110F1079",
  "TotalCount": 6,
  "MaxResults": 20,
  "TransitRouterRouteEntries": [
    {
      "TransitRouterRouteEntryId": "rte-oklkgwmj97z6dn****",
      "TransitRouterRouteEntryDestinationCidrBlock": "192.168.0.0/24",
      "TransitRouterRouteEntryType": "Static",
      "CreateTime": "2021-06-15T07:01Z",
      "TransitRouterRouteEntryName": "testname",
      "TransitRouterRouteEntryStatus": "Active",
      "TransitRouterRouteEntryNextHopType": "BlackHole",
      "TransitRouterRouteEntryNextHopId": "tr-attach-vx6iwhjr1x1j78****",
      "TransitRouterRouteEntryDescription": "CidrRoute",
      "OperationalMode": false,
      "Tag": "PermitVbr",
      "TransitRouterRouteEntryNextHopResourceId": "vpc-m5ent6du8deaq5*****",
      "TransitRouterRouteEntryNextHopResourceType": "VPC",
      "TransitRouterRouteEntryOriginResourceType": "VPC",
      "TransitRouterRouteEntryOriginResourceId": "vpc-m5ent6du8deaq5*****",
      "PrefixListId": "pl-k1ainl66z3527773d****",
      "PathAttributes": {
        "Communities": [
          "65501:1"
        ],
        "AsPaths": [
          "65501"
        ],
        "OriginInstanceId": "vbr-m5ent6du8deaq5*****\n",
        "OriginInstanceType": "VBR",
        "OriginRouteType": "BGP",
        "Preference": 50
      }
    }
  ]
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	IllegalParam.TransitRouterRouteTableId	TransitRouterRouteTableId is illegal.	The error message returned because the route table ID of the transit router (TransitRouterRouteTableId) is invalid.
400	IllegalParam.TransitRouterRouteEntryStatus	TransitRouterRouteEntryStatus is illegal.	The error message returned because the status of the route on the transit router (TransitRouterRouteEntryStatus) is invalid.
400	IllegalParam.NextToken	NextToken is illegal.	The error message returned because the NextToken parameter is set to an invalid value.
400	ParamExclusive.RouteEntryIdsAndStatus	TransitRouterRouteEntryIds and TransitRouterRouteEntryStatus is mutually exclusive.	The error message returned because the TransitRouterRouteEntryIds and TransitRouterRouteEntryStatus parameters conflict with each other.
400	InvalidTransitRouterRouteTableId.NotFound	TransitRouterRouteTableId is not found.	The error message returned because the specified route table ID of the transit router does not exist.
400	FilterKeyDuplicated.RouteFilter	The keys in RouteFilter are duplicated.	The error message returned because RouteFilter contains duplicate key values.
400	InvalidFilterKey	The key in filter is invalid.	The key in filter is invalid.
400	IllegalParam.TransitRouterRouteEntryNextHopType	TransitRouterRouteEntryNextHopType is invalid.	The error message returned because the TransitRouterRouteEntryNextHopType parameter is set to an invalid value.
400	IllegalParam.TransitRouterRouteEntryNextHopAttachmentId	TransitRouterRouteEntryNextHopAttachmentId is invalid.	The error message returned because TransitRouterRouteEntryNextHopAttachmentId is set to an invalid value.
400	IllegalParam.TransitRouterRouteEntryNextHopResourceId	TransitRouterRouteEntryNextHopResourceId is invalid.	The error message returned because TransitRouterRouteEntryNextHopResourceId is set to an invalid value.
400	IllegalParam.TransitRouterRouteEntryNextHopResourceType	TransitRouterRouteEntryNextHopResourceType is invalid.	The error message returned because TransitRouterRouteEntryNextHopResourceType is set to an invalid value.
400	IllegalParam.TransitRouterRouteEntryOriginResourceId	TransitRouterRouteEntryOriginResourceId is invalid.	The error message returned because TransitRouterRouteEntryOriginResourceId is set to an invalid value.
400	IllegalParam.TransitRouterRouteEntryOriginResourceType	TransitRouterRouteEntryOriginResourceType is invalid.	The error message returned because TransitRouterRouteEntryOriginResourceType is set to an invalid value.
400	IllegalParam.TransitRouterRouteEntryType	TransitRouterRouteEntryType is invalid.	The error message returned because TransitRouterRouteEntryType is set to an invalid value.
400	IllegalParam.PrefixExactMatchCidr	PrefixExactMatchCidr is invalid.	The error message returned because PrefixExactMatchCidr is set to an invalid value.
400	IllegalParam.LongestPrefixMatchCidr	LongestPrefixMatchCidr is invalid.	The error message returned because LongestPrefixMatchCidr is set to an invalid value.
400	IllegalParam.SubnetOfMatchCidr	SubnetOfMatchCidr is invalid.	The error message returned because SubnetOfMatchCidr is set to an invalid value.
400	IllegalParam.SupernetOfMatchCidr	SupernetOfMatchCidr is invalid.	The error message returned because SupernetOfMatchCidr is set to an invalid value.
400	InvalidName	Name is invalid.	The error message returned because the specified name is invalid.
400	IllegalParam.TextMatchCidr	The TextMatchCidr specified in the parameter is illegal.	The TextMatchCidr specified in the parameter is illegal.
400	ResourceNotFound.PrefixlistAssociation	The prefix list is not associated with this route table.	The error message returned because the specified prefix list is not associated with a route table.
400	InvalidParameter	Invalid parameter.	The error message returned because the parameter is set to an invalid value.
400	Unauthorized	The AccessKeyId is unauthorized.	The error message returned because you do not have the permissions to perform this operation.
404	InvalidRouteTableId.NotFound	The specified RouteTableId is not found.	The specified route table ID does not exist.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.