BareMetal API, gRPC: ImageService.ListImages

Field

Description

folder_id

string

ID of the parent folder. "baremetal-standard-images" folder contains general images and used by default

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 ListImagesResponse.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
ListImagesResponse.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: imageId, createTime.
Default order: imageId asc.

filter

string

Filter expression following AIP-160.

Supported fields and operators:

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

Example: name : "ubuntu".

Field

Description

images[]

Image

List of StandardImage 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

image_id

string

ID of the image.

folder_id

string

ID of the folder that the image belongs to.

name

string

Name of the image

family

string

Family of the image

state

enum Status

State of the image.

• PUBLISHED: Image is published and available to users.
• DISABLED: Image is disabled for new installations but preserved for existing servers.

publish_time

google.protobuf.Timestamp

Timestamp when the image was published.

cloud_id

string

ID of the cloud that the image belongs to.