BareMetal API, REST: BootImage.ListBootImages

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

filter

string

Filter expression following AIP-160.

Supported fields and operators:

• bootImageId, name - =, !=, : (contains)
• state - =, !=

Example: state = "READY" AND name : "ubuntu".

Field

Description

bootImages[]

BootImage

List of BootImage resources.

nextPageToken

string

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

bootImageId

string

ID of the image.

cloudId

string

ID of the cloud that the image belongs to.

folderId

string

ID of the folder that the image belongs to.

name

string

Name of the image.
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

Description of the image.

The maximum string length in characters is 1024.

uri

string

URI of the source image to create the new image from.
Currently only supports links to images that are stored in Object Storage.
Currently only supports ISO formats.

The maximum string length in characters is 1024.

checksum

string

MD5 checksum of the image.

state

enum (State)

State of the image.

• CREATING: Image is being created.
• READY: Image is ready to use.
• ERROR: Image encountered an error.
• DELETING: Image is being deleted.
• UPDATING: Image is being updated.

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)

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