BareMetal API, gRPC: PublicSubnetService.ListPublicSubnets

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.

page_size

int64

The maximum number of results per page to return. If the number of available
results is greater than page_size,
the service returns a ListPublicSubnetsResponse.next_page_token
that can be used to get the next page of results in subsequent list requests.
Default value is 20.

The maximum value is 1000.

page_token

string

Page token. To get the next page of results, set page_token to the
ListPublicSubnetsResponse.next_page_token returned by a previous list request.

order_by

string

Sorting order for the listing. Follows the AIP-132 order_by format:
"field [asc|desc]", e.g. "createTime desc".

Supported fields: publicSubnetId, createTime, updateTime.
Default order: publicSubnetId asc.

filter

string

Filter expression following AIP-160.

Supported fields and operators:

• publicSubnetId, name - =, !=, : (contains)
• state, type - =, !=
• hardwarePoolIds - : (contains)

Example: state = "READY" AND type = "STANDARD".

Field

Description

public_subnets[]

PublicSubnet

List of PublicSubnet resources.

next_page_token

string

Token for getting the next page of the list. If the number of results is greater than
ListPublicSubnetsRequest.page_size, use next_page_token as the value
for the ListPublicSubnetsRequest.page_token parameter in the next list request.

Each subsequent page will have its own next_page_token to continue paging through the results.

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.

Field

Description

prefix_length

int64

Prefix length of the public subnet CIDR block.

Acceptable values are 1 to 31, inclusive.

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.

Field

Description

start_ip

string

Start IP address of the DHCP range (inclusive).

end_ip

string

End IP address of the DHCP range (inclusive).