Instances: attachDisk

Requires authorization

Attaches a Disk resource to an instance.

Request

HTTP request

POST https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance/attachDisk

Parameters

Parameter name Value Description
Path parameters
instance string The instance name for this request.
project string Project ID for this request.
zone string The name of the zone for this request.

Authorization

This request requires authorization with at least one of the following scopes (read more about authentication and authorization).

Scope
https://www.googleapis.com/auth/compute
https://www.googleapis.com/auth/cloud-platform

Request body

In the request body, supply data with the following structure:

{
  "kind": "compute#attachedDisk",
  "type": string,
  "mode": string,
  "source": string,
  "deviceName": string,
  "index": integer,
  "boot": boolean,
  "initializeParams": {
    "diskName": string,
    "sourceImage": string,
    "diskSizeGb": long,
    "diskType": string,
    "sourceImageEncryptionKey": {
      "rawKey": string,
      "sha256": string
    }
  },
  "autoDelete": boolean,
  "licenses": [
    string
  ],
  "interface": string,
  "diskEncryptionKey": {
    "rawKey": string,
    "sha256": string
  }
}
Property name Value Description Notes
kind string [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
index integer Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
type string Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
mode string The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
source string Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or disks.source is required.

If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.

Note that for InstanceTemplate, specify the disk name, not the URL for the disk.
deviceName string Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.

If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
boot boolean Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
initializeParams nested object [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.

This property is mutually exclusive with the source property; you can only define one or the other, but not both.
initializeParams.diskName string Specifies the disk name. If not specified, the default is to use the name of the instance.
initializeParams.sourceImage string The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or disks.source is required.

To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:

projects/debian-cloud/global/images/family/debian-8

Alternatively, use a specific version of a public operating system image:

projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD

To create a disk with a private image that you created, specify the image name in the following format:

global/images/my-private-image

You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:

global/images/family/my-private-family

If the source image is deleted later, this field will not be set.
initializeParams.diskSizeGb long Specifies the size of the disk in base-2 GB.
initializeParams.diskType string Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:

https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard

Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
  • https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
  • projects/project/zones/zone/diskTypes/diskType
  • zones/zone/diskTypes/diskType
Note that for InstanceTemplate, this is the name of the disk type, not URL.
autoDelete boolean Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
licenses[] list [Output Only] Any valid publicly visible licenses.
interface string Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
initializeParams.sourceImageEncryptionKey nested object The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
initializeParams.sourceImageEncryptionKey.rawKey string Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
initializeParams.sourceImageEncryptionKey.sha256 string [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
diskEncryptionKey nested object Encrypts or decrypts a disk using a customer-supplied encryption key.

If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.

If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.

If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.

Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
diskEncryptionKey.rawKey string Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
diskEncryptionKey.sha256 string [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

Response

If successful, this method returns a ZoneOperations resource in the response body.

{
  "kind": "compute#operation",
  "id": unsigned long,
  "creationTimestamp": string,
  "name": string,
  "zone": string,
  "clientOperationId": string,
  "operationType": string,
  "targetLink": string,
  "targetId": unsigned long,
  "status": string,
  "statusMessage": string,
  "user": string,
  "progress": integer,
  "insertTime": string,
  "startTime": string,
  "endTime": string,
  "error": {
    "errors": [
      {
        "code": string,
        "location": string,
        "message": string
      }
    ]
  },
  "warnings": [
    {
      "code": string,
      "message": string,
      "data": [
        {
          "key": string,
          "value": string
        }
      ]
    }
  ],
  "httpErrorStatusCode": integer,
  "httpErrorMessage": string,
  "selfLink": string,
  "region": string,
  "description": string
}
Property name Value Description Notes
kind string [Output Only] Type of the resource. Always compute#operation for Operation resources.
id unsigned long [Output Only] The unique identifier for the resource. This identifier is defined by the server.
creationTimestamp string [Deprecated] This field is deprecated.
name string [Output Only] Name of the resource.
zone string [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
clientOperationId string [Output Only] Reserved for future use.
operationType string [Output Only] The type of operation, such as insert, update, or delete, and so on.
targetId unsigned long [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
status string [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
statusMessage string [Output Only] An optional textual description of the current status of the operation.
user string [Output Only] User who requested the operation, for example: user@example.com.
progress integer [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
insertTime string [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
startTime string [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
endTime string [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
error object [Output Only] If errors are generated during processing of the operation, this field will be populated.
error.errors[] list [Output Only] The array of errors encountered while processing this operation.
error.errors[].code string [Output Only] The error type identifier for this error.
error.errors[].location string [Output Only] Indicates the field in the request that caused the error. This property is optional.
error.errors[].message string [Output Only] An optional, human-readable error message.
warnings[] list [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
warnings[].code string [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
warnings[].message string [Output Only] A human-readable description of the warning code.
warnings[].data[] list [Output Only] Metadata about this warning in key: value format. For example:
"data": [ { "key": "scope", "value": "zones/us-east1-d" }
warnings[].data[].key string [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
warnings[].data[].value string [Output Only] A warning data value corresponding to the key.
httpErrorStatusCode integer [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
httpErrorMessage string [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
region string [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
description string [Output Only] A textual description of the operation, which is set when the operation is created.

Send feedback about...

Compute Engine