Virtual Private Cloud API, REST: RouteTable.List
Retrieves the list of RouteTable resources in the specified folder.
HTTP request
GET https://vpc.api.cloud.yandex.net/vpc/v1/routeTables
Query parameters
Field |
Description |
folderId |
string Required field. ID of the folder that the route table belongs to. |
pageSize |
string (int64) The maximum number of results per page to return. If the number of available |
pageToken |
string Page token. To get the next page of results, set |
filter |
string A filter expression that filters resources listed in the response.
|
Response
HTTP Code: 200 - OK
{
"routeTables": [
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "string",
"networkId": "string",
"staticRoutes": [
{
// Includes only one of the fields `destinationPrefix`
"destinationPrefix": "string",
// end of the list of possible fields
// Includes only one of the fields `nextHopAddress`, `gatewayId`
"nextHopAddress": "string",
"gatewayId": "string",
// end of the list of possible fields
"labels": "string"
}
]
}
],
"nextPageToken": "string"
}
Field |
Description |
routeTables[] |
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 |
RouteTable
A RouteTable resource. For more information, see Static Routes.
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 String in RFC3339 To work with values in this field, use the APIs described in the |
name |
string Name of the route table. |
description |
string Optional description of the route table. 0-256 characters long. |
labels |
string Resource labels, |
networkId |
string ID of the network the route table belongs to. |
staticRoutes[] |
List of static routes. |
StaticRoute
A StaticRoute resource. For more information, see Static Routes.
Field |
Description |
destinationPrefix |
string Destination subnet in CIDR notation Includes only one of the fields |
nextHopAddress |
string Next hop IP address Includes only one of the fields |
gatewayId |
string Next hop gateway id Includes only one of the fields |
labels |
string Resource labels as |