REST Resource: projects.locations.storagePools

Resource: StoragePool

StoragePool is a container for volumes with a service level and capacity. Volumes can be created in a pool of sufficient available capacity. StoragePool capacity is what you are billed for.

JSON representation 
{
  "name": string,
  "serviceLevel": enum (ServiceLevel),
  "capacityGib": string,
  "volumeCapacityGib": string,
  "volumeCount": integer,
  "state": enum (State),
  "stateDetails": string,
  "createTime": string,
  "description": string,
  "labels": {
    string: string,
    ...
  },
  "network": string,
  "activeDirectory": string,
  "kmsConfig": string,
  "ldapEnabled": boolean,
  "psaRange": string,
  "encryptionType": enum (EncryptionType),
  "allowAutoTiering": boolean,
  "replicaZone": string,
  "zone": string,
  "satisfiesPzs": boolean,
  "satisfiesPzi": boolean,
  "customPerformanceEnabled": boolean,
  "totalThroughputMibps": string,
  "totalIops": string,
  "hotTierSizeGib": string,
  "globalAccessAllowed": boolean,
  "enableHotTierAutoResize": boolean
}
Fields
name

string

Identifier. Name of the storage pool
serviceLevel

enum (ServiceLevel)

Required. Service level of the storage pool
capacityGib

string (int64 format)

Required. Capacity in GIB of the pool
volumeCapacityGib

string (int64 format)

Output only. Allocated size of all volumes in GIB in the storage pool
volumeCount

integer

Output only. Volume count of the storage pool
state

enum (State)

Output only. State of the storage pool
stateDetails

string

Output only. State details of the storage pool
createTime

string (Timestamp format)

Output only. Create time of the storage pool

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
description

string

Optional. Description of the storage pool
labels

map (key: string, value: string)

Optional. Labels as key value pairs

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
network

string

Required. VPC Network name. Format: projects/{project}/global/networks/{network}
activeDirectory

string

Optional. Specifies the Active Directory to be used for creating a SMB volume.
kmsConfig

string

Optional. Specifies the KMS config to be used for volume encryption.
ldapEnabled

boolean

Optional. Flag indicating if the pool is NFS LDAP enabled or not.
psaRange

string

Optional. This field is not implemented. The values provided in this field are ignored.
encryptionType

enum (EncryptionType)

Output only. Specifies the current pool encryption key source.
allowAutoTiering

boolean

Optional. True if the storage pool supports Auto Tiering enabled volumes. Default is false. Auto-tiering can be enabled after storage pool creation but it can't be disabled once enabled.
replicaZone

string

Optional. Specifies the replica zone for regional storagePool.
zone

string

Optional. Specifies the active zone for regional storagePool.
satisfiesPzs

boolean

Output only. Reserved for future use
satisfiesPzi

boolean

Output only. Reserved for future use
customPerformanceEnabled

boolean

Optional. True if using Independent Scaling of capacity and performance (Hyperdisk) By default set to false
totalThroughputMibps

string (int64 format)

Optional. Custom Performance Total Throughput of the pool (in MiBps)
totalIops

string (int64 format)

Optional. Custom Performance Total IOPS of the pool if not provided, it will be calculated based on the totalThroughputMibps
hotTierSizeGib

string (int64 format)

Optional. Total hot tier capacity for the Storage Pool. It is applicable only to Flex service level. It should be less than the minimum storage pool size and cannot be more than the current storage pool size. It cannot be decreased once set.
globalAccessAllowed
(deprecated)

boolean

Deprecated. Used to allow SO pool to access AD or DNS server from other regions.
enableHotTierAutoResize

boolean

Optional. Flag indicating that the hot-tier threshold will be auto-increased by 10% of the hot-tier when it hits 100%. Default is true. The increment will kick in only if the new size after increment is still less than or equal to storage pool size.

State

The Storage Pool States

Enums
STATE_UNSPECIFIED Unspecified Storage Pool State
READY Storage Pool State is Ready
CREATING Storage Pool State is Creating
DELETING Storage Pool State is Deleting
UPDATING Storage Pool State is Updating
RESTORING Storage Pool State is Restoring
DISABLED Storage Pool State is Disabled
ERROR Storage Pool State is Error

Methods

create

 Creates a new storage pool.

delete

 Warning!

get

 Returns the description of the specified storage pool by poolId.

list

 Returns descriptions of all storage pools owned by the caller.

patch

 Updates the storage pool properties with the full spec

switch

 This operation will switch the active/replica zone for a regional storagePool.

validateDirectoryService

 ValidateDirectoryService does a connectivity check for a directory service policy attached to the storage pool.