Skip to main content

volumes

Creates, updates, deletes, gets or lists a volumes resource.

Overview​

Namevolumes
TypeResource
Idgoogle.baremetalsolution.volumes

Fields​

The following fields are returned by SELECT queries:

Successful response

NameDatatypeDescription
idstringAn identifier for the Volume, generated by the backend.
namestringOutput 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}
attachedbooleanOutput 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.
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.
bootVolumebooleanOutput only. Whether this volume is a boot volume. A boot volume is one which contains a boot LUN.
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.
emergencySizeGibstring (int64)Additional emergency size that was requested for this Volume, in GiB. current_size_gib includes this value.
expireTimestring (google-datetime)Output only. Time after which volume will be fully deleted. It is filled only for volumes in COOLOFF state.
instancesarrayOutput only. Instances this Volume is attached to. This field is set only in Get requests.
labelsobjectLabels as key value pairs.
maxSizeGibstring (int64)Maximum size volume can be expanded to in case of evergency, in GiB.
notesstringInput only. User-specified notes for new Volume. Used to provision Volumes that require manual intervention.
originallyRequestedSizeGibstring (int64)Originally requested size, in GiB.
performanceTierstringImmutable. Performance tier of the Volume. Default is SHARED.
podstringImmutable. Pod name. Pod is an independent part of infrastructure. Volume can only be connected to the instances allocated in the same pod.
protocolstringOutput only. Storage protocol for the Volume.
remainingSpaceGibstring (int64)The space remaining in the storage volume for new LUNs, in GiB, excluding space reserved for snapshots.
requestedSizeGibstring (int64)The requested size of this storage volume, in GiB.
snapshotAutoDeleteBehaviorstringThe behavior to use when snapshot reserved space is full.
snapshotEnabledbooleanWhether snapshots are enabled.
snapshotReservationDetailobjectDetails about snapshot space reservation and usage on the storage volume. (id: SnapshotReservationDetail)
statestringThe state of this storage volume.
storageTypestringThe storage type for this volume.
workloadProfilestringThe workload profile for the volume.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectprojectsId, locationsId, volumesIdGet details of a single storage volume.
listselectprojectsId, locationsIdpageSize, pageToken, filterList storage volumes in a given project and location.
patchupdateprojectsId, locationsId, volumesIdupdateMaskUpdate details of a single storage volume.
renameexecprojectsId, locationsId, volumesIdRenameVolume sets a new name for a volume. Use with caution, previous names become immediately invalidated.
evictexecprojectsId, locationsId, volumesIdSkips volume's cooloff and deletes it now. Volume must be in cooloff state.
resizeexecprojectsId, locationsId, volumesIdEmergency Volume resize.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
locationsIdstring
projectsIdstring
volumesIdstring
filterstring
pageSizeinteger (int32)
pageTokenstring
updateMaskstring (google-fieldmask)

SELECT examples​

Get details of a single storage volume.

SELECT
id,
name,
attached,
autoGrownSizeGib,
bootVolume,
currentSizeGib,
emergencySizeGib,
expireTime,
instances,
labels,
maxSizeGib,
notes,
originallyRequestedSizeGib,
performanceTier,
pod,
protocol,
remainingSpaceGib,
requestedSizeGib,
snapshotAutoDeleteBehavior,
snapshotEnabled,
snapshotReservationDetail,
state,
storageType,
workloadProfile
FROM google.baremetalsolution.volumes
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND volumesId = '{{ volumesId }}' -- required;

UPDATE examples​

Update details of a single storage volume.

UPDATE google.baremetalsolution.volumes
SET 
data__id = '{{ id }}',
data__storageType = '{{ storageType }}',
data__state = '{{ state }}',
data__requestedSizeGib = '{{ requestedSizeGib }}',
data__originallyRequestedSizeGib = '{{ originallyRequestedSizeGib }}',
data__currentSizeGib = '{{ currentSizeGib }}',
data__emergencySizeGib = '{{ emergencySizeGib }}',
data__maxSizeGib = '{{ maxSizeGib }}',
data__autoGrownSizeGib = '{{ autoGrownSizeGib }}',
data__remainingSpaceGib = '{{ remainingSpaceGib }}',
data__snapshotReservationDetail = '{{ snapshotReservationDetail }}',
data__snapshotAutoDeleteBehavior = '{{ snapshotAutoDeleteBehavior }}',
data__labels = '{{ labels }}',
data__snapshotEnabled = {{ snapshotEnabled }},
data__pod = '{{ pod }}',
data__performanceTier = '{{ performanceTier }}',
data__notes = '{{ notes }}',
data__workloadProfile = '{{ workloadProfile }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND volumesId = '{{ volumesId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

Lifecycle Methods​

RenameVolume sets a new name for a volume. Use with caution, previous names become immediately invalidated.

EXEC google.baremetalsolution.volumes.rename 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@volumesId='{{ volumesId }}' --required 
@@json=
'{
"newVolumeId": "{{ newVolumeId }}"
}';