Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13337193.3 KB
projects

Update details of a single storage volume.

patch/v2/{+name}

Path parameters

namestring required

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}

Query parameters

updateMaskstring

The list of fields to update. The only currently supported fields are: 'labels'

updateMaskstring

Required. The list of fields to update.

Request body

storageType'STORAGE_TYPE_UNSPECIFIED' | 'SSD' | 'HDD'

The storage type for this volume.

bootVolumeboolean

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

state'STATE_UNSPECIFIED' | 'CREATING' | 'READY' | 'DELETING' | 'UPDATING' | 'COOL_OFF'

The state of this storage volume.

notesstring

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

namestring

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}

labelsobject

Labels as key value pairs.

requestedSizeGibstring int64

The requested size of this storage volume, in GiB.

maxSizeGibstring int64

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

workloadProfile'WORKLOAD_PROFILE_UNSPECIFIED' | 'GENERIC' | 'HANA'

The workload profile for the volume.

snapshotEnabledboolean

Whether snapshots are enabled.

emergencySizeGibstring int64

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

protocol'PROTOCOL_UNSPECIFIED' | 'FIBRE_CHANNEL' | 'NFS'

Output only. Storage protocol for the Volume.

snapshotAutoDeleteBehavior'SNAPSHOT_AUTO_DELETE_BEHAVIOR_UNSPECIFIED' | 'DISABLED' | 'OLDEST_FIRST' | 'NEWEST_FIRST'

The behavior to use when snapshot reserved space is full.

attachedboolean

Output only. Is the Volume attached at at least one instance. This field is a lightweight counterpart of instances field. It is filled in List responses as well.

performanceTier'VOLUME_PERFORMANCE_TIER_UNSPECIFIED' | 'VOLUME_PERFORMANCE_TIER_SHARED' | 'VOLUME_PERFORMANCE_TIER_ASSIGNED' | 'VOLUME_PERFORMANCE_TIER_HT' | 'VOLUME_PERFORMANCE_TIER_QOS2_PERFORMANCE'

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

originallyRequestedSizeGibstring int64

Originally requested size, in GiB.

remainingSpaceGibstring int64

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

podstring

Immutable. Pod name. Pod is an independent part of infrastructure. Volume can only be connected to the instances allocated in the same pod.

instancesstring[]

Output only. Instances this Volume is attached to. This field is set only in Get requests.

idstring

An identifier for the Volume, generated by the backend.

autoGrownSizeGibstring int64

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.

currentSizeGibstring int64

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.

expireTimestring google-datetime

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

Response

Successful response