RouteTableService

A set of methods for managing RouteTable resources.

Call	Description
Get	Returns the specified RouteTable resource.
List	Retrieves the list of RouteTable resources in the specified folder.
Create	Creates a route table in the specified folder and network.
Update	Updates the specified route table.
Delete	Deletes the specified route table.
ListOperations	List operations for the specified route table.
Move	Move route table to another folder.

Calls RouteTableService

Get

Returns the specified RouteTable resource.
To get the list of available RouteTable resources, make a List request.

rpc Get (GetRouteTableRequest) returns (RouteTable)

GetRouteTableRequest

Field	Description
route_table_id	string Required. ID of the RouteTable resource to return. To get the route table ID use a RouteTableService.List request. false The maximum string length in characters is 50.

RouteTable

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 is unique within the project. 3-63 characters long.
description	string Optional description of the route table. 0-256 characters long.
labels	map<string,string> Resource labels as key:value pairs. Мaximum of 64 per resource.
network_id	string ID of the network the route table belongs to.
static_routes[]	StaticRoute List of static routes.

StaticRoute

Field	Description
destination	oneof: destination_prefix
destination_prefix	string Destination subnet in CIDR notation
next_hop	oneof: next_hop_address
next_hop_address	string Next hop IP address
labels	map<string,string> Resource labels as key:value pairs. Мaximum of 64 per resource.

List

Retrieves the list of RouteTable resources in the specified folder.

rpc List (ListRouteTablesRequest) returns (ListRouteTablesResponse)

ListRouteTablesRequest

Field	Description
folder_id	string Required. ID of the folder that the route table belongs to. To get the folder ID use a yandex.cloud.resourcemanager.v1.FolderService.List request. false The maximum string length in characters is 50.
page_size	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. The maximum value is 1000.
page_token	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. The maximum string length in characters is 100.
filter	string The field name. Currently you can use filtering only on RouteTable.name field. An operator. Can be either = or != for single values, IN or NOT IN for lists of values. The value. Must be 3-63 characters long and match the regular expression ^[a-z][-a-z0-9]{1,61}[a-z0-9]$. The maximum string length in characters is 1000.

ListRouteTablesResponse

Field	Description
route_tables[]	RouteTable List of RouteTable resources.
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 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

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 is unique within the project. 3-63 characters long.
description	string Optional description of the route table. 0-256 characters long.
labels	map<string,string> Resource labels as key:value pairs. Мaximum of 64 per resource.
network_id	string ID of the network the route table belongs to.
static_routes[]	StaticRoute List of static routes.

StaticRoute

Field	Description
destination	oneof: destination_prefix
destination_prefix	string Destination subnet in CIDR notation
next_hop	oneof: next_hop_address
next_hop_address	string Next hop IP address
labels	map<string,string> Resource labels as key:value pairs. Мaximum of 64 per resource.

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.

rpc Create (CreateRouteTableRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:CreateRouteTableMetadata

    Operation.response:RouteTable

CreateRouteTableRequest

Field	Description
folder_id	string Required. ID of the folder that the route table belongs to. To get the folder ID use a yandex.cloud.resourcemanager.v1.FolderService.List request. false The maximum string length in characters is 50.
name	string Name of the route table. The name must be unique within the folder. Value must match the regular expression |[a-z][-a-z0-9]{1,61}[a-z0-9].
description	string Description of the route table. The maximum string length in characters is 256.
labels	map<string,string> Resource labels, key:value pairs. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_0-9a-z]*. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]*.
network_id	string Required. ID of the network the route table belongs to. false The maximum string length in characters is 50.
static_routes[]	StaticRoute List of static routes.

StaticRoute

Field	Description
destination	oneof: destination_prefix
destination_prefix	string Destination subnet in CIDR notation
next_hop	oneof: next_hop_address
next_hop_address	string Next hop IP address
labels	map<string,string> Resource labels as key:value pairs. Мaximum of 64 per resource.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata	google.protobuf.Any<CreateRouteTableMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result	oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<RouteTable> if operation finished successfully.

CreateRouteTableMetadata

Field	Description
route_table_id	string ID of the route table that is being created.

RouteTable

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 is unique within the project. 3-63 characters long.
description	string Optional description of the route table. 0-256 characters long.
labels	map<string,string> Resource labels as key:value pairs. Мaximum of 64 per resource.
network_id	string ID of the network the route table belongs to.
static_routes[]	StaticRoute List of static routes.

Update

Updates the specified route table. Method starts an asynchronous operation that can be cancelled while it is in progress.

rpc Update (UpdateRouteTableRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:UpdateRouteTableMetadata

    Operation.response:RouteTable

UpdateRouteTableRequest

Field	Description
route_table_id	string Required. ID of the RouteTable resource to update. false The maximum string length in characters is 50.
update_mask	google.protobuf.FieldMask Field mask that specifies which fields of the RouteTable resource are going to be updated.
name	string Name of the route table. The name must be unique within the folder. Value must match the regular expression |[a-z][-a-z0-9]{1,61}[a-z0-9].
description	string Description of the route table. The maximum string length in characters is 256.
labels	map<string,string> Resource labels as key:value pairs. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_0-9a-z]*. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]*.
static_routes[]	StaticRoute List of static routes.

StaticRoute

Field	Description
destination	oneof: destination_prefix
destination_prefix	string Destination subnet in CIDR notation
next_hop	oneof: next_hop_address
next_hop_address	string Next hop IP address
labels	map<string,string> Resource labels as key:value pairs. Мaximum of 64 per resource.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata	google.protobuf.Any<UpdateRouteTableMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result	oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<RouteTable> if operation finished successfully.

UpdateRouteTableMetadata

Field	Description
route_table_id	string ID of the RouteTable resource that is being updated.

RouteTable

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 is unique within the project. 3-63 characters long.
description	string Optional description of the route table. 0-256 characters long.
labels	map<string,string> Resource labels as key:value pairs. Мaximum of 64 per resource.
network_id	string ID of the network the route table belongs to.
static_routes[]	StaticRoute List of static routes.

Delete

Deletes the specified route table.

rpc Delete (DeleteRouteTableRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:DeleteRouteTableMetadata

    Operation.response:google.protobuf.Empty

DeleteRouteTableRequest

Field	Description
route_table_id	string Required. ID of the route table to delete. To get the route table ID use a RouteTableService.List request. false The maximum string length in characters is 50.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata	google.protobuf.Any<DeleteRouteTableMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result	oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<google.protobuf.Empty> if operation finished successfully.

DeleteRouteTableMetadata

Field	Description
route_table_id	string ID of the RouteTable resource that is being deleted.

ListOperations

List operations for the specified route table.

rpc ListOperations (ListRouteTableOperationsRequest) returns (ListRouteTableOperationsResponse)

ListRouteTableOperationsRequest

Field	Description
route_table_id	string Required. ID of the RouteTable resource to list operations for. false The maximum string length in characters is 50.
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 ListRouteTableOperationsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Default value: 100. The maximum value is 1000.
page_token	string Page token. To get the next page of results, set page_token to the ListRouteTableOperationsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.

ListRouteTableOperationsResponse

Field	Description
operations[]	operation.Operation List of operations for the specified RouteTable resource.
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 ListRouteTableOperationsRequest.page_size, use the next_page_token as the value for the ListRouteTableOperationsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata	google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result	oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any.

Move

Move route table to another folder.

rpc Move (MoveRouteTableRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:MoveRouteTableMetadata

    Operation.response:RouteTable

MoveRouteTableRequest

Field	Description
route_table_id	string Required. ID of the RouteTable resource to move. false The maximum string length in characters is 50.
destination_folder_id	string Required. ID of the destination folder. false The maximum string length in characters is 50.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata	google.protobuf.Any<MoveRouteTableMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result	oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<RouteTable> if operation finished successfully.

MoveRouteTableMetadata

Field	Description
route_table_id	string ID of the RouteTable resource that is being moved.

RouteTable

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 is unique within the project. 3-63 characters long.
description	string Optional description of the route table. 0-256 characters long.
labels	map<string,string> Resource labels as key:value pairs. Мaximum of 64 per resource.
network_id	string ID of the network the route table belongs to.
static_routes[]	StaticRoute List of static routes.