v1

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

Creates a new Volume in a given project and location.

post/v1/{+parent}/volumes

Path parameters

parentstring required

Required. Value for parent.

Query parameters

volumeIdstring

Required. Id of the requesting volume. Must be unique within the parent resource. Must contain only letters, numbers and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.

Request body

stateDetailsstring

Output only. State details of the volume

ldapEnabledboolean

Output only. Flag indicating if the volume is NFS LDAP enabled or not.

hotTierSizeUsedGibstring int64

Output only. Total hot tier data rounded down to the nearest GiB used by the Volume. This field is only used for flex Service Level

restrictedActionsstring[]

Optional. List of actions that are restricted on this volume.

smbSettingsstring[]

Optional. SMB share settings for the volume.

coldTierSizeGibstring int64

Output only. Size of the volume cold tier data rounded down to the nearest GiB.

psaRangestring

Output only. This field is not implemented. The values provided in this field are ignored.

state'STATE_UNSPECIFIED' | 'READY' | 'CREATING' | 'DELETING' | 'UPDATING' | 'RESTORING' | 'DISABLED' | 'ERROR' | 'PREPARING' | 'READ_ONLY'

Output only. State of the volume

snapReservenumber double

Optional. Snap_reserve specifies percentage of volume storage reserved for snapshot storage. Default is 0 percent.

labelsobject

Optional. Labels as key value pairs

namestring

Identifier. Name of the volume

networkstring

Output only. VPC Network name. Format: projects/{project}/global/networks/{network}

replicaZonestring

Output only. Specifies the replica zone for regional volume.

kerberosEnabledboolean

Optional. Flag indicating if the volume is a kerberos volume or not, export policy rules control kerberos security modes (krb5, krb5i, krb5p).

kmsConfigstring

Output only. Specifies the KMS config to be used for volume encryption.

encryptionType'ENCRYPTION_TYPE_UNSPECIFIED' | 'SERVICE_MANAGED' | 'CLOUD_KMS'

Output only. Specified the current volume encryption key source.

descriptionstring

Optional. Description of the volume

createTimestring google-datetime

Output only. Create time of the volume

capacityGibstring int64

Required. Capacity in GIB of the volume

hasReplicationboolean

Output only. Indicates whether the volume is part of a replication relationship.

multipleEndpointsboolean

Optional. Flag indicating if the volume will have an IP address per node for volumes supporting multiple IP endpoints. Only the volume with large_capacity will be allowed to have multiple endpoints.

zonestring

Output only. Specifies the active zone for regional volume.

storagePoolstring

Required. StoragePool name of the volume

serviceLevel'SERVICE_LEVEL_UNSPECIFIED' | 'PREMIUM' | 'EXTREME' | 'STANDARD' | 'FLEX'

Output only. Service level of the volume

throughputMibpsnumber double

Optional. Throughput of the volume (in MiB/s)

shareNamestring

Required. Share name of the volume

protocolsstring[]

Required. Protocols required for the volume

snapshotDirectoryboolean

Optional. Snapshot_directory if enabled (true) the volume will contain a read-only .snapshot directory which provides access to each of the volume's snapshots.

largeCapacityboolean

Optional. Flag indicating if the volume will be a large capacity volume or a regular volume. This field is used for legacy FILE pools. For Unified pools, use the large_capacity_config field instead. This field and large_capacity_config are mutually exclusive.

activeDirectorystring

Output only. Specifies the ActiveDirectory name of a SMB volume.

unixPermissionsstring

Optional. Default unix style permission (e.g. 777) the mount point will be created with. Applicable for NFS protocol types only.

usedGibstring int64

Output only. Used capacity in GIB of the volume. This is computed periodically and it does not represent the realtime usage.

securityStyle'SECURITY_STYLE_UNSPECIFIED' | 'NTFS' | 'UNIX'

Optional. Security Style of the Volume

Response

Successful response