Querying Routers

Function

This API is used to query all routers accessible to the tenant submitting the request.

URI

GET /v2.0/routers

Example:

GET https://{Endpoint}/v2.0/routers?id={id}&name={name}&admin_state_up={admin_state_up}&tenant_id={tenant_id}&status={status}

Example of querying routers by page

GET https://{Endpoint}/v2.0/routers?limit=2&marker=01ab4be1-4447-45fb-94be-3ee787ed4ebe&page_reverse=False

Table 1 describes the parameters.

**Table 1** Parameter description
Name	Mandatory	Type	Description
id	No	String	Specifies that the router ID is used as the filtering condition.
admin_state_up	No	Boolean	Specifies that the admin state is used as the filtering condition. The value can be true or false.
status	No	String	Specifies that the router status is used as the filtering condition. The value can be ACTIVE, DOWN, or ERROE.
tenant_id	No	String	Specifies that the project ID is used as the filtering condition.
marker	No	String	Specifies the start resource ID of pagination query. If the parameter is left blank, only resources on the first page are queried.
limit	No	Integer	Specifies the number of records on each page. The value ranges from 0 to intmax.

Request Message

None

Response Message

**Table 2** Response parameter
Parameter	Type	Description
routers	Array of router objects	Specifies the router list. For details, see Table 3.
routers_links	Array of routers_link objects	Specifies the pagination information. For details, see Table 6.

**Table 3** **router** objects
Attribute	Type	Description
id	String	Specifies the router ID. This parameter is not mandatory when you query routers.
name	String	Specifies the router name. The name can contain only letters, digits, underscores (_), hyphens (-), and periods (.).
admin_state_up	Boolean	Specifies the administrative status. The value can only be true.
status	String	Specifies the router status. The value can be ACTIVE, DOWN, or ERROR.
tenant_id	String	Specifies the project ID.
external_gateway_info	Object	Specifies the external gateway. This is an extended attribute. For details, see the external_gateway_info objects.
routes	Array of route objects	Specifies a route list. This is an extended attribute. For details, see Table 5.
project_id	String	Specifies the project ID. For details about how to obtain a project ID, see Obtaining a Project ID.
created_at	String	Specifies the time (UTC) when the router is created. Format: yyyy-MM-ddTHH:mm:ss
updated_at	String	Specifies the time (UTC) when the router is updated. Format: yyyy-MM-ddTHH:mm:ss

**Table 4** **external_gateway_info** objects
Attribute	Type	Description
network_id	String	Specifies the UUID of the external network. You can use GET /v2.0/networks?router:external=True or run the neutron net-external-list command to query information about the external network.
enable_snat	Boolean	Specifies whether the SNAT function is enabled. The default value is false.

**Table 5** **route** objects
Attribute	Type	Description
destination	String	Specifies the IP address range.
nexthop	String	Specifies the next hop IP address. The IP address can only be one in the subnet associated with the router.

**Table 6** **routers_link** object
Name	Type	Description
href	String	Specifies the API link.
rel	String	Specifies the relationship between the API link and the API version.

Example

Example request

GET https://{Endpoint}/v2.0/routers?limit=1

Example response

{
    "routers": [
        {
            "id": "01ab4be1-4447-45fb-94be-3ee787ed4ebe",
            "name": "xiaoleizi-tag",
            "status": "ACTIVE",
            "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c",
            "project_id": "bbfe8c41dd034a07bebd592bf03b4b0c",
            "admin_state_up": true,
            "external_gateway_info": {
                "network_id": "0a2228f2-7f8a-45f1-8e09-9039e1d09975",
                "enable_snat": false
            },
            "routes": [
                {
                    "destination": "0.0.0.0/0",
                    "nexthop": "172.16.0.124"
                }
            ],
            "created_at": "2018-03-23T09:26:08",
            "updated_at": "2018-08-24T08:49:53"
        }
    ]
}