Подключиться
Yandex Virtual Private Cloud

Virtual Private Cloud API, REST: RouteTable.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.

HTTP request

POST https://vpc.api.cloud.yandex.net/vpc/v1/routeTables

Body parameters

{
  "folderId": "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
folderId string

Required. ID of the folder that the route table belongs to. To get the folder ID use a list request.

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 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 key must match the regular expression [a-z][-_0-9a-z]*. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_0-9a-z]*.
networkId string

Required. ID of the network the route table belongs to.

The maximum string length in characters is 50.
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

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": true,
  "metadata": "object",

  //  includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": "object",
  // 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 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).
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 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).
done boolean (boolean)

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 object

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.
error object
The error result of the operation in case of failure or cancellation.
includes only one of the fields error, response
error.
code		 integer (int32)

Error code. An enum value of google.rpc.Code.
error.
message		 string

An error message.
error.
details[]		 object

A list of messages that carry the error details.
response object
includes only one of the fields error, response

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.
В этой статье: