GOgoogle
storagePools

GET /projects/{project}/zones/{zone}/storagePools/{storagePool}

Changed on

Returns a specified storage pool. Gets a list of available storage pools by making a list() request.

Request

  • Base URL
    https://compute.googleapis.com/compute/v1
  • URL
    https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/storagePools/{storagePool}
  • Auth
    • OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/cloud-platform
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/cloud-platform
    • or OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/compute
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/compute
    • or OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/compute.readonly
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/compute.readonly

Path parameters

projectstring required

Project ID for this request.

zonestring required

The name of the zone for this request.

storagePoolstring required

Name of the storage pool to return.

Response

Successful response

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

Provisioning type of the byte capacity of the pool.

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.

idstring uint64

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

kindstring

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

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.

labelsobject

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

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.

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

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

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.

poolProvisionedIopsstring int64

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

poolProvisionedThroughputstring int64

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

selfLinkstring

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

selfLinkWithIdstring

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

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.
storagePoolTypestring

Type of the storage pool.

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.

Changes

  • 8b85e897d3dcRevision changes
    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/compute.readonly was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/compute.readonly was removed from the endpoint's security scheme Oauth2c

  • 48929bf89eebRevision changes
    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/compute.readonly was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/compute.readonly was removed from the endpoint's security scheme Oauth2c