DiskService
Набор методов для управления ресурсами Disk.
Вызов | Описание |
---|---|
Get | Возвращает указанный ресурс Disk. |
List | Возвращает список доступных ресурсов Disk в указанном каталоге. |
Create | Создает диск в указанном каталоге. |
Update | Изменяет указанный диск. |
Delete | Удаляет указанный диск. |
ListOperations | Возвращает список операций для указанного диска. |
Вызовы DiskService
Get
Возвращает указанный ресурс Disk.
Чтобы получить список доступных ресурсов Disk, используйте запрос List.
rpc Get (GetDiskRequest) returns (Disk)
GetDiskRequest
Поле | Описание |
---|---|
disk_id | string Обязательное поле. Идентификатор возвращаемого ресурса Disk. Чтобы получить идентификатор диска, используйте запрос DiskService.List. Максимальная длина строки в символах — 50. |
Disk
Поле | Описание |
---|---|
id | string Идентификатор типа диска. |
folder_id | string Идентификатор каталога, которому принадлежит диск. |
created_at | google.protobuf.Timestamp |
name | string Имя диска. Длина 1-63 символов. |
description | string Описание диска. Длина описания должна быть от 0 до 256 символов. |
labels | map<string,string> Метки ресурса в формате key:value . Максимум 64 на ресурс. |
type_id | string Идентификатор типа диска. |
zone_id | string Идентификатор зоны доступности, в которой находится хост. |
size | int64 Размер диска в байтах. |
product_ids[] | string Идентификаторы лицензий, указывающие, какие лицензии подключены к этому ресурсу. Идентификаторы лицензий используются для расчета дополнительной платы за использование виртуальной машины. Правильный идентификатор лицензии генерируется Яндекс.Облаком. Идентификаторы наследуются новыми ресурсами, созданными из этого ресурса. Если вам известны идентификаторы лицензий, укажите их при создании образа. Например, если создать образ диска с помощью сторонней утилиты и загрузить его в Yandex Object Storage, то идентификаторы лицензий будут потеряны. Вы можете указать их в запросе yandex.cloud.compute.v1.ImageService.Create. |
status | enum Status Текущий статус диска.
|
source | oneof: source_image_id или source_snapshot_id |
source_image_id | string Идентификатор образа, из которого был создан диск. |
source_snapshot_id | string Идентификатор снимка, из которого был создан диск. |
instance_ids[] | string Массив виртуальных машин, к которым подключен диск. |
List
Возвращает список доступных ресурсов Disk в указанном каталоге.
rpc List (ListDisksRequest) returns (ListDisksResponse)
ListDisksRequest
Поле | Описание |
---|---|
folder_id | string Обязательное поле. Идентификатор каталога для получения списка дисков. Чтобы получить идентификатор каталога, используйте запрос yandex.cloud.resourcemanager.v1.FolderService.List. Максимальная длина строки в символах — 50. |
page_size | int64 Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем page_size , сервис вернет значение ListDisksResponse.next_page_token, которое можно использовать для получения следующей страницы. Максимальное значение — 1000. |
page_token | string Токен страницы. Установите значение page_token равным значению поля ListDisksResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100. |
filter | string
|
ListDisksResponse
Поле | Описание |
---|---|
disks[] | Disk Список ресурсов Disk. |
next_page_token | string Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListDisksRequest.page_size, используйте next_page_token в качестве значения параметра ListDisksRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения next_page_token для перебора страниц результатов. |
Disk
Поле | Описание |
---|---|
id | string Идентификатор типа диска. |
folder_id | string Идентификатор каталога, которому принадлежит диск. |
created_at | google.protobuf.Timestamp |
name | string Имя диска. Длина 1-63 символов. |
description | string Описание диска. Длина описания должна быть от 0 до 256 символов. |
labels | map<string,string> Метки ресурса в формате key:value . Максимум 64 на ресурс. |
type_id | string Идентификатор типа диска. |
zone_id | string Идентификатор зоны доступности, в которой находится хост. |
size | int64 Размер диска в байтах. |
product_ids[] | string Идентификаторы лицензий, указывающие, какие лицензии подключены к этому ресурсу. Идентификаторы лицензий используются для расчета дополнительной платы за использование виртуальной машины. Правильный идентификатор лицензии генерируется Яндекс.Облаком. Идентификаторы наследуются новыми ресурсами, созданными из этого ресурса. Если вам известны идентификаторы лицензий, укажите их при создании образа. Например, если создать образ диска с помощью сторонней утилиты и загрузить его в Yandex Object Storage, то идентификаторы лицензий будут потеряны. Вы можете указать их в запросе yandex.cloud.compute.v1.ImageService.Create. |
status | enum Status Текущий статус диска.
|
source | oneof: source_image_id или source_snapshot_id |
source_image_id | string Идентификатор образа, из которого был создан диск. |
source_snapshot_id | string Идентификатор снимка, из которого был создан диск. |
instance_ids[] | string Массив виртуальных машин, к которым подключен диск. |
Create
Создает диск в указанном каталоге.
Вы можете создать пустой диск или восстановить его из снимка или образа. Метод запускает асинхронную операцию, которую можно отменить перед тем, как она завершится.
rpc Create (CreateDiskRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:CreateDiskMetadata
Operation.response:Disk
CreateDiskRequest
Поле | Описание |
---|---|
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]* . |
type_id | string Идентификатор типа диска. Чтобы получить список доступных типов дисков, используйте запрос yandex.cloud.compute.v1.DiskTypeService.List. Максимальная длина строки в символах — 50. |
zone_id | string Обязательное поле. Идентификатор зоны доступности, в которой находится хост. Чтобы получить список доступных зон, используйте запрос yandex.cloud.compute.v1.ZoneService.List. Максимальная длина строки в символах — 50. |
size | int64 Обязательное поле. Размер диска в байтах. Если диск был создан из образа, это значение должно быть больше, чем значение yandex.cloud.compute.v1.Image.min_disk_size . Допустимые значения — от 4194304 до 4398046511104 включительно. |
source | oneof: image_id или snapshot_id |
image_id | string Идентификатор образа для создания диска. Максимальная длина строки в символах — 50. |
snapshot_id | string Идентификатор снимка для восстановления диска. Максимальная длина строки в символах — 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<CreateDiskMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс 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<Disk> в случае успешного выполнения операции. |
CreateDiskMetadata
Поле | Описание |
---|---|
disk_id | string Идентификатор создаваемого диска. |
Disk
Поле | Описание |
---|---|
id | string Идентификатор типа диска. |
folder_id | string Идентификатор каталога, которому принадлежит диск. |
created_at | google.protobuf.Timestamp |
name | string Имя диска. Длина 1-63 символов. |
description | string Описание диска. Длина описания должна быть от 0 до 256 символов. |
labels | map<string,string> Метки ресурса в формате key:value . Максимум 64 на ресурс. |
type_id | string Идентификатор типа диска. |
zone_id | string Идентификатор зоны доступности, в которой находится хост. |
size | int64 Размер диска в байтах. |
product_ids[] | string Идентификаторы лицензий, указывающие, какие лицензии подключены к этому ресурсу. Идентификаторы лицензий используются для расчета дополнительной платы за использование виртуальной машины. Правильный идентификатор лицензии генерируется Яндекс.Облаком. Идентификаторы наследуются новыми ресурсами, созданными из этого ресурса. Если вам известны идентификаторы лицензий, укажите их при создании образа. Например, если создать образ диска с помощью сторонней утилиты и загрузить его в Yandex Object Storage, то идентификаторы лицензий будут потеряны. Вы можете указать их в запросе yandex.cloud.compute.v1.ImageService.Create. |
status | enum Status Текущий статус диска.
|
source | oneof: source_image_id или source_snapshot_id |
source_image_id | string Идентификатор образа, из которого был создан диск. |
source_snapshot_id | string Идентификатор снимка, из которого был создан диск. |
instance_ids[] | string Массив виртуальных машин, к которым подключен диск. |
Update
Изменяет указанный диск.
rpc Update (UpdateDiskRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:UpdateDiskMetadata
Operation.response:Disk
UpdateDiskRequest
Поле | Описание |
---|---|
disk_id | string Обязательное поле. Идентификатор изменяемого ресурса Disk. Чтобы получить идентификатор диска, используйте запрос DiskService.List. Максимальная длина строки в символах — 50. |
update_mask | google.protobuf.FieldMask Маска, определяющая, какие поля ресурса Disk будут обновлены. |
name | string Имя диска. Значение должно соответствовать регулярному выражению |[a-z][-a-z0-9]{1,61}[a-z0-9] . |
description | string Описание диска. Максимальная длина строки в символах — 256. |
labels | map<string,string> Метки ресурса в формате ключ:значение . Существующий набор labels полностью перезаписывается набором, переданным в запросе. Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]* . Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
size | int64 Размер диска в байтах. Допустимые значения — от 4194304 до 4398046511104 включительно. |
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<UpdateDiskMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс 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<Disk> в случае успешного выполнения операции. |
UpdateDiskMetadata
Поле | Описание |
---|---|
disk_id | string Идентификатор изменяемого ресурса Disk. |
Disk
Поле | Описание |
---|---|
id | string Идентификатор типа диска. |
folder_id | string Идентификатор каталога, которому принадлежит диск. |
created_at | google.protobuf.Timestamp |
name | string Имя диска. Длина 1-63 символов. |
description | string Описание диска. Длина описания должна быть от 0 до 256 символов. |
labels | map<string,string> Метки ресурса в формате key:value . Максимум 64 на ресурс. |
type_id | string Идентификатор типа диска. |
zone_id | string Идентификатор зоны доступности, в которой находится хост. |
size | int64 Размер диска в байтах. |
product_ids[] | string Идентификаторы лицензий, указывающие, какие лицензии подключены к этому ресурсу. Идентификаторы лицензий используются для расчета дополнительной платы за использование виртуальной машины. Правильный идентификатор лицензии генерируется Яндекс.Облаком. Идентификаторы наследуются новыми ресурсами, созданными из этого ресурса. Если вам известны идентификаторы лицензий, укажите их при создании образа. Например, если создать образ диска с помощью сторонней утилиты и загрузить его в Yandex Object Storage, то идентификаторы лицензий будут потеряны. Вы можете указать их в запросе yandex.cloud.compute.v1.ImageService.Create. |
status | enum Status Текущий статус диска.
|
source | oneof: source_image_id или source_snapshot_id |
source_image_id | string Идентификатор образа, из которого был создан диск. |
source_snapshot_id | string Идентификатор снимка, из которого был создан диск. |
instance_ids[] | string Массив виртуальных машин, к которым подключен диск. |
Delete
Удаляет указанный диск.
Удаление снимка — необратимая операция, восстановить удаленный снимок невозможно. Однако при удалении диска не удаляются снимки или образы, ранее созданные из этого диска. Снимки и образы необходимо удалять отдельно.
Невозможно удалить диск, подключенный к виртуальной машине.
rpc Delete (DeleteDiskRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:DeleteDiskMetadata
Operation.response:google.protobuf.Empty
DeleteDiskRequest
Поле | Описание |
---|---|
disk_id | string Обязательное поле. Идентификатор удаляемого диска. Чтобы получить идентификатор диска, используйте запрос DiskService.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<DeleteDiskMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс 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> в случае успешного выполнения операции. |
DeleteDiskMetadata
Поле | Описание |
---|---|
disk_id | string Идентификатор удаляемого диска. |
ListOperations
Возвращает список операций для указанного диска.
rpc ListOperations (ListDiskOperationsRequest) returns (ListDiskOperationsResponse)
ListDiskOperationsRequest
Поле | Описание |
---|---|
disk_id | string Обязательное поле. Идентификатор ресурса Disk, для которого запрашивается список операций. Максимальная длина строки в символах — 50. |
page_size | int64 Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем page_size , сервис вернет значение ListDiskOperationsResponse.next_page_token, которое можно использовать для получения следующей страницы. Максимальное значение — 1000. |
page_token | string Токен страницы. Установите значение page_token равным значению поля ListDiskOperationsResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100. |
ListDiskOperationsResponse
Поле | Описание |
---|---|
operations[] | operation.Operation Список операций для указанного диска. |
next_page_token | string Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListDiskOperationsRequest.page_size, используйте next_page_token в качестве значения параметра ListDiskOperationsRequest.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 . |