Method: storagePools.aggregatedList

Retrieves an aggregated list of storage pools.

To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

HTTP request

GET https://compute.googleapis.com/compute/beta/projects/{project}/aggregated/storagePools

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project

string

Project ID for this request.

Query parameters

Parameters
maxResults

integer (uint32 format)

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)
pageToken

string

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter

string

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request.

If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either =, !=, >, <, <=, >= or :.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use:

labels.owner:*

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example:

(scheduling.automaticRestart = true)
(cpuPlatform = "Intel Skylake")

By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example:

(cpuPlatform = "Intel Skylake") OR
(cpuPlatform = "Intel Broadwell") AND
(scheduling.automaticRestart = true)

If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples:

fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal")

The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field.

For example, to filter for instances that do not end with name "instance", you would use name ne .*instance.

You cannot combine constraints on multiple fields using regular expressions.
orderBy

string

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
returnPartialSuccess

boolean

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.
includeAllScopes

boolean

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
serviceProjectNumber

string (int64 format)

The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.

Request body

The request body must be empty.

Response body

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

JSON representation 
{
  "kind": string,
  "id": string,
  "items": {
    string: {
      "storagePools": [
        {
          "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
        }
      ],
      "warning": {
        "code": enum,
        "message": string,
        "data": [
          {
            "key": string,
            "value": string
          }
        ]
      }
    },
    ...
  },
  "nextPageToken": string,
  "selfLink": string,
  "warning": {
    "code": enum,
    "message": string,
    "data": [
      {
        "key": string,
        "value": string
      }
    ]
  },
  "etag": string,
  "unreachables": [
    string
  ]
}
Fields
kind

string

[Output Only] Type of resource. Always compute#storagePoolAggregatedList for aggregated lists of storage pools.
id

string

[Output Only] Unique identifier for the resource; defined by the server.
items

map (key: string, value: object)

A list of StoragePoolsScopedList resources.

Key: [Output Only] Name of the scope containing this set of storage pool.
items.storagePools[]

object

[Output Only] A list of storage pool contained in this scope.
items.storagePools[].kind

string

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

string (uint64 format)

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

string

[Output Only] Creation timestamp in RFC3339 text format.
items.storagePools[].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.
items.storagePools[].description

string

An optional description of this resource. Provide this property when you create the resource.
items.storagePools[].poolProvisionedCapacityGb

string (int64 format)

Size, in GiB, of the storage pool.
items.storagePools[].poolProvisionedIops

string (int64 format)

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

string (int64 format)

Provisioned throughput of the storage pool. Only relevant if the storage pool type is hyperdisk-balanced or hyperdisk-throughput.
items.storagePools[].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.
items.storagePools[].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.
items.storagePools[].selfLink

string

[Output Only] Server-defined fully-qualified URL for this resource.
items.storagePools[].selfLinkWithId

string

[Output Only] Server-defined URL for this resource's resource id.
items.storagePools[].labels

map (key: string, value: string)

Labels to apply to this storage pool. These can be later modified by the setLabels method.
items.storagePools[].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.
items.storagePools[].resourceStatus

object

[Output Only] Status information for the storage pool resource.
items.storagePools[].resourceStatus.lastResizeTimestamp

string

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

string (int64 format)

[Output Only] Number of disks used.
items.storagePools[].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.
items.storagePools[].resourceStatus.poolUserWrittenBytes

string (int64 format)

[Output Only] Amount of data written into the pool, before it is compacted.
items.storagePools[].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.
items.storagePools[].resourceStatus.maxTotalProvisionedDiskCapacityGb

string (int64 format)

[Output Only] Maximum allowed aggregate disk size in gigabytes.
items.storagePools[].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.
items.storagePools[].resourceStatus.totalProvisionedDiskIops

string (int64 format)

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

string (int64 format)

[Output Only] Sum of all the disks' provisioned throughput in MB/s.
items.storagePools[].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.
items.storagePools[].storagePoolType

string

Type of the storage pool.
items.storagePools[].status

object

[Output Only] Status information for the storage pool resource.
items.storagePools[].status.lastResizeTimestamp

string

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

string (int64 format)

[Output Only] Number of disks used.
items.storagePools[].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.
items.storagePools[].status.poolUserWrittenBytes

string (int64 format)

[Output Only] Amount of data written into the pool, before it is compacted.
items.storagePools[].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.
items.storagePools[].status.maxTotalProvisionedDiskCapacityGb

string (int64 format)

[Output Only] Maximum allowed aggregate disk size in gigabytes.
items.storagePools[].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.
items.storagePools[].status.totalProvisionedDiskIops

string (int64 format)

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

string (int64 format)

[Output Only] Sum of all the disks' provisioned throughput in MB/s.
items.storagePools[].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.
items.storagePools[].capacityProvisioningType

enum

Provisioning type of the byte capacity of the pool.
items.storagePools[].performanceProvisioningType

enum

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

object

[Output Only] Informational warning which replaces the list of storage pool when the list is empty.
items.warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
items.warning.message

string

[Output Only] A human-readable description of the warning code.
items.warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: 

"data": [  {  "key": "scope",  "value": "zones/us-east1-d"  }
items.warning.data[].key

string

[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
items.warning.data[].value

string

[Output Only] A warning data value corresponding to the key.
nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
warning

object

[Output Only] Informational warning message.
warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
warning.message

string

[Output Only] A human-readable description of the warning code.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: 

"data": [  {  "key": "scope",  "value": "zones/us-east1-d"  }
warning.data[].key

string

[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
warning.data[].value

string

[Output Only] A warning data value corresponding to the key.
etag

string
unreachables[]

string

[Output Only] Unreachable resources.

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

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