BareMetal API, gRPC: PrivateSubnetService.List

Field

Description

folder_id

string

ID of the folder to list private subnets in.

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

page_token

string

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

order_by

string

By which column the listing should be ordered and in which direction,
format is "createdAt desc". "id asc" if omitted.
Supported fields: ["id", "name", "createdAt"].
Both snake_case and camelCase are supported for fields.

filter

string

A filter expression that filters resources listed in the response.
The expression consists of one or more conditions united by AND operator: <condition1> [AND <condition2> [<...> AND <conditionN>]].

Each condition has the form <field> <operator> <value>, where:

1. <field> is the field name. Currently you can use filtering only on the limited number of fields.
2. <operator> is a logical operator, one of = (equal), : (substring).
3. <value> represents a value.
   String values should be written in double (") or single (') quotes. C-style escape sequences are supported (\" turns to ", \' to ', \\ to backslash).
   Example: "key1='value' AND key2='value'"
   Supported operators: ["AND"].
   Supported fields: ["id", "name", "zoneId", "hardwarePoolId"].
   Both snake_case and camelCase are supported for fields.

Field

Description

private_subnets[]

PrivateSubnet

List of PrivateSubnet resources.

next_page_token

string

Token for getting the next page of the list. If the number of results is greater than
ListImagesRequest.page_size, use next_page_token as the value
for the ListImagesRequest.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

id

string

ID of the private subnet.

cloud_id

string

ID of the cloud that the private subnet belongs to.

folder_id

string

ID of the folder that the private subnet belongs to.

name

string

Name of the private subnet.
The name is unique within the folder.

description

string

Optional description of the private subnet.

status

enum Status

Status of the private subnet.

• STATUS_UNSPECIFIED: Unspecified private subnet status.
• CREATING: Private subnet is being created.
• READY: Private subnet is ready to use.
• UPDATING: Private subnet is being updated.
• DELETING: Private subnet is being deleted.
• ERROR: Private subnet encountered a problem and cannot operate.

zone_id

string

ID of the availability zone where the server resides.

hardware_pool_id

string

ID of the hardware pool that the private subnet belongs to.

vrf_options

VrfOptions

Optional VRF options for the private subnet. If missing, the private subnet will be unrouted,
i.e. it will lack a DHCP server and routing capabilities between this subnet and other private
subnets.

created_at

google.protobuf.Timestamp

Creation timestamp.

labels

object (map<string, string>)

Resource labels as key:value pairs.

Field

Description

vrf_id

string

ID of the VRF.

cidr

string

CIDR block for the subnet.

dhcp_options

DhcpOptions

DHCP options for the subnet.

gateway_ip

string

Gateway IP address for the 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).