Contact UsGet started

Virtual Private Cloud API, gRPC: NetworkService.ListRouteTables

Written by
Updated at December 17, 2024

Lists route tables from the specified network.

gRPC request

rpc ListRouteTables (ListNetworkRouteTablesRequest) returns (ListNetworkRouteTablesResponse)

ListNetworkRouteTablesRequest

{
  "network_id": "string",
  "page_size": "int64",
  "page_token": "string"
}

Field

Description

network_id

string

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

page_size

int64

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

page_token

string

Page token. Set page_token
to the ListNetworkRouteTablesResponse.next_page_token
returned by a previous list request to get the next page of results.

ListNetworkRouteTablesResponse

{
  "route_tables": [
    {
      "id": "string",
      "folder_id": "string",
      "created_at": "google.protobuf.Timestamp",
      "name": "string",
      "description": "string",
      "labels": "map<string, string>",
      "network_id": "string",
      "static_routes": [
        {
          // Includes only one of the fields `destination_prefix`
          "destination_prefix": "string",
          // end of the list of possible fields
          // Includes only one of the fields `next_hop_address`, `gateway_id`
          "next_hop_address": "string",
          "gateway_id": "string",
          // end of the list of possible fields
          "labels": "map<string, string>"
        }
      ]
    }
  ],
  "next_page_token": "string"
}

Field

Description

route_tables[]

RouteTable

List of route tables that belong to the network which is specified in the request.

next_page_token

string

This token allows you to get the next page of results for list requests. If the number of results
is larger than ListNetworkRouteTablesRequest.page_size, use
the next_page_token as the value
for the ListNetworkRouteTablesRequest.page_token query parameter
in the next list request. Subsequent list requests will have their own
next_page_token to continue paging through the results.

RouteTable

A RouteTable resource. For more information, see Static Routes.

Field

Description

id

string

ID of the route table.

folder_id

string

ID of the folder that the route table belongs to.

created_at

google.protobuf.Timestamp

Creation timestamp in RFC3339 text format.

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])?.

description

string

Optional description of the route table. 0-256 characters long.

labels

object (map<string, string>)

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]*.

network_id

string

ID of the network the route table belongs to.

static_routes[]

StaticRoute

List of static routes.

StaticRoute

A StaticRoute resource. For more information, see Static Routes.

Field

Description

destination_prefix

string

Destination subnet in CIDR notation

Includes only one of the fields destination_prefix.

next_hop_address

string

Next hop IP address

Includes only one of the fields next_hop_address, gateway_id.

gateway_id

string

Next hop gateway id

Includes only one of the fields next_hop_address, gateway_id.

labels

object (map<string, string>)

Resource labels as key:value pairs. Maximum of 64 per resource.
Previous
ListSecurityGroups
Next
ListOperations