ImageService
Набор методов для управления ресурсами Image.
Вызов | Описание |
---|---|
Get | Возвращает указанный ресурс Image. |
GetLatestByFamily | Возвращает последний образ из указанного семейства образов. |
List | Возвращает список доступных ресурсов Image в указанном каталоге. |
Create | Создает образ в указанном каталоге. |
Update | Изменяет указанный образ. |
Delete | Удаляет указанный образ. |
ListOperations | Список операций для указанного образа. |
Вызовы ImageService
Get
Возвращает указанный ресурс Image.
Чтобы получить список доступных ресурсов Image, используйте запрос List.
rpc Get (GetImageRequest) returns (Image)
GetImageRequest
Поле | Описание |
---|---|
image_id | string Обязательное поле. Идентификатор возвращаемого ресурса Image. Чтобы получить идентификатор образа, используйте запрос ImageService.List. Максимальная длина строки в символах — 50. |
Image
Поле | Описание |
---|---|
id | string Идентификатор образа. |
folder_id | string Идентификатор каталога, которому принадлежит образ диска. |
created_at | google.protobuf.Timestamp |
name | string Имя образа. Длина 1-63 символов. |
description | string Описание образа. Длина описания должна быть от 0 до 256 символов. |
labels | map<string,string> Метки ресурса в формате ключ:значение . Максимум 64 на ресурс. |
family | string Имя семейства образов, к которому принадлежит этот образ. Вы можете получить самый последний образ из семейства образов, используя запрос yandex.cloud.compute.v1.ImageService.GetLatestByFamily, чтобы создать диск из этого образа. |
storage_size | int64 Размер образа в байтах. |
min_disk_size | int64 Минимальный размер диска, который будет создан из этого образа. |
product_ids[] | string Идентификаторы лицензий, указывающие, какие лицензии подключены к этому ресурсу. Идентификаторы лицензий используются для расчета дополнительной платы за использование виртуальной машины. Правильный идентификатор лицензии генерируется Яндекс.Облаком. Идентификаторы наследуются новыми ресурсами, созданными из этого ресурса. Если вам известны идентификаторы лицензий, укажите их при создании образа. Например, если создать образ диска с помощью сторонней утилиты и загрузить его в Yandex Object Storage, то идентификаторы лицензий будут потеряны. Вы можете указать их в запросе yandex.cloud.compute.v1.ImageService.Create. |
status | enum Status Текущий статус образа диска.
|
os | Os Операционная система, содержащаяся в образе. |
Os
Поле | Описание |
---|---|
type | enum Type Тип операционной системы. Значение по умолчанию — LINUX . Это поле используется для правильной эмуляции vCPU и расчета стоимости использования виртуальной машины.
|
GetLatestByFamily
Возвращает последний образ из указанного семейства образов.
rpc GetLatestByFamily (GetImageLatestByFamilyRequest) returns (Image)
GetImageLatestByFamilyRequest
Поле | Описание |
---|---|
folder_id | string Обязательное поле. Идентификатор каталога для получения образа. Чтобы получить идентификатор каталога, используйте запрос yandex.cloud.resourcemanager.v1.FolderService.List. Максимальная длина строки в символах — 50. |
family | string Имя семейства образов для поиска. Значение должно соответствовать регулярному выражению |[a-z][-a-z0-9]{1,61}[a-z0-9] . |
Image
Поле | Описание |
---|---|
id | string Идентификатор образа. |
folder_id | string Идентификатор каталога, которому принадлежит образ диска. |
created_at | google.protobuf.Timestamp |
name | string Имя образа. Длина 1-63 символов. |
description | string Описание образа. Длина описания должна быть от 0 до 256 символов. |
labels | map<string,string> Метки ресурса в формате ключ:значение . Максимум 64 на ресурс. |
family | string Имя семейства образов, к которому принадлежит этот образ. Вы можете получить самый последний образ из семейства образов, используя запрос yandex.cloud.compute.v1.ImageService.GetLatestByFamily, чтобы создать диск из этого образа. |
storage_size | int64 Размер образа в байтах. |
min_disk_size | int64 Минимальный размер диска, который будет создан из этого образа. |
product_ids[] | string Идентификаторы лицензий, указывающие, какие лицензии подключены к этому ресурсу. Идентификаторы лицензий используются для расчета дополнительной платы за использование виртуальной машины. Правильный идентификатор лицензии генерируется Яндекс.Облаком. Идентификаторы наследуются новыми ресурсами, созданными из этого ресурса. Если вам известны идентификаторы лицензий, укажите их при создании образа. Например, если создать образ диска с помощью сторонней утилиты и загрузить его в Yandex Object Storage, то идентификаторы лицензий будут потеряны. Вы можете указать их в запросе yandex.cloud.compute.v1.ImageService.Create. |
status | enum Status Текущий статус образа диска.
|
os | Os Операционная система, содержащаяся в образе. |
Os
Поле | Описание |
---|---|
type | enum Type Тип операционной системы. Значение по умолчанию — LINUX . Это поле используется для правильной эмуляции vCPU и расчета стоимости использования виртуальной машины.
|
List
Возвращает список доступных ресурсов Image в указанном каталоге.
rpc List (ListImagesRequest) returns (ListImagesResponse)
ListImagesRequest
Поле | Описание |
---|---|
folder_id | string Обязательное поле. Идентификатор каталога для получения списка образов. Чтобы получить идентификатор каталога, используйте запрос yandex.cloud.resourcemanager.v1.FolderService.List. Максимальная длина строки в символах — 50. |
page_size | int64 Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем page_size , сервис вернет значение ListImagesResponse.next_page_token, которое можно использовать для получения следующей страницы. Максимальное значение — 1000. |
page_token | string Токен страницы. Установите значение page_token равным значению поля ListImagesResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100. |
filter | string
|
ListImagesResponse
Поле | Описание |
---|---|
images[] | Image Список образов. |
next_page_token | string Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListSnapshotsRequest.page_size, используйте next_page_token в качестве значения параметра ListSnapshotsRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения next_page_token для перебора страниц результатов. |
Image
Поле | Описание |
---|---|
id | string Идентификатор образа. |
folder_id | string Идентификатор каталога, которому принадлежит образ диска. |
created_at | google.protobuf.Timestamp |
name | string Имя образа. Длина 1-63 символов. |
description | string Описание образа. Длина описания должна быть от 0 до 256 символов. |
labels | map<string,string> Метки ресурса в формате ключ:значение . Максимум 64 на ресурс. |
family | string Имя семейства образов, к которому принадлежит этот образ. Вы можете получить самый последний образ из семейства образов, используя запрос yandex.cloud.compute.v1.ImageService.GetLatestByFamily, чтобы создать диск из этого образа. |
storage_size | int64 Размер образа в байтах. |
min_disk_size | int64 Минимальный размер диска, который будет создан из этого образа. |
product_ids[] | string Идентификаторы лицензий, указывающие, какие лицензии подключены к этому ресурсу. Идентификаторы лицензий используются для расчета дополнительной платы за использование виртуальной машины. Правильный идентификатор лицензии генерируется Яндекс.Облаком. Идентификаторы наследуются новыми ресурсами, созданными из этого ресурса. Если вам известны идентификаторы лицензий, укажите их при создании образа. Например, если создать образ диска с помощью сторонней утилиты и загрузить его в Yandex Object Storage, то идентификаторы лицензий будут потеряны. Вы можете указать их в запросе yandex.cloud.compute.v1.ImageService.Create. |
status | enum Status Текущий статус образа диска.
|
os | Os Операционная система, содержащаяся в образе. |
Os
Поле | Описание |
---|---|
type | enum Type Тип операционной системы. Значение по умолчанию — LINUX . Это поле используется для правильной эмуляции vCPU и расчета стоимости использования виртуальной машины.
|
Create
Создает образ в указанном каталоге.
Вы можете создать образ из диска, снимка, другого образа или URI. Метод запускает асинхронную операцию, которую можно отменить перед тем, как она завершится.
rpc Create (CreateImageRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:CreateImageMetadata
Operation.response:Image
CreateImageRequest
Поле | Описание |
---|---|
folder_id | string Обязательное поле. Идентификатор каталога для создания образа. Чтобы получить идентификатор каталога, используйте запрос yandex.cloud.resourcemanager.v1.FolderService.List. Максимальная длина строки в символах — 50. |
name | string Имя образа. Значение должно соответствовать регулярному выражению |[a-z][-a-z0-9]{1,61}[a-z0-9] . |
description | string Описание образа. Максимальная длина строки в символах — 256. |
labels | map<string,string> Метки ресурса в формате ключ:значение . Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]* . Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
family | string Имя семейства образов, к которому принадлежит этот образ. Дополнительные сведения см. в разделе Семейство образов. Чтобы получить информацию о последнем образе в семействе, используйте запрос ImageService.GetLatestByFamily. Значение должно соответствовать регулярному выражению |[a-z][-a-z0-9]{1,61}[a-z0-9] . |
min_disk_size | int64 Минимальный размер диска, который будет создан из этого образа. Указывается в байтах. Значение должно быть больше размера исходных данных. Допустимые значения — от 4194304 до 4398046511104 включительно. |
product_ids[] | string Идентификаторы лицензий, указывающие, какие лицензии подключены к этому ресурсу. Идентификаторы лицензий используются для расчета дополнительной платы за использование виртуальной машины. Правильный идентификатор лицензии генерируется Яндекс.Облаком. Идентификаторы наследуются новыми ресурсами, созданными из этого ресурса. Если вам известны идентификаторы лицензий, укажите их при создании образа. Например, если создать образ диска с помощью сторонней утилиты и загрузить его в Yandex Object Storage, то идентификаторы лицензий будут потеряны. Вы можете указать их в этом запросе. Максимальная длина строки в символах для каждого значения — 50. |
source | oneof: image_id , disk_id , snapshot_id или uri |
image_id | string Идентификатор образа, из которого будет создан новый образ. Максимальная длина строки в символах — 50. |
disk_id | string Идентификатор диска, из которого будет создан образ. Максимальная длина строки в символах — 50. |
snapshot_id | string Идентификатор снимка, из которого будет создан образ. Максимальная длина строки в символах — 50. |
uri | string URI образа, из которого будет создан новый образ. В настоящее время поддерживаются только ссылки на образы, которые хранятся в Yandex Object Storage. В настоящее время поддерживаются только форматы Qcow2, VMDK и VHD. |
os | Os Операционная система, содержащаяся в образе. По умолчанию наследуется от исходного ресурса, если в качестве источника вы использовали image_id или disk_id . |
Os
Поле | Описание |
---|---|
type | enum Type Тип операционной системы. Значение по умолчанию — LINUX . Это поле используется для правильной эмуляции vCPU и расчета стоимости использования виртуальной машины.
|
Operation
Поле | Описание |
---|---|
id | string Идентификатор операции. |
description | string Описание операции. Длина описания должна быть от 0 до 256 символов. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате в RFC3339. |
created_by | string Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию. |
modified_at | google.protobuf.Timestamp Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339. |
done | bool Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response . |
metadata | google.protobuf.Any<CreateImageMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata . |
result | oneof: error или response Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error . Если done == true — задано значение ровно одного из полей error или response . |
error | google.rpc.Status Описание ошибки в случае сбоя или отмены операции. |
response | google.protobuf.Any<Image> в случае успешного выполнения операции. |
CreateImageMetadata
Поле | Описание |
---|---|
image_id | string Идентификатор создаваемого образа. |
Image
Поле | Описание |
---|---|
id | string Идентификатор образа. |
folder_id | string Идентификатор каталога, которому принадлежит образ диска. |
created_at | google.protobuf.Timestamp |
name | string Имя образа. Длина 1-63 символов. |
description | string Описание образа. Длина описания должна быть от 0 до 256 символов. |
labels | map<string,string> Метки ресурса в формате ключ:значение . Максимум 64 на ресурс. |
family | string Имя семейства образов, к которому принадлежит этот образ. Вы можете получить самый последний образ из семейства образов, используя запрос yandex.cloud.compute.v1.ImageService.GetLatestByFamily, чтобы создать диск из этого образа. |
storage_size | int64 Размер образа в байтах. |
min_disk_size | int64 Минимальный размер диска, который будет создан из этого образа. |
product_ids[] | string Идентификаторы лицензий, указывающие, какие лицензии подключены к этому ресурсу. Идентификаторы лицензий используются для расчета дополнительной платы за использование виртуальной машины. Правильный идентификатор лицензии генерируется Яндекс.Облаком. Идентификаторы наследуются новыми ресурсами, созданными из этого ресурса. Если вам известны идентификаторы лицензий, укажите их при создании образа. Например, если создать образ диска с помощью сторонней утилиты и загрузить его в Yandex Object Storage, то идентификаторы лицензий будут потеряны. Вы можете указать их в запросе yandex.cloud.compute.v1.ImageService.Create. |
status | enum Status Текущий статус образа диска.
|
os | Os Операционная система, содержащаяся в образе. |
Os
Поле | Описание |
---|---|
type | enum Type Тип операционной системы. Значение по умолчанию — LINUX . Это поле используется для правильной эмуляции vCPU и расчета стоимости использования виртуальной машины.
|
Update
Изменяет указанный образ.
rpc Update (UpdateImageRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:UpdateImageMetadata
Operation.response:Image
UpdateImageRequest
Поле | Описание |
---|---|
image_id | string Обязательное поле. Идентификатор изменяемого ресурса Image. Чтобы получить идентификатор образа, используйте запрос ImageService.List. Максимальная длина строки в символах — 50. |
update_mask | google.protobuf.FieldMask Маска, определяющая, какие поля ресурса Image будут обновлены. |
name | string Имя образа. Значение должно соответствовать регулярному выражению |[a-z][-a-z0-9]{1,61}[a-z0-9] . |
description | string Описание образа. Максимальная длина строки в символах — 256. |
min_disk_size | int64 Минимальный размер диска, который может быть создан из этого образа. Указывается в байтах. Должен быть больше объема исходных данных и больше размера виртуального диска. Допустимые значения — от 4194304 до 4398046511104 включительно. |
labels | map<string,string> Метки ресурса в формате ключ:значение . Существующий набор labels полностью перезаписывается набором, переданным в запросе. Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]* . Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
Operation
Поле | Описание |
---|---|
id | string Идентификатор операции. |
description | string Описание операции. Длина описания должна быть от 0 до 256 символов. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате в RFC3339. |
created_by | string Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию. |
modified_at | google.protobuf.Timestamp Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339. |
done | bool Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response . |
metadata | google.protobuf.Any<UpdateImageMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata . |
result | oneof: error или response Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error . Если done == true — задано значение ровно одного из полей error или response . |
error | google.rpc.Status Описание ошибки в случае сбоя или отмены операции. |
response | google.protobuf.Any<Image> в случае успешного выполнения операции. |
UpdateImageMetadata
Поле | Описание |
---|---|
image_id | string Идентификатор изменяемого ресурса Disk. |
Image
Поле | Описание |
---|---|
id | string Идентификатор образа. |
folder_id | string Идентификатор каталога, которому принадлежит образ диска. |
created_at | google.protobuf.Timestamp |
name | string Имя образа. Длина 1-63 символов. |
description | string Описание образа. Длина описания должна быть от 0 до 256 символов. |
labels | map<string,string> Метки ресурса в формате ключ:значение . Максимум 64 на ресурс. |
family | string Имя семейства образов, к которому принадлежит этот образ. Вы можете получить самый последний образ из семейства образов, используя запрос yandex.cloud.compute.v1.ImageService.GetLatestByFamily, чтобы создать диск из этого образа. |
storage_size | int64 Размер образа в байтах. |
min_disk_size | int64 Минимальный размер диска, который будет создан из этого образа. |
product_ids[] | string Идентификаторы лицензий, указывающие, какие лицензии подключены к этому ресурсу. Идентификаторы лицензий используются для расчета дополнительной платы за использование виртуальной машины. Правильный идентификатор лицензии генерируется Яндекс.Облаком. Идентификаторы наследуются новыми ресурсами, созданными из этого ресурса. Если вам известны идентификаторы лицензий, укажите их при создании образа. Например, если создать образ диска с помощью сторонней утилиты и загрузить его в Yandex Object Storage, то идентификаторы лицензий будут потеряны. Вы можете указать их в запросе yandex.cloud.compute.v1.ImageService.Create. |
status | enum Status Текущий статус образа диска.
|
os | Os Операционная система, содержащаяся в образе. |
Os
Поле | Описание |
---|---|
type | enum Type Тип операционной системы. Значение по умолчанию — LINUX . Это поле используется для правильной эмуляции vCPU и расчета стоимости использования виртуальной машины.
|
Delete
Удаляет указанный образ.
Удаление образа — необратимая операция, восстановить удаленный образ невозможно.
rpc Delete (DeleteImageRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:DeleteImageMetadata
Operation.response:google.protobuf.Empty
DeleteImageRequest
Поле | Описание |
---|---|
image_id | string Обязательное поле. Идентификатор удаляемого образа. Чтобы получить идентификатор образа, используйте запрос ImageService.List. Максимальная длина строки в символах — 50. |
Operation
Поле | Описание |
---|---|
id | string Идентификатор операции. |
description | string Описание операции. Длина описания должна быть от 0 до 256 символов. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате в RFC3339. |
created_by | string Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию. |
modified_at | google.protobuf.Timestamp Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339. |
done | bool Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response . |
metadata | google.protobuf.Any<DeleteImageMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata . |
result | oneof: error или response Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error . Если done == true — задано значение ровно одного из полей error или response . |
error | google.rpc.Status Описание ошибки в случае сбоя или отмены операции. |
response | google.protobuf.Any<google.protobuf.Empty> в случае успешного выполнения операции. |
DeleteImageMetadata
Поле | Описание |
---|---|
image_id | string Идентификатор удаляемого образа. |
ListOperations
Список операций для указанного образа.
rpc ListOperations (ListImageOperationsRequest) returns (ListImageOperationsResponse)
ListImageOperationsRequest
Поле | Описание |
---|---|
image_id | string Обязательное поле. Идентификатор ресурса Image, для которого запрашивается список операций. Максимальная длина строки в символах — 50. |
page_size | int64 Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем page_size , сервис вернет значение ListImageOperationsResponse.next_page_token, которое можно использовать для получения следующей страницы. Максимальное значение — 1000. |
page_token | string Токен страницы. Установите значение page_token равным значению поля ListImageOperationsResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100. |
ListImageOperationsResponse
Поле | Описание |
---|---|
operations[] | operation.Operation Список операций для указанного образа. |
next_page_token | string Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListImageOperationsRequest.page_size, используйте next_page_token в качестве значения параметра ListImageOperationsRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения next_page_token для перебора страниц результатов. |
Operation
Поле | Описание |
---|---|
id | string Идентификатор операции. |
description | string Описание операции. Длина описания должна быть от 0 до 256 символов. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате в RFC3339. |
created_by | string Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию. |
modified_at | google.protobuf.Timestamp Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339. |
done | bool Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response . |
metadata | google.protobuf.Any Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata . |
result | oneof: error или response Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error . Если done == true — задано значение ровно одного из полей error или response . |
error | google.rpc.Status Описание ошибки в случае сбоя или отмены операции. |
response | google.protobuf.Any Результат операции в случае успешного завершения. Если исходный метод не возвращает никаких данных при успешном завершении, например метод Delete, поле содержит объект google.protobuf.Empty. Если исходный метод — это стандартный метод Create / Update, поле содержит целевой ресурс операции. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля response . |