REST Resource: storagePools

Resource: StoragePool

Represents a zonal storage pool resource.

JSON representation 
{
  "kind": string,
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "poolProvisionedCapacityGb": string,
  "poolProvisionedIops": string,
  "poolProvisionedThroughput": string,
  "zone": string,
  "state": enum (State),
  "selfLink": string,
  "selfLinkWithId": string,
  "labels": {
    string: string,
    ...
  },
  "labelFingerprint": string,
  "resourceStatus": {
    object (ResourceStatus)
  },
  "storagePoolType": string,
  "status": {
    object (ResourceStatus)
  },
  "capacityProvisioningType": enum (ProvisioningType),
  "performanceProvisioningType": enum (ProvisioningType),
  "exapoolProvisionedCapacityGb": {
    object (ExapoolProvisionedCapacityGb)
  },
  "params": {
    object (StoragePoolParams)
  }
}
Fields
kind

string

[Output Only] Type of the resource. Always

compute#storagePool

for storage pools.
id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.
creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.
name

string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
description

string

An optional description of this resource. Provide this property when you create the resource.
poolProvisionedCapacityGb

string (int64 format)

Size, in GiB, of the storage pool. For more information about the size limits, see https://documentation.s3ns.fr/compute/docs/disks/storage-pools.
poolProvisionedIops

string (int64 format)

Provisioned IOPS of the storage pool. Only relevant if the storage pool type is hyperdisk-balanced.
poolProvisionedThroughput

string (int64 format)

Provisioned throughput of the storage pool in MiB/s. Only relevant if the storage pool type is hyperdisk-balanced or hyperdisk-throughput.
zone

string

[Output Only] URL of the zone where the storage pool resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
state

enum (State)

[Output Only] The status of storage pool creation.

  • CREATING

    : Storage pool is provisioning.

    • storagePool.

  • FAILED

    : Storage pool creation failed.

  • READY

    : Storage pool is ready for use.

  • DELETING

    : Storage pool is deleting.
labels

map (key: string, value: string)

Labels to apply to this storage pool. These can be later modified by the

setLabels

method.
labelFingerprint

string (bytes format)

A fingerprint for the labels being applied to this storage pool, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error

412 conditionNotMet

.

To see the latest fingerprint, make a

get()

request to retrieve a storage pool.

A base64-encoded string.
resourceStatus

object (ResourceStatus)

[Output Only] Status information for the storage pool resource.
storagePoolType

string

Type of the storage pool.
status

object (ResourceStatus)

[Output Only] Status information for the storage pool resource.
capacityProvisioningType

enum (ProvisioningType)

Provisioning type of the byte capacity of the pool.
performanceProvisioningType

enum (ProvisioningType)

Provisioning type of the performance-related parameters of the pool, such as throughput and IOPS.
exapoolProvisionedCapacityGb

object (ExapoolProvisionedCapacityGb)

[Output Only] Provisioned capacities for each SKU for this Exapool in GiB
params

object (StoragePoolParams)

Input only. Additional params passed with the request, but not persisted as part of resource payload.

State

Enums
CREATING StoragePool is provisioning
FAILED StoragePool creation failed.
READY StoragePool is ready for use.
DELETING StoragePool is deleting.

ResourceStatus

[Output Only] Contains output only fields.

JSON representation 
{
  "lastResizeTimestamp": string,
  "diskCount": string,
  "poolUsedCapacityBytes": string,
  "poolUserWrittenBytes": string,
  "totalProvisionedDiskCapacityGb": string,
  "maxTotalProvisionedDiskCapacityGb": string,
  "poolUsedIops": string,
  "totalProvisionedDiskIops": string,
  "poolUsedThroughput": string,
  "totalProvisionedDiskThroughput": string,
  "exapoolMaxReadIops": string,
  "exapoolMaxWriteIops": string,
  "exapoolMaxReadThroughput": string,
  "exapoolMaxWriteThroughput": string
}
Fields
lastResizeTimestamp

string

[Output Only] Timestamp of the last successful resize in RFC3339 text format.
diskCount

string (int64 format)

[Output Only] Number of disks used.
poolUsedCapacityBytes

string (int64 format)

[Output Only] Space used by data stored in disks within the storage pool (in bytes). This will reflect the total number of bytes written to the disks in the pool, in contrast to the capacity of those disks.
poolUserWrittenBytes

string (int64 format)

[Output Only] Amount of data written into the pool, before it is compacted.
totalProvisionedDiskCapacityGb

string (int64 format)

[Output Only] Sum of all the disks' provisioned capacity (in GiB) in this storage pool. A disk's provisioned capacity is the same as its total capacity.
maxTotalProvisionedDiskCapacityGb

string (int64 format)

[Output Only] Maximum allowed aggregate disk size in GiB.
poolUsedIops

string (int64 format)

[Output Only] Sum of all the disks' provisioned IOPS, minus some amount that is allowed per disk that is not counted towards pool's IOPS capacity. For more information, see https://documentation.s3ns.fr/compute/docs/disks/storage-pools.
totalProvisionedDiskIops

string (int64 format)

[Output Only] Sum of all the disks' provisioned IOPS.
poolUsedThroughput

string (int64 format)

[Output Only] Sum of all the disks' provisioned throughput in MiB/s.
totalProvisionedDiskThroughput

string (int64 format)

[Output Only] Sum of all the disks' provisioned throughput in MiB/s, minus some amount that is allowed per disk that is not counted towards pool's throughput capacity.
exapoolMaxReadIops

string (int64 format)

[Output Only] Maximum allowed read IOPS for this Exapool.
exapoolMaxWriteIops

string (int64 format)

[Output Only] Maximum allowed write IOPS for this Exapool.
exapoolMaxReadThroughput

string (int64 format)

[Output Only] Maximum allowed read throughput in MiB/s for this Exapool.
exapoolMaxWriteThroughput

string (int64 format)

[Output Only] Maximum allowed write throughput in MiB/s for this Exapool.

ProvisioningType

Provisioning type of various parameters.

Enums
UNSPECIFIED
STANDARD Standard provisioning allocates the related resource for the pool disks' exclusive use.
ADVANCED Advanced provisioning "thinly" allocates the related resource.

ExapoolProvisionedCapacityGb

Exapool provisioned capacities for each SKU type

JSON representation 
{
  "writeOptimized": string,
  "readOptimized": string,
  "capacityOptimized": string
}
Fields
writeOptimized

string (int64 format)

Output only. Size, in GiB, of provisioned write-optimized capacity for this Exapool
readOptimized

string (int64 format)

Output only. Size, in GiB, of provisioned read-optimized capacity for this Exapool
capacityOptimized

string (int64 format)

Output only. Size, in GiB, of provisioned capacity-optimized capacity for this Exapool

StoragePoolParams

Additional storage pool params.

JSON representation 
{
  "resourceManagerTags": {
    string: string,
    ...
  }
}
Fields
resourceManagerTags

map (key: string, value: string)

Input only. Resource manager tags to be bound to the storage pool. Tag keys and values have the same definition as resource manager tags. Keys and values can be either in numeric format, such as tagKeys/{tag_key_id} and tagValues/456 or in namespaced format such as {org_id|projectId}/{tag_key_short_name} and {tag_value_short_name}. The field is ignored (both PUT & PATCH) when empty.

Methods

aggregatedList

 The method compute.v1.StoragePoolsService.AggregatedList is not available in Cloud de Confiance by S3NS.

delete

 The method compute.v1.StoragePoolsService.Delete is not available in Cloud de Confiance by S3NS.

get

 The method compute.v1.StoragePoolsService.Get is not available in Cloud de Confiance by S3NS.

getIamPolicy

 The method compute.v1.StoragePoolsService.GetPolicy is not available in Cloud de Confiance by S3NS.

insert

 The method compute.v1.StoragePoolsService.Insert is not available in Cloud de Confiance by S3NS.

list

 The method compute.v1.StoragePoolsService.List is not available in Cloud de Confiance by S3NS.

listDisks

 The method compute.v1.StoragePoolsService.ListDisks is not available in Cloud de Confiance by S3NS.

setIamPolicy

 The method compute.v1.StoragePoolsService.SetPolicy is not available in Cloud de Confiance by S3NS.

testIamPermissions

 The method compute.v1.StoragePoolsService.TestPermissions is not available in Cloud de Confiance by S3NS.

update

 The method compute.v1.StoragePoolsService.Update is not available in Cloud de Confiance by S3NS.