Select the tab for how you plan to use the samples on this page:
When you use the Google Cloud console to access Google Cloud services and APIs, you don't need to set up authentication.
After installing the Google Cloud CLI, initialize it by running the following command:
gcloudinit
If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.
To use the Go samples on this page in a local development environment, install and initialize the gcloud CLI, and then set up Application Default Credentials with your user credentials.
If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.
To initialize the gcloud CLI, run the following command:
gcloudinit
If you're using a local shell, then create local authentication credentials for your user account:
gcloudauthapplication-defaultlogin
You don't need to do this if you're using Cloud Shell.
If an authentication error is returned, and you are using an external identity provider (IdP), confirm that you have signed in to the gcloud CLI with your federated identity.
For more information, see Set up authentication for a local development environment.
To use the Java samples on this page in a local development environment, install and initialize the gcloud CLI, and then set up Application Default Credentials with your user credentials.
If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.
To initialize the gcloud CLI, run the following command:
gcloudinit
If you're using a local shell, then create local authentication credentials for your user account:
gcloudauthapplication-defaultlogin
You don't need to do this if you're using Cloud Shell.
If an authentication error is returned, and you are using an external identity provider (IdP), confirm that you have signed in to the gcloud CLI with your federated identity.
For more information, see Set up authentication for a local development environment.
To use the Node.js samples on this page in a local development environment, install and initialize the gcloud CLI, and then set up Application Default Credentials with your user credentials.
If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.
To initialize the gcloud CLI, run the following command:
gcloudinit
If you're using a local shell, then create local authentication credentials for your user account:
gcloudauthapplication-defaultlogin
You don't need to do this if you're using Cloud Shell.
If an authentication error is returned, and you are using an external identity provider (IdP), confirm that you have signed in to the gcloud CLI with your federated identity.
For more information, see Set up authentication for a local development environment.
To use the REST API samples on this page in a local development environment, you use the credentials you provide to the gcloud CLI.
After installing the Google Cloud CLI, initialize it by running the following command:
gcloudinit
If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.
For more information, see Authenticate for using REST in the Google Cloud authentication documentation.
To get the permissions that you need to add a Hyperdisk volume to your instance, ask your administrator to grant you the following IAM roles on the project:
roles/compute.instanceAdmin.v1
)roles/iam.serviceAccountUser
) For more information about granting roles, see Manage access to projects, folders, and organizations.
These predefined roles contain the permissions required to add a Hyperdisk volume to your instance. To see the exact permissions that are required, expand the Required permissions section:
The following permissions are required to add a Hyperdisk volume to your instance:
compute.disks.create
on the project compute.instances.attachDisk
on the instance compute.disks.use
on the volume that you want to attach to the instance compute.instances.setMetadata
on the instance You might also be able to get these permissions with custom roles or other predefined roles.
The values you use when creating or modifying a Hyperdisk volume must fall within the range of maximum and minimum values described in Hyperdisk limits per disk.
If you're modifying the size of a Hyperdisk volume that's attached to a VM, then the new values can't exceed the Hyperdisk limits per VM.
The provisioned IOPS and throughput for a Hyperdisk volume must follow the rules outlined in About IOPS and throughput provisioning for Hyperdisk.
The following table lists the reference values of each Hyperdisk type. When creating a Hyperdisk volume with the Google Cloud CLI, REST, or the Cloud Client Libraries for Compute Engine indicate the Hyperdisk type to create by providing its corresponding value from the table.
Disk type | Reference name |
---|---|
Hyperdisk Balanced | hyperdisk-balanced |
Hyperdisk Balanced High Availability | hyperdisk-balanced-high-availability |
Hyperdisk Extreme | hyperdisk-extreme |
Hyperdisk Throughput | hyperdisk-throughput |
Hyperdisk ML | hyperdisk-ml |
You can create and attach a Hyperdisk volume by using the Google Cloud console, Google Cloud CLI, or REST.
The size, throughput, and IOPS that you specify when creating a Hyperdisk volume must be in the range of supported values.
When you create a Hyperdisk Balanced volume, you can optionally allow multiple instances to access the disk concurrently by creating the disk in multi-writer mode.
Go to the VM instances page.
Click the name of the instance where you want to add a disk.
On the VM instance details page, click Edit.
Under the heading Additional disks, click Add new disk.
Specify a name for the disk, and optionally add a description. Select Blank disk as the Disk source type.
Under Disk settings, choose a disk type from the following list. The values that you specify must be in the range of supported values.
Optional: For Hyperdisk Balanced volumes, you can enable attaching the disk to multiple instances by creating the disk in multi-writer mode. Under Access mode, select Multiple VMs read write.
Click Save.
To apply your changes to the instance, click Save.
Use the gcloud compute disks create
command to create the Hyperdisk volume.
gcloud compute disks create DISK_NAME \ --zone=ZONE \ --size=DISK_SIZE \ --type=DISK_TYPE \ --provisioned-iops=IOPS_LIMIT --provisioned-throughput=THROUGHPUT_LIMIT --access-mode=DISK_ACCESS_MODE
Replace the following:
DISK_NAME
: the name of the new disk.ZONE
: the name of zone where the new disk is being created. DISK_SIZE
: Optional: The size of the new disk. The value must be a whole number followed by a size unit of GB for gibibyte, or TB for tebibyte. If no size unit is specified, 100 GB is used as the default value. The accepted values for the disk size are: DISK_TYPE
: the type of disk. Use one of the following values: hyperdisk-balanced
, hyperdisk-extreme
, hyperdisk-ml
, or hyperdisk-throughput
IOPS_LIMIT
: Optional: For Hyperdisk Balanced or Hyperdisk Extreme disks, this is the number of I/O operations per second (IOPS) that the disk can handle.THROUGHPUT_LIMIT
: Optional: For Hyperdisk Balanced, Hyperdisk ML, or Hyperdisk Throughput volumes, this is an integer that represents the maximum throughput, measured in MiB per second, that the disk can provide.DISK_ACCESS_MODE
: Optional: How compute instances can access the data on the disk. Supported values are:
READ_WRITE_SINGLE
, for read-write access from one instance. This is the default.READ_WRITE_MANY
, (Hyperdisk Balanced and Hyperdisk Balanced High Availability only) for concurrent read-write access from multiple instances.READ_ONLY_MANY
, (Hyperdisk ML only) for concurrent read-only access from multiple instances.To set the access mode for Hyperdisk Balanced High Availability disks, see Create a regional disk.
Optional: Use the gcloud compute disks describe DISK_NAME
command to see a description of your disk.
After you create the disk, you can attach the disk to an instance.
Construct a POST
request to create a zonal Hyperdisk by using the disks.insert
method. Include the name
, sizeGb
, type
, provisionedIops
, and provisionedThroughput
properties. To create this disk as an empty and unformatted non-boot disk, don't specify a source image or a source snapshot.
POST https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/zones/ZONE/disks { "name": "DISK_NAME", "sizeGb": "DISK_SIZE", "type": "https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/zones/ZONE/diskTypes/DISK_TYPE", "provisionedIops": "IOPS_LIMIT", "provisionedThroughput": "THROUGHPUT_LIMIT", "accessMode": "DISK_ACCESS_MODE" }
Replace the following:
PROJECT_ID
: your project IDZONE
: the zone where your instance and new disk are locatedDISK_NAME
: the name of the new diskDISK_SIZE
: Optional: The size of the new disk. The value must be a whole number followed by a size unit of GB for gibibytes or TB for tebibytes.DISK_TYPE
: the type of disk. To create a Hyperdisk volume, use one of the following values: hyperdisk-balanced
, hyperdisk-extreme
, hyperdisk-ml
, or hyperdisk-throughput
.IOPS_LIMIT
: Optional: For Hyperdisk Balanced and Hyperdisk Extreme, this is the number of I/O operations per second that the disk can handle.THROUGHPUT_LIMIT
: Optional: For Hyperdisk Balanced, Hyperdisk ML, or Hyperdisk Throughput volumes, this is an integer that represents the maximum throughput, measured in MiB per second, that the disk can provide.DISK_ACCESS_MODE
: Optional: How compute instances can access the data on the disk. Supported values are:
READ_WRITE_SINGLE
, for read-write access from one instance. This is the default.READ_WRITE_MANY
, (Hyperdisk Balanced and Hyperdisk Balanced High Availability only) for concurrent read-write access from multiple instances.READ_ONLY_MANY
, (Hyperdisk ML only) for concurrent read-only access from multiple instances.To set the access mode for Hyperdisk Balanced High Availability disks, see Create a regional disk.
Optional: Use the compute.disks.get
method to see a description of your disk.
After you create the disk, you can attach the disk to any running or stopped instance.
After you create the disk, you can attach the disk to any running or stopped instance.
After you create and attach the new disk to an instance, you must format and mount the disk, so that the operating system can use the available storage space.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-04-22 UTC.