BareMetal API, gRPC: PublicPrefixPoolService.ListPublicPrefixPools

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 ListPublicPrefixPoolsResponse.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
ListPublicPrefixPoolsResponse.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: publicPrefixPoolId, createTime, updateTime.
Default order: publicPrefixPoolId asc.

filter

string

Filter expression following AIP-160.

Supported fields and operators:

• publicPrefixPoolId, name - =, !=, : (contains)

Example: name : "prod".

Field

Description

public_prefix_pools[]

PublicPrefixPool

List of PublicPrefixPool resources.

next_page_token

string

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

string

ID of the public prefix pool.

cloud_id

string

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

folder_id

string

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

name

string

Name of the public prefix pool.

The maximum string length in characters is 63.

description

string

Description of the public prefix pool.

The maximum string length in characters is 1024.

cidr

string

CIDR block of the public prefix pool.

min_available_prefix

google.protobuf.Int64Value

Minimal prefix that could be used for subnet creation

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.