Virtual Private Cloud API, REST: RouteTable.Update
Updates the specified route table.
Method starts an asynchronous operation that can be cancelled while it is in progress.
HTTP request
PATCH https://vpc.api.cloud.yandex.net/vpc/v1/routeTables/{routeTableId}
Path parameters
Field |
Description |
routeTableId |
string Required field. ID of the RouteTable resource to update. |
Body parameters
{
"updateMask": "string",
"name": "string",
"description": "string",
"labels": "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"
}
]
}
Field |
Description |
updateMask |
string (field-mask) A comma-separated names off ALL fields to be updated. If |
name |
string Name of the route table. |
description |
string Description of the route table. |
labels |
string Resource labels as |
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 |
Response
HTTP Code: 200 - OK
{
"id": "string",
"description": "string",
"createdAt": "string",
"createdBy": "string",
"modifiedAt": "string",
"done": "boolean",
"metadata": {
"routeTableId": "string"
},
// Includes only one of the fields `error`, `response`
"error": {
"code": "integer",
"message": "string",
"details": [
"object"
]
},
"response": {
"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"
}
]
}
// end of the list of possible fields
}
An Operation resource. For more information, see Operation.
Field |
Description |
id |
string ID of the operation. |
description |
string Description of the operation. 0-256 characters long. |
createdAt |
string (date-time) Creation timestamp. String in RFC3339 To work with values in this field, use the APIs described in the |
createdBy |
string ID of the user or service account who initiated the operation. |
modifiedAt |
string (date-time) The time when the Operation resource was last modified. String in RFC3339 To work with values in this field, use the APIs described in the |
done |
boolean If the value is |
metadata |
Service-specific metadata associated with the operation. |
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |
UpdateRouteTableMetadata
Field |
Description |
routeTableId |
string ID of the RouteTable resource that is being updated. |
Status
The error result of the operation in case of failure or cancellation.
Field |
Description |
code |
integer (int32) Error code. An enum value of google.rpc.Code |
message |
string An error message. |
details[] |
object A list of messages that carry the error details. |
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 |