Method: storagePoolTypes.get

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

Returns the specified storage pool type.

HTTP request

GET https://compute.googleapis.com/compute/beta/projects/{project}/zones/{zone}/storagePoolTypes/{storagePoolType}

The URL uses gRPC Transcoding syntax. To know more about valid error responses that can be thrown by this HTTP request, please refer to the service error catalog

Path parameters

Parameters

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

project

string

Project ID for this request.

zone

string

The name of the zone for this request.

storagePoolType

string

Name of the storage pool type to return.

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 , "creationTimestamp" : string , "name" : string , "description" : string , "deprecated" : { "state" : enum , "replacement" : string , "deprecated" : string , "obsolete" : string , "deleted" : string , "stateOverride" : { "locationRolloutPolicies" : { string : string , ... } , "defaultRolloutTime" : string } } , "zone" : string , "selfLink" : string , "selfLinkWithId" : string , "minSizeGb" : string , "minPoolProvisionedCapacityGb" : string , "maxPoolProvisionedCapacityGb" : string , "minPoolProvisionedIops" : string , "maxPoolProvisionedIops" : string , "minPoolProvisionedThroughput" : string , "maxPoolProvisionedThroughput" : string , "supportedDiskTypes" : [ string ] }

JSON representation

 { 
 "kind" 
 : 
 string 
 , 
 "id" 
 : 
 string 
 , 
 "creationTimestamp" 
 : 
 string 
 , 
 "name" 
 : 
 string 
 , 
 "description" 
 : 
 string 
 , 
 "deprecated" 
 : 
 { 
 "state" 
 : 
 enum 
 , 
 "replacement" 
 : 
 string 
 , 
 "deprecated" 
 : 
 string 
 , 
 "obsolete" 
 : 
 string 
 , 
 "deleted" 
 : 
 string 
 , 
 "stateOverride" 
 : 
 { 
 "locationRolloutPolicies" 
 : 
 { 
 string 
 : 
 string 
 , 
 ... 
 } 
 , 
 "defaultRolloutTime" 
 : 
 string 
 } 
 } 
 , 
 "zone" 
 : 
 string 
 , 
 "selfLink" 
 : 
 string 
 , 
 "selfLinkWithId" 
 : 
 string 
 , 
 "minSizeGb" 
 : 
 string 
 , 
 "minPoolProvisionedCapacityGb" 
 : 
 string 
 , 
 "maxPoolProvisionedCapacityGb" 
 : 
 string 
 , 
 "minPoolProvisionedIops" 
 : 
 string 
 , 
 "maxPoolProvisionedIops" 
 : 
 string 
 , 
 "minPoolProvisionedThroughput" 
 : 
 string 
 , 
 "maxPoolProvisionedThroughput" 
 : 
 string 
 , 
 "supportedDiskTypes" 
 : 
 [ 
 string 
 ] 
 }

Fields
`kind`	`string` [Output Only] Type of the resource. Always `compute#storagePoolType` for storage pool types.
`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` [Output Only] Name of the resource.
`description`	`string` [Output Only] An optional description of this resource.
`deprecated`	`object` [Output Only] The deprecation status associated with this storage pool type.
`deprecated.state`	`enum` The deprecation state of this resource. This can be `ACTIVE` , `DEPRECATED` , `OBSOLETE` , or `DELETED` . Operations which communicate the end of life date for an image, can use `ACTIVE` . Operations which create a new resource using a `DEPRECATED` resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use `OBSOLETE` or `DELETED` resources will be rejected and result in an error.
`deprecated.replacement`	`string` The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
`deprecated.deprecated`	`string` An optional RFC3339 timestamp on or after which the state of this resource is intended to change to `DEPRECATED` . This is only informational and the status will not change unless the client explicitly changes it.
`deprecated.obsolete`	`string` An optional RFC3339 timestamp on or after which the state of this resource is intended to change to `OBSOLETE` . This is only informational and the status will not change unless the client explicitly changes it.
`deprecated.deleted`	`string` An optional RFC3339 timestamp on or after which the state of this resource is intended to change to `DELETED` . This is only informational and the status will not change unless the client explicitly changes it.
`deprecated.stateOverride`	`object` The rollout policy for this deprecation. This policy is only enforced by image family views. The rollout policy restricts the zones where the associated resource is considered in a deprecated state. When the rollout policy does not include the user specified zone, or if the zone is rolled out, the associated resource is considered in a deprecated state. The rollout policy for this deprecation is read-only, except for allowlisted users. This field might not be configured. To view the latest non-deprecated image in a specific zone, use the `imageFamilyViews.get` method.
`deprecated.stateOverride.locationRolloutPolicies`	`map (key: string, value: string)` Location based rollout policies to apply to the resource. Currently only zone names are supported and must be represented as valid URLs, like: zones/us-central1-a. The value expects an RFC3339 timestamp on or after which the update is considered rolled out to the specified location.
`deprecated.stateOverride.defaultRolloutTime`	`string` An optional RFC3339 timestamp on or after which the update is considered rolled out to any zone that is not explicitly stated.
`zone`	`string` [Output Only] URL of the zone where the storage pool type resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
`selfLink`	`string` [Output Only] Server-defined URL for the resource.
`selfLinkWithId`	`string` [Output Only] Server-defined URL for this resource with the resource id.
`minSizeGb`	`string ( int64 format)` [Deprecated] This field is deprecated. Use minPoolProvisionedCapacityGb instead.
`minPoolProvisionedCapacityGb`	`string ( int64 format)` [Output Only] Minimum storage pool size in GB.
`maxPoolProvisionedCapacityGb`	`string ( int64 format)` [Output Only] Maximum storage pool size in GB.
`minPoolProvisionedIops`	`string ( int64 format)` [Output Only] Minimum provisioned IOPS.
`maxPoolProvisionedIops`	`string ( int64 format)` [Output Only] Maximum provisioned IOPS.
`minPoolProvisionedThroughput`	`string ( int64 format)` [Output Only] Minimum provisioned throughput.
`maxPoolProvisionedThroughput`	`string ( int64 format)` [Output Only] Maximum provisioned throughput.
`supportedDiskTypes[]`	`string` [Output Only] The list of disk types supported in this storage pool type.

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.storagePoolTypes.get

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