Метод attachDisk
Присоединяет диск к виртуальной машине.
HTTP-запрос
POST https://compute.api.cloud.yandex.net/compute/v1/instances/{instanceId}:attachDisk
Path-параметры
Параметр | Описание |
---|---|
instanceId | Обязательное поле. Идентификатор виртуальной машины для подключения диска. Чтобы получить идентификатор виртуальной машины, используйте запрос list. Максимальная длина строки в символах — 50. |
Параметры в теле запроса
{
"attachedDiskSpec": {
"mode": "string",
"deviceName": "string",
"autoDelete": true,
// `attachedDiskSpec` включает только одно из полей `diskSpec`, `diskId`
"diskSpec": {
"name": "string",
"description": "string",
"typeId": "string",
"size": "string",
// `attachedDiskSpec.diskSpec` включает только одно из полей `imageId`, `snapshotId`
"imageId": "string",
"snapshotId": "string",
// конец списка возможных полей`attachedDiskSpec.diskSpec`
},
"diskId": "string",
// конец списка возможных полей`attachedDiskSpec`
}
}
Поле | Описание |
---|---|
attachedDiskSpec | object Обязательное поле. Диск для подключения. |
attachedDiskSpec. mode |
string Режим, в котором необходимо подключить этот диск.
|
attachedDiskSpec. deviceName |
string Задает уникальный серийный номер, который на виртуальной машине с операционной системой Linux отображается в директории /dev/disk/by-id/. Это значение может использоваться для ссылки на устройство внутри виртуальной машины при монтировании, изменении размера и т. д. Если значение не указано, будет сгенерировано случайное значение. Значение должно соответствовать регулярному выражению |
attachedDiskSpec. autoDelete |
boolean (boolean) Указывает, должен ли диск автоматически удалиться при удалении виртуальной машины. |
attachedDiskSpec. diskSpec |
object Спецификация диска. attachedDiskSpec включает только одно из полей diskSpec , diskId |
attachedDiskSpec. diskSpec. name |
string Имя диска. Значение должно соответствовать регулярному выражению |
attachedDiskSpec. diskSpec. description |
string Описание диска. Максимальная длина строки в символах — 256. |
attachedDiskSpec. diskSpec. typeId |
string Идентификатор типа диска. Чтобы получить список доступных типов дисков, используйте запрос list. Максимальная длина строки в символах — 50. |
attachedDiskSpec. diskSpec. size |
string (int64) Обязательное поле. Размер диска в байтах. Допустимые значения — от 4194304 до 4398046511104 включительно. |
attachedDiskSpec. diskSpec. imageId |
string attachedDiskSpec.diskSpec включает только одно из полей imageId , snapshotId Идентификатор образа для создания диска. Максимальная длина строки в символах — 50. |
attachedDiskSpec. diskSpec. snapshotId |
string attachedDiskSpec.diskSpec включает только одно из полей imageId , snapshotId Идентификатор снимка для восстановления диска. Максимальная длина строки в символах — 50. |
attachedDiskSpec. diskId |
string attachedDiskSpec включает только одно из полей diskSpec , diskId Идентификатор диска, который должен быть подключен. Максимальная длина строки в символах — 50. |
Ответ
HTTP Code: 200 - OK
{
"id": "string",
"description": "string",
"createdAt": "string",
"createdBy": "string",
"modifiedAt": "string",
"done": true,
"metadata": "object",
// включает только одно из полей `error`, `response`
"error": {
"code": "integer",
"message": "string",
"details": [
"object"
]
},
"response": "object",
// конец списка возможных полей
}
Ресурс Operation. Дополнительные сведения см. в разделе
Объект Operation.
Поле | Описание |
---|---|
id | string Идентификатор операции. |
description | string Описание операции. Длина описания должна быть от 0 до 256 символов. |
createdAt | string (date-time) Время создания ресурса в формате в RFC3339. Строка в формате RFC3339. |
createdBy | string Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию. |
modifiedAt | string (date-time) Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339. Строка в формате RFC3339. |
done | boolean (boolean) Если значение равно |
metadata | object Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля |
error | object Описание ошибки в случае сбоя или отмены операции. включает только одно из полей error , response Описание ошибки в случае сбоя или отмены операции. |
error. code |
integer (int32) Код ошибки. Значение из списка google.rpc.Code. |
error. message |
string Текст ошибки. |
error. details[] |
object Список сообщений с подробными сведениями об ошибке. |
response | object включает только одно из полей error , response Результат операции в случае успешного завершения. Если исходный метод не возвращает никаких данных при успешном завершении, например метод Delete, поле содержит объект google.protobuf.Empty. Если исходный метод — это стандартный метод Create / Update, поле содержит целевой ресурс операции. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля |