Method create

Creates a disk in the specified folder.

You can create an empty disk or restore it from a snapshot or an image. Method starts an asynchronous operation that can be cancelled while it is in progress.

HTTP request

POST https://compute.api.cloud.yandex.net/compute/v1/disks

Body parameters

 {
  "folderId": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "typeId": "string",
  "zoneId": "string",
  "size": "string",

  // includes only one of the fields `imageId`, `snapshotId`
  "imageId": "string",
  "snapshotId": "string",
  // end of the list of possible fields

}
Field Description
folderId string

Required. ID of the folder to create a disk in. To get the folder ID use a list request.

The maximum string length in characters is 50.

name string

Name of the disk.

Value must match the regular expression |[a-z][-a-z0-9]{1,61}[a-z0-9].

description string

Description of the disk.

The maximum string length in characters is 256.

labels object

Resource labels as key:value pairs.

No more than 64 per resource. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_0-9a-z].

typeId string

ID of the disk type. To get a list of available disk types use the list request.

The maximum string length in characters is 50.

zoneId string

Required. ID of the availability zone where the disk resides. To get a list of available zones use the list request.

The maximum string length in characters is 50.

size string (int64)

Required. Size of the disk, specified in bytes. If the disk was created from a image, this value should be more than the Image.minDiskSize value.

Acceptable values are 4194304 to 4398046511104, inclusive.

imageId string
includes only one of the fields imageId, snapshotId

ID of the image to create the disk from.

The maximum string length in characters is 50.

snapshotId string
includes only one of the fields imageId, snapshotId

ID of the snapshot to restore the disk from.

The maximum string length in characters is 50.

Response

HTTP Code: 200 - OK

 {
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": true,
  "metadata": "object",

  // includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": "object",
  // end of the list of possible fields

}

An Operation resource. For more information, see Operation.

Field Description
id string

ID of the operation.

description string

Description of the operation. 0-256 characters long.

createdAt string (date-time)

Creation timestamp in RFC3339 text format.

String in RFC3339 text format.

createdBy string

ID of the user or service account who initiated the operation.

modifiedAt string (date-time)

The time when the Operation resource was last modified. This value is in RFC3339 text format.

String in RFC3339 text format.

done boolean (boolean)

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

metadata object

Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.

error object
includes only one of the fields error, response

The error result of the operation in case of failure or cancellation.

error.
code
integer (int32)

Error code. An enum value of google.rpc.Code.

error.
message
string

An error message.

error.
details[]
object

A list of messages that carry the error details.

response object
includes only one of the fields error, response

The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any.