BareMetal API, REST: PublicSubnet.ListPublicSubnets

Field

Description

cloudId

string

Required field. ID of the parent cloud.

To get the cloud ID, use a yandex.cloud.resourcemanager.v1.CloudService.List request.

folderId

string

Required field. ID of the parent folder.

To get the folder ID, use a yandex.cloud.resourcemanager.v1.FolderService.List request.

Field

Description

pageSize

string (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.nextPageToken
that can be used to get the next page of results in subsequent list requests.
Default value is 20.

The maximum value is 1000.

pageToken

string

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

orderBy

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

publicSubnets[]

PublicSubnet

List of PublicSubnet resources.

nextPageToken

string

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

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

Field

Description

publicSubnetId

string

ID of the public subnet.

cloudId

string

ID of the cloud that the public subnet belongs to.

folderId

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.

hardwarePoolIds[]

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.

autoAllocation

AutoAllocation

Automatic CIDR allocation from the system public prefix pool.

Includes only one of the fields autoAllocation, manualAllocation.

Method for allocating CIDR block to the public subnet.

manualAllocation

ManualAllocation

Manual CIDR allocation with explicit CIDR from user's own public prefix pool (BYOIP).

Includes only one of the fields autoAllocation, manualAllocation.

Method for allocating CIDR block to the public subnet.

prefixLength

string (int64)

Prefix length of the public subnet CIDR block.

cidr

string

CIDR block for the public subnet.

dhcpOptions

DhcpOptions

DHCP options for the public subnet.

gatewayIp

string

Gateway IP address for the public subnet.

publicPrefixPoolId

string

ID of the public prefix pool that the public subnet belongs to.

createTime

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).

updateTime

string (date-time)

Update 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).

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.

deletionUnlockTime

string (date-time)

Timestamp when deletion of the public subnet is allowed.

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).

Field

Description

prefixLength

string (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.

publicPrefixPoolId

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

startIp

string

Start IP address of the DHCP range (inclusive).

endIp

string

End IP address of the DHCP range (inclusive).