proposalbot bdabc93498 Changes to er_api-ref from docs/doc-exports#716 (ER API 20230411 version

For de

Reviewed-by: Sarda, Priya <prsarda@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>

2024-01-16 12:51:15 +00:00

13 KiB

Raw Blame History

original_name: ListEffectiveRoutes.html

Querying Effective Routes

Function

This API is used to query effective routes. Pagination query is supported. Effective routes are preferred routes.

URI

GET /v3/{project_id}/enterprise-router/route-tables/{route_table_id}/routes

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID
route_table_id	Yes	String	Route table ID

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Number of records on each page. Value range: 0 to 2000 Minimum: 0 Maximum: 2000
marker	No	String	ID of the last route on the previous page. If this parameter is left blank, the first page is queried. This parameter must be used together with limit. Minimum: 1 Maximum: 128
destination	No	Array	Destination address of the route
resource_type	No	Array	Attachment type. vpc: VPC attachments vgw: virtual gateway attachments

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
routes	Array of `EffectiveRoute <listeffectiveroutes__response_effectiveroute>` objects	Routes
request_id	String	Request ID
page_info	`PageInfo <listeffectiveroutes__response_pageinfo>` object	Pagination query information

**Table 4** EffectiveRoute
Parameter	Type	Description
route_id	String	Route ID
destination	String	Destination address of the route
next_hops	Array of `RouteAttachment <listeffectiveroutes__response_routeattachment>` objects	Next hops of the routes
is_blackhole	Boolean	Whether the route is a blackhole route
route_type	String	Route type. Value options: static and propagation
address_group_id	String	IP address group ID. This parameter is not supported for now.

**Table 5** RouteAttachment
Parameter	Type	Description
resource_id	String	Attached resource ID
resource_type	String	Attachment type. vpc: VPC attachments vgw: virtual gateway attachments
attachment_id	String	Attachment ID

**Table 6** PageInfo
Parameter	Type	Description
next_marker	String	Marker of the next page. The value is the resource UUID. If the value is empty, the resource is on the last page.
current_count	Integer	Number of resources in the list

Example Requests

Querying effective routes

GET https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/route-tables/915a14a6-867b-4af7-83d1-70efceb146f9/routes

Example Responses