Contact UsGet started

Virtual Private Cloud API, REST: Network.listRouteTables

Written by
Updated at June 28, 2024

Lists route tables from the specified network.

HTTP request

GET https://vpc.api.cloud.yandex.net/vpc/v1/networks/{networkId}/route_tables

Path parameters

Parameter Description
networkId

Required. ID of the Network resource to list route tables for.

The maximum string length in characters is 50.

Query parameters

Parameter Description
pageSize

The maximum number of results per page that should be returned. If the number of available results is larger than pageSize, the service returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Default value: 100.

The maximum value is 1000.
pageToken

Page token. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

The maximum string length in characters is 100.

Response

HTTP Code: 200 - OK

{
  "routeTables": [
    {
      "id": "string",
      "folderId": "string",
      "createdAt": "string",
      "name": "string",
      "description": "string",
      "labels": "object",
      "networkId": "string",
      "staticRoutes": [
        {
          "labels": "object",
          "destinationPrefix": "string",

          // `routeTables[].staticRoutes[]` includes only one of the fields `nextHopAddress`, `gatewayId`
          "nextHopAddress": "string",
          "gatewayId": "string",
          // end of the list of possible fields`routeTables[].staticRoutes[]`

        }
      ]
    }
  ],
  "nextPageToken": "string"
}
Field Description
routeTables[] object

List of route tables that belong to the network which is specified in the request.
routeTables[].
id		 string

ID of the route table.
routeTables[].
folderId		 string

ID of the folder that the route table belongs to.
routeTables[].
createdAt		 string (date-time)

Creation timestamp in RFC3339 text format.

String in RFC3339 text format. The range of possible values is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
routeTables[].
name		 string

Name of the route table. The name must be unique within the folder. Value must match the regular expression |[a-zA-Z]([-_a-zA-Z0-9]{0,61}[a-zA-Z0-9])?.
routeTables[].
description		 string

Optional description of the route table. 0-256 characters long.
routeTables[].
labels		 object

Resource labels, key:value pairs. No more than 64 per resource. The string length in characters for each key must be 1-63. Each value must match the regular expression [-_0-9a-z]*. Each key must match the regular expression [a-z][-_0-9a-z]*.
routeTables[].
networkId		 string

ID of the network the route table belongs to.
routeTables[].
staticRoutes[]		 object

List of static routes.
routeTables[].
staticRoutes[].
labels		 object

Resource labels as key:value pairs. Maximum of 64 per resource.
routeTables[].
staticRoutes[].
destinationPrefix		 string

Destination subnet in CIDR notation
routeTables[].
staticRoutes[].
nextHopAddress		 string
routeTables[].staticRoutes[] includes only one of the fields nextHopAddress, gatewayId

Next hop IP address
routeTables[].
staticRoutes[].
gatewayId		 string
routeTables[].staticRoutes[] includes only one of the fields nextHopAddress, gatewayId

Next hop gateway id
nextPageToken string

This token allows you to get the next page of results for list requests. If the number of results is larger than pageSize, use the nextPageToken as the value for the pageToken query parameter in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
Previous
listOperations
Next
listSecurityGroups