Skip to main content

List

Retrieves the list of RouteTable resources in the specified folder.

import { cloudApi, serviceClients, Session } from "@yandex-cloud/nodejs-sdk";

const ListRouteTablesRequest =
  cloudApi.vpc.route_table_service.ListRouteTablesRequest;

(async () => {
  const authToken = process.env["YC_OAUTH_TOKEN"];
  const session = new Session({ oauthToken: authToken });
  const client = session.client(serviceClients.RouteTableServiceClient);

  const result = await client.list(
    ListRouteTablesRequest.fromPartial({
      folderId: "folderId",
      // pageSize: 0,
      // pageToken: "pageToken",
      // filter: "filter"
    })
  );
  console.log(result);
})();

ListRouteTablesRequest​

folderId : string​

ID of the folder that the route table belongs to. To get the folder ID use a yandex.cloud.resourcemanager.v1.FolderService.List request.

pageSize : int64​

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

pageToken : string​

Page token. To get the next page of results, set page_token to the ListRouteTablesResponse.next_page_token returned by a previous list request.

filter : string​

A filter expression that filters resources listed in the response. The expression must specify:

  1. The field name. Currently you can use filtering only on RouteTable.name field.
  2. An = operator.
  3. The value in double quotes ("). Must be 3-63 characters long and match the regular expression [a-z][-a-z0-9]{1,61}[a-z0-9].

ListRouteTablesResponse​

routeTables : RouteTable​

List of RouteTable resources.

nextPageToken : string​

This token allows you to get the next page of results for list requests. If the number of results is larger than ListRouteTablesRequest.page_size, use the next_page_token as the value for the ListRouteTablesRequest.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.

id : string​

ID of the route table.

folderId : string​

ID of the folder that the route table belongs to.

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

networkId : string​

ID of the network the route table belongs to.

staticRoutes : StaticRoute​

List of static routes.

StaticRoute​

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

One of destination​

  • destinationPrefix : string​

    Destination subnet in CIDR notation

One of nextHop​

  • nextHopAddress : string​

    Next hop IP address

  • gatewayId : string​

    Next hop gateway id

labels : string​

Resource labels as key:value pairs. Maximum of 64 per resource.