Method attachDisk

Статья создана

HTTP request
Path parameters
Body parameters
Response

Attaches the disk to the instance.

HTTP request

POST https://compute.api.cloud.yandex.net/compute/v1/instances/{instanceId}:attachDisk

Path parameters

Parameter	Description
instanceId	Required. ID of the instance to attach the disk to. To get the instance ID, use a list request. The maximum string length in characters is 50.

Body parameters

{
  "attachedDiskSpec": {
    "mode": "string",
    "deviceName": "string",
    "autoDelete": true,

    // `attachedDiskSpec` includes only one of the fields `diskSpec`, `diskId`
    "diskSpec": {
      "name": "string",
      "description": "string",
      "typeId": "string",
      "size": "string",
      "blockSize": "string",
      "diskPlacementPolicy": {
        "placementGroupId": "string"
      },

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

    },
    "diskId": "string",
    // end of the list of possible fields`attachedDiskSpec`

  }
}

Field	Description
attachedDiskSpec	object Required. Disk that should be attached.
attachedDiskSpec. mode	string The mode in which to attach this disk. READ_ONLY: Read-only access. READ_WRITE: Read/Write access. Default value.
attachedDiskSpec. deviceName	string Specifies a unique serial number of your choice that is reflected into the /dev/disk/by-id/ tree of a Linux operating system running within the instance. This value can be used to reference the device for mounting, resizing, and so on, from within the instance. If not specified, a random value will be generated. Value must match the regular expression `[a-z][a-z0-9-_]{,19}`.
attachedDiskSpec. autoDelete	boolean (boolean) Specifies whether the disk will be auto-deleted when the instance is deleted.
attachedDiskSpec. diskSpec	object Disk specification. `attachedDiskSpec` includes only one of the fields `diskSpec`, `diskId`
attachedDiskSpec. diskSpec. name	string Name of the disk. Value must match the regular expression `\|[a-z]([-a-z0-9]{0,61}[a-z0-9])?`.
attachedDiskSpec. diskSpec. description	string Description of the disk. The maximum string length in characters is 256.
attachedDiskSpec. diskSpec. 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.
attachedDiskSpec. diskSpec. size	string (int64) Required. Size of the disk, specified in bytes. Acceptable values are 4194304 to 4398046511104, inclusive.
attachedDiskSpec. diskSpec. blockSize	string (int64) Block size of the disk, specified in bytes. The default is 4096.
attachedDiskSpec. diskSpec. diskPlacementPolicy	object Placement policy configuration.
attachedDiskSpec. diskSpec. diskPlacementPolicy. placementGroupId	string Placement group ID.
attachedDiskSpec. diskSpec. imageId	string `attachedDiskSpec.diskSpec` 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.
attachedDiskSpec. diskSpec. snapshotId	string `attachedDiskSpec.diskSpec` 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.
attachedDiskSpec. diskId	string `attachedDiskSpec` includes only one of the fields `diskSpec`, `diskId` ID of the disk that should be attached. 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. 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. 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 The error result of the operation in case of failure or cancellation. 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.