BareMetal API, gRPC: PublicSubnetService.CreatePublicSubnet

Статья создана

Yandex Cloud

Обновлена 1 июля 2026 г.

Открыть в Markdown

gRPC request
CreatePublicSubnetRequest
PublicSubnet
AutoAllocation
ManualAllocation
DhcpOptions
operation.Operation

Creates a public subnet in the specified folder.

https://google.aip.dev/130 --)

gRPC request

rpc CreatePublicSubnet (CreatePublicSubnetRequest) returns (operation.Operation)

CreatePublicSubnetRequest

{
  "cloud_id": "string",
  "folder_id": "string",
  "public_subnet": {
    "public_subnet_id": "string",
    "cloud_id": "string",
    "folder_id": "string",
    "name": "string",
    "description": "string",
    "hardware_pool_ids": [
      "string"
    ],
    "type": "Type",
    // Includes only one of the fields `auto_allocation`, `manual_allocation`
    "auto_allocation": {
      "prefix_length": "int64"
    },
    "manual_allocation": {
      "cidr": "string",
      "public_prefix_pool_id": "string"
    },
    // end of the list of possible fields
    "prefix_length": "int64",
    "cidr": "string",
    "dhcp_options": {
      "start_ip": "string",
      "end_ip": "string"
    },
    "gateway_ip": "string",
    "public_prefix_pool_id": "string",
    "create_time": "google.protobuf.Timestamp",
    "update_time": "google.protobuf.Timestamp",
    "annotations": "map<string, string>",
    "deletion_unlock_time": "google.protobuf.Timestamp"
  }
}

Field	Description
cloud_id	string ID of the parent cloud. To get the cloud ID, use a yandex.cloud.resourcemanager.v1.CloudService.List request.
folder_id	string ID of the parent folder. To get the folder ID, use a yandex.cloud.resourcemanager.v1.FolderService.List request.
public_subnet	PublicSubnet PublicSubnet resource to create.

PublicSubnet

A PublicSubnet resource.

Field	Description
public_subnet_id	string ID of the public subnet.
cloud_id	string ID of the cloud that the public subnet belongs to.
folder_id	string ID of the folder that the public subnet belongs to.
name	string Name of the public subnet. The name is unique within the folder. The string length in characters must be 2-63. Value must match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`.
description	string Optional description of the public subnet. The maximum string length in characters is 1024.
hardware_pool_ids[]	string IDs of the hardware pool that the public subnet belongs to.
type	enum Type Type of the public subnet (dedicated or ephemeral). Cannot be set on creation. It's DEDICATED by default. EPHEMERAL networks are created only within the server. Only EPHEMERAL -> DEDICATED update is possible. `DEDICATED`: Dedicated public subnet. `EPHEMERAL`: Ephemeral public subnet.
auto_allocation	AutoAllocation Automatic CIDR allocation from the system public prefix pool. Includes only one of the fields `auto_allocation`, `manual_allocation`. Method for allocating CIDR block to the public subnet.
manual_allocation	ManualAllocation Manual CIDR allocation with explicit CIDR from user's own public prefix pool (BYOIP). Includes only one of the fields `auto_allocation`, `manual_allocation`. Method for allocating CIDR block to the public subnet.
prefix_length	int64 Prefix length of the public subnet CIDR block.
cidr	string CIDR block for the public subnet.
dhcp_options	DhcpOptions DHCP options for the public subnet.
gateway_ip	string Gateway IP address for the public subnet.
public_prefix_pool_id	string ID of the public prefix pool that the public subnet belongs to.
create_time	google.protobuf.Timestamp Creation timestamp.
update_time	google.protobuf.Timestamp Update timestamp.
annotations	object (map<string, string>) Resource annotations as `key:value` pairs. The maximum string length in characters for each value is 63. The string length in characters for each key must be 1-63. Each key must match the regular expression `[a-z][-_0-9a-z]`. Each value must match the regular expression `[-_0-9a-z]`. No more than 64 per resource.
deletion_unlock_time	google.protobuf.Timestamp Timestamp when deletion of the public subnet is allowed.

AutoAllocation

Field

Description

prefix_length

int64

Prefix length of the public subnet CIDR block.

Acceptable values are 1 to 31, inclusive.

ManualAllocation

Field

Description

cidr

string

CIDR block of the public subnet. Must be within the public prefix pool CIDR block.

public_prefix_pool_id

string

ID of the public prefix pool that the CIDR block belongs to.

To get a list of available public prefix pools, use the [PublicPrefixPoolService.List] request.

DhcpOptions

DHCP options for a subnet.

Field

Description

start_ip

string

Start IP address of the DHCP range (inclusive).

end_ip

string

End IP address of the DHCP range (inclusive).

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": "google.protobuf.Any",
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": "google.protobuf.Any"
  // 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.
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.
error	google.rpc.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	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. 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.

BareMetal API, gRPC: PublicSubnetService.CreatePublicSubnet

gRPC requestgRPC request

CreatePublicSubnetRequestCreatePublicSubnetRequest

PublicSubnetPublicSubnet

AutoAllocationAutoAllocation

ManualAllocationManualAllocation

DhcpOptionsDhcpOptions

operation.Operationoperation.Operation

Была ли статья полезна?

gRPC request

CreatePublicSubnetRequest

PublicSubnet

AutoAllocation

ManualAllocation

DhcpOptions

operation.Operation