Contact UsGet started
© 2024 Iron Hive LLC Belgrade

Virtual Private Cloud API, REST: Subnet.Create

Written by
Improved by
Updated at October 17, 2024

Creates a subnet 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/subnets

Body parameters

{
  "folderId": "string",
  "name": "string",
  "description": "string",
  "labels": "string",
  "networkId": "string",
  "zoneId": "string",
  "v4CidrBlocks": [
    "string"
  ],
  "routeTableId": "string",
  "dhcpOptions": {
    "domainNameServers": [
      "string"
    ],
    "domainName": "string",
    "ntpServers": [
      "string"
    ]
  }
}

Field

Description

folderId

string

Required field. ID of the folder to create a subnet in.
To get folder ID use a yandex.cloud.resourcemanager.v1.FolderService.List request.

name

string

Name of the subnet.
The name must be unique within the folder.

description

string

Description of the subnet.

labels

string

Resource labels, key:value pairs.

networkId

string

Required field. ID of the network to create subnet in.

zoneId

string

Required field. ID of the availability zone where the subnet resides.
To get a list of available zones, use the yandex.cloud.compute.v1.ZoneService.List request.

v4CidrBlocks[]

string

Required field. CIDR block.
The range of internal addresses that are defined for this subnet.
For example, 10.0.0.0/22 or 192.168.0.0/24.
Minimum subnet size is /28, maximum subnet size is /16.

routeTableId

string

ID of route table the subnet is linked to.

dhcpOptions

DhcpOptions

DhcpOptions

Field

Description

domainNameServers[]

string

A list of DHCP servers for this subnet.

domainName

string

A domain name to us as a suffix when resolving host names in this subnet.

ntpServers[]

string

List of NTP servers for this subnet.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": {
    "subnetId": "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",
    "zoneId": "string",
    "v4CidrBlocks": [
      "string"
    ],
    "v6CidrBlocks": [
      "string"
    ],
    "routeTableId": "string",
    "dhcpOptions": {
      "domainNameServers": [
        "string"
      ],
      "domainName": "string",
      "ntpServers": [
        "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 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

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

CreateSubnetMetadata

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

Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, 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.

response

Subnet

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.

Includes only one of the fields error, 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.

CreateSubnetMetadata

Field

Description

subnetId

string

ID of the subnet that is being created.

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.

Subnet

A Subnet resource. For more information, see Subnets.

Field

Description

id

string

ID of the subnet.

folderId

string

ID of the folder that the subnet 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 subnet.
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 subnet. 0-256 characters long.

labels

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]*.

networkId

string

ID of the network the subnet belongs to.

zoneId

string

ID of the availability zone where the subnet resides.

v4CidrBlocks[]

string

CIDR block.
The range of internal addresses that are defined for this subnet.
This field can be set only at Subnet resource creation time and cannot be changed.
For example, 10.0.0.0/22 or 192.168.0.0/24.
Minimum subnet size is /28, maximum subnet size is /16.

v6CidrBlocks[]

string

IPv6 not available yet.

routeTableId

string

ID of route table the subnet is linked to.

dhcpOptions

DhcpOptions

DHCP options for the subnet.

DhcpOptions

Field

Description

domainNameServers[]

string

A list of DHCP servers for this subnet.

domainName

string

A domain name to us as a suffix when resolving host names in this subnet.

ntpServers[]

string

List of NTP servers for this subnet.
Previous
List
Next
Update