Связаться с намиПодключиться
Yandex Virtual Private Cloud

Virtual Private Cloud API, REST: RouteTable methods

Статья создана
Обновлена 28 июня 2024 г.

A set of methods for managing RouteTable resources.

JSON Representation

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

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

    }
  ]
}
Field Description
id string

ID of the route table.
folderId string

ID of the folder that the route table belongs to.
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).
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

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[] object

List of static routes.
staticRoutes[].
labels		 object

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

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

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

Next hop gateway id

Methods

Method Description
create Creates a route table in the specified folder and network. Method starts an asynchronous operation that can be cancelled while it is in progress.
delete Deletes the specified route table.
get Returns the specified RouteTable resource.
list Retrieves the list of RouteTable resources in the specified folder.
listOperations List operations for the specified route table.
move Move route table to another folder.
update Updates the specified route table. Method starts an asynchronous operation that can be cancelled while it is in progress.
Предыдущая
update
Следующая
create
В этой статье: