REST Resource: projects.locations.volumes

Stay organized with collections Save and categorize content based on your preferences.

Resource: Volume

A storage volume.

JSON representation 
{
  "name": string,
  "id": string,
  "storageType": enum (StorageType),
  "state": enum (State),
  "requestedSizeGib": string,
  "originallyRequestedSizeGib": string,
  "currentSizeGib": string,
  "emergencySizeGib": string,
  "maxSizeGib": string,
  "autoGrownSizeGib": string,
  "remainingSpaceGib": string,
  "snapshotReservationDetail": {
    object (SnapshotReservationDetail)
  },
  "snapshotAutoDeleteBehavior": enum (SnapshotAutoDeleteBehavior),
  "snapshotSchedulePolicy": string,
  "labels": {
    string: string,
    ...
  },
  "snapshotEnabled": boolean,
  "pod": string,
  "protocol": enum (Protocol),
  "bootVolume": boolean,
  "performanceTier": enum (VolumePerformanceTier),
  "notes": string,
  "workloadProfile": enum (WorkloadProfile),
  "storageAggregatePool": string,
  "expireTime": string
}
Fields
name

string

Output only. The resource name of this Volume. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: projects/{project}/locations/{location}/volumes/{volume}
id

string

An identifier for the Volume, generated by the backend.
storageType

enum (StorageType)

The storage type for this volume.
state

enum (State)

The state of this storage volume.
requestedSizeGib

string (int64 format)

The requested size of this storage volume, in GiB.
originallyRequestedSizeGib

string (int64 format)

Originally requested size, in GiB.
currentSizeGib

string (int64 format)

The current size of this storage volume, in GiB, including space reserved for snapshots. This size might be different than the requested size if the storage volume has been configured with auto grow or auto shrink.
emergencySizeGib

string (int64 format)

Additional emergency size that was requested for this Volume, in GiB. currentSizeGib includes this value.
maxSizeGib

string (int64 format)

Maximum size volume can be expanded to in case of evergency, in GiB.
autoGrownSizeGib

string (int64 format)

The size, in GiB, that this storage volume has expanded as a result of an auto grow policy. In the absence of auto-grow, the value is 0.
remainingSpaceGib

string (int64 format)

The space remaining in the storage volume for new LUNs, in GiB, excluding space reserved for snapshots.
snapshotReservationDetail

object (SnapshotReservationDetail)

Details about snapshot space reservation and usage on the storage volume.
snapshotAutoDeleteBehavior

enum (SnapshotAutoDeleteBehavior)

The behavior to use when snapshot reserved space is full.
snapshotSchedulePolicy

string

The name of the snapshot schedule policy in use for this volume, if any.
labels

map (key: string, value: string)

Labels as key value pairs.
snapshotEnabled

boolean

Whether snapshots are enabled.
pod

string

Immutable. Pod name.
protocol

enum (Protocol)

Output only. Storage protocol for the Volume.
bootVolume

boolean

Output only. Whether this volume is a boot volume. A boot volume is one which contains a boot LUN.
performanceTier

enum (VolumePerformanceTier)

Immutable. Performance tier of the Volume. Default is SHARED.
notes

string

Input only. User-specified notes for new Volume. Used to provision Volumes that require manual intervention.
workloadProfile

enum (WorkloadProfile)

The workload profile for the volume.
storageAggregatePool

string

Input only. Name of the storage aggregate pool to allocate the volume in. Can be used only for VOLUME_PERFORMANCE_TIER_ASSIGNED volumes.
expireTime

string (Timestamp format)

Output only. Time after which volume will be fully deleted. It is filled only for volumes in COOLOFF state.

StorageType

The storage type for a volume.

Enums
STORAGE_TYPE_UNSPECIFIED The storage type for this volume is unknown.
SSD The storage type for this volume is SSD.
HDD This storage type for this volume is HDD.

State

The possible states for a storage volume.

Enums
STATE_UNSPECIFIED The storage volume is in an unknown state.
CREATING The storage volume is being created.
READY The storage volume is ready for use.
DELETING The storage volume has been requested to be deleted.
UPDATING The storage volume is being updated.
COOL_OFF The storage volume is in cool off state. It will be deleted after expireTime.

SnapshotReservationDetail

Details about snapshot space reservation and usage on the storage volume.

JSON representation 
{
  "reservedSpaceGib": string,
  "reservedSpaceUsedPercent": integer,
  "reservedSpaceRemainingGib": string,
  "reservedSpacePercent": integer
}
Fields
reservedSpaceGib

string (int64 format)

The space on this storage volume reserved for snapshots, shown in GiB.
reservedSpaceUsedPercent

integer

The percent of snapshot space on this storage volume actually being used by the snapshot copies. This value might be higher than 100% if the snapshot copies have overflowed into the data portion of the storage volume.
reservedSpaceRemainingGib

string (int64 format)

The amount, in GiB, of available space in this storage volume's reserved snapshot space.
reservedSpacePercent

integer

Percent of the total Volume size reserved for snapshot copies. Enabling snapshots requires reserving 20% or more of the storage volume space for snapshots. Maximum reserved space for snapshots is 40%. Setting this field will effectively set snapshotEnabled to true.

SnapshotAutoDeleteBehavior

The kinds of auto delete behavior to use when snapshot reserved space is full.

Enums
SNAPSHOT_AUTO_DELETE_BEHAVIOR_UNSPECIFIED The unspecified behavior.
DISABLED Don't delete any snapshots. This disables new snapshot creation, as long as the snapshot reserved space is full.
OLDEST_FIRST Delete the oldest snapshots first.
NEWEST_FIRST Delete the newest snapshots first.

Protocol

Storage protocol.

Enums
PROTOCOL_UNSPECIFIED Value is not specified.
FIBRE_CHANNEL Fibre Channel protocol.
NFS NFS protocol means Volume is a NFS Share volume. Such volumes cannot be manipulated via Volumes API.

VolumePerformanceTier

Performance tier of the Volume.

Enums
VOLUME_PERFORMANCE_TIER_UNSPECIFIED Value is not specified.
VOLUME_PERFORMANCE_TIER_SHARED Regular volumes, shared aggregates.
VOLUME_PERFORMANCE_TIER_ASSIGNED Assigned aggregates.
VOLUME_PERFORMANCE_TIER_HT High throughput aggregates.

WorkloadProfile

The possible values for a workload profile.

Enums
WORKLOAD_PROFILE_UNSPECIFIED The workload profile is in an unknown state.
GENERIC The workload profile is generic.
HANA The workload profile is hana.

Methods

evict

 Skips volume's cooloff and deletes it now.

get

 Get details of a single storage volume.

list

 List storage volumes in a given project and location.

patch

 Update details of a single storage volume.