Method: storagePools.get

HTTP request
Path parameters
Request body
Response body
- JSON representation
Authorization scopes
IAM Permissions
Try it!

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

HTTP request

GET https://compute.googleapis.com/compute/beta/projects/{project}/zones/{zone}/storagePools/{storagePool}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters

Parameters
`project`	`string` Project ID for this request.
`zone`	`string` The name of the zone for this request.
`storagePool`	`string` Name of the storage pool to return.

project

string

Project ID for this request.

zone

string

The name of the zone for this request.

storagePool

string

Name of the storage pool to return.

Request body

The request body must be empty.

Response body

Represents a zonal storage pool resource.

If successful, the response body contains data with the following structure:

JSON representation
{ "kind": string, "id": string, "creationTimestamp": string, "name": string, "description": string, "poolProvisionedCapacityGb": string, "poolProvisionedIops": string, "poolProvisionedThroughput": string, "zone": string, "state": enum, "selfLink": string, "selfLinkWithId": string, "labels": { string: string, ... }, "labelFingerprint": string, "resourceStatus": { "lastResizeTimestamp": string, "diskCount": string, "poolUsedCapacityBytes": string, "poolUserWrittenBytes": string, "totalProvisionedDiskCapacityGb": string, "maxTotalProvisionedDiskCapacityGb": string, "poolUsedIops": string, "totalProvisionedDiskIops": string, "poolUsedThroughput": string, "totalProvisionedDiskThroughput": string }, "storagePoolType": string, "status": { "lastResizeTimestamp": string, "diskCount": string, "poolUsedCapacityBytes": string, "poolUserWrittenBytes": string, "totalProvisionedDiskCapacityGb": string, "maxTotalProvisionedDiskCapacityGb": string, "poolUsedIops": string, "totalProvisionedDiskIops": string, "poolUsedThroughput": string, "totalProvisionedDiskThroughput": string }, "capacityProvisioningType": enum, "performanceProvisioningType": enum }

JSON representation

{
  "kind": string,
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "poolProvisionedCapacityGb": string,
  "poolProvisionedIops": string,
  "poolProvisionedThroughput": string,
  "zone": string,
  "state": enum,
  "selfLink": string,
  "selfLinkWithId": string,
  "labels": {
    string: string,
    ...
  },
  "labelFingerprint": string,
  "resourceStatus": {
    "lastResizeTimestamp": string,
    "diskCount": string,
    "poolUsedCapacityBytes": string,
    "poolUserWrittenBytes": string,
    "totalProvisionedDiskCapacityGb": string,
    "maxTotalProvisionedDiskCapacityGb": string,
    "poolUsedIops": string,
    "totalProvisionedDiskIops": string,
    "poolUsedThroughput": string,
    "totalProvisionedDiskThroughput": string
  },
  "storagePoolType": string,
  "status": {
    "lastResizeTimestamp": string,
    "diskCount": string,
    "poolUsedCapacityBytes": string,
    "poolUserWrittenBytes": string,
    "totalProvisionedDiskCapacityGb": string,
    "maxTotalProvisionedDiskCapacityGb": string,
    "poolUsedIops": string,
    "totalProvisionedDiskIops": string,
    "poolUsedThroughput": string,
    "totalProvisionedDiskThroughput": string
  },
  "capacityProvisioningType": enum,
  "performanceProvisioningType": enum
}

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.
`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. 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` [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.
`selfLink`	`string` [Output Only] Server-defined fully-qualified URL for this resource.
`selfLinkWithId`	`string` [Output Only] Server-defined URL for this resource's resource id.
`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` [Output Only] Status information for the storage pool resource.
`resourceStatus.lastResizeTimestamp`	`string` [Output Only] Timestamp of the last successful resize in RFC3339 text format.
`resourceStatus.diskCount`	`string (int64 format)` [Output Only] Number of disks used.
`resourceStatus.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.
`resourceStatus.poolUserWrittenBytes`	`string (int64 format)` [Output Only] Amount of data written into the pool, before it is compacted.
`resourceStatus.totalProvisionedDiskCapacityGb`	`string (int64 format)` [Output Only] Sum of all the capacity provisioned in disks in this storage pool. A disk's provisioned capacity is the same as its total capacity.
`resourceStatus.maxTotalProvisionedDiskCapacityGb`	`string (int64 format)` [Output Only] Maximum allowed aggregate disk size in gigabytes.
`resourceStatus.poolUsedIops`	`string (int64 format)` Sum of all the disks' provisioned IOPS, minus some amount that is allowed per disk that is not counted towards pool's IOPS capacity.
`resourceStatus.totalProvisionedDiskIops`	`string (int64 format)` [Output Only] Sum of all the disks' provisioned IOPS.
`resourceStatus.poolUsedThroughput`	`string (int64 format)` [Output Only] Sum of all the disks' provisioned throughput in MB/s.
`resourceStatus.totalProvisionedDiskThroughput`	`string (int64 format)` [Output Only] Sum of all the disks' provisioned throughput in MB/s, minus some amount that is allowed per disk that is not counted towards pool's throughput capacity.
`storagePoolType`	`string` Type of the storage pool.
`status`	`object` [Output Only] Status information for the storage pool resource.
`status.lastResizeTimestamp`	`string` [Output Only] Timestamp of the last successful resize in RFC3339 text format.
`status.diskCount`	`string (int64 format)` [Output Only] Number of disks used.
`status.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.
`status.poolUserWrittenBytes`	`string (int64 format)` [Output Only] Amount of data written into the pool, before it is compacted.
`status.totalProvisionedDiskCapacityGb`	`string (int64 format)` [Output Only] Sum of all the capacity provisioned in disks in this storage pool. A disk's provisioned capacity is the same as its total capacity.
`status.maxTotalProvisionedDiskCapacityGb`	`string (int64 format)` [Output Only] Maximum allowed aggregate disk size in gigabytes.
`status.poolUsedIops`	`string (int64 format)` Sum of all the disks' provisioned IOPS, minus some amount that is allowed per disk that is not counted towards pool's IOPS capacity.
`status.totalProvisionedDiskIops`	`string (int64 format)` [Output Only] Sum of all the disks' provisioned IOPS.
`status.poolUsedThroughput`	`string (int64 format)` [Output Only] Sum of all the disks' provisioned throughput in MB/s.
`status.totalProvisionedDiskThroughput`	`string (int64 format)` [Output Only] Sum of all the disks' provisioned throughput in MB/s, minus some amount that is allowed per disk that is not counted towards pool's throughput capacity.
`capacityProvisioningType`	`enum` Provisioning type of the byte capacity of the pool.
`performanceProvisioningType`	`enum` Provisioning type of the performance-related parameters of the pool, such as throughput and IOPS.

Authorization scopes

Requires one of the following OAuth scopes:

https://www.googleapis.com/auth/compute.readonly
https://www.googleapis.com/auth/compute
https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

In addition to any permissions specified on the fields above, authorization requires one or more of the following IAM permissions:

compute.storagePools.get

To find predefined roles that contain those permissions, see Compute Engine IAM Roles.