v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-131,0021,0174.3 MB
storagePools

Creates a storage pool in the specified project using the data in the request.

post/projects/{project}/zones/{zone}/storagePools

Path parameters

projectstring required

Project ID for this request.

zonestring required

The name of the zone for this request.

Query parameters

requestIdstring

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Request body

poolProvisionedCapacityGbstring int64

Size of the storage pool in GiB. For more information about the size limits, see https://cloud.google.com/compute/docs/disks/storage-pools.

namestring

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. 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.

kindstring

Output only. [Output Only] Type of the resource. Always compute#storagePool for storage pools.

creationTimestampstring

Output only. [Output Only] Creation timestamp inRFC3339 text format.

descriptionstring

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

storagePoolTypestring

Type of the storage pool.

labelFingerprintstring byte

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 error412 conditionNotMet.

To see the latest fingerprint, make a get() request to retrieve a storage pool.

state'CREATING' | 'DELETING' | 'FAILED' | 'READY'

Output only. [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.
labelsobject

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

performanceProvisioningType'ADVANCED' | 'STANDARD' | 'UNSPECIFIED'

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

selfLinkstring

Output only. [Output Only] Server-defined fully-qualified URL for this resource.

poolProvisionedThroughputstring int64

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

zonestring

Output only. [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.

capacityProvisioningType'ADVANCED' | 'STANDARD' | 'UNSPECIFIED'

Provisioning type of the byte capacity of the pool.

selfLinkWithIdstring

Output only. [Output Only] Server-defined URL for this resource's resource id.

idstring uint64

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

poolProvisionedIopsstring int64

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

Response

Successful response