Method: diskTypes.get

Returns the specified disk type.

HTTP request

GET https://compute.googleapis.com/compute/beta/projects/{project}/zones/{zone}/diskTypes/{diskType}

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

Path parameters

Parameters
project

string

Project ID for this request.

zone

string

The name of the zone for this request.

diskType

string

Name of the disk type to return.

Request body

The request body must be empty.

Response body

Represents a Disk Type resource.

Google Compute Engine has two Disk Type resources:

You can choose from a variety of disk types based on your needs. For more information, readStorage options.

ThediskTypes resource represents disk types for a zonal persistent disk. For more information, readZonal persistent disks.

TheregionDiskTypes resource represents disk types for a regional persistent disk. For more information, readRegional persistent disks.

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

JSON representation
{"kind":string,"id":string,"creationTimestamp":string,"name":string,"description":string,"validDiskSize":string,"deprecated":{"state":enum,"replacement":string,"deprecated":string,"obsolete":string,"deleted":string,"stateOverride":{"locationRolloutPolicies":{string:string,...},"defaultRolloutTime":string}},"zone":string,"selfLink":string,"defaultDiskSizeGb":string,"region":string}
Fields
kind

string

[Output Only] Type of the resource. Alwayscompute#diskType for disk 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 inRFC3339 text format.

name

string

[Output Only] Name of the resource.

description

string

[Output Only] An optional description of this resource.

validDiskSize

string

[Output Only] An optional textual description of the valid disk size, such as "10GB-10TB".

deprecated

object

[Output Only] The deprecation status associated with this disk type.

deprecated.state

enum

The deprecation state of this resource. This can beACTIVE,DEPRECATED,OBSOLETE, orDELETED. Operations which communicate the end of life date for an image, can useACTIVE. Operations which create a new resource using aDEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which useOBSOLETE orDELETED 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 optionalRFC3339 timestamp on or after which the state of this resource is intended to change toDEPRECATED. This is only informational and the status will not change unless the client explicitly changes it.

deprecated.obsolete

string

An optionalRFC3339 timestamp on or after which the state of this resource is intended to change toOBSOLETE. This is only informational and the status will not change unless the client explicitly changes it.

deprecated.deleted

string

An optionalRFC3339 timestamp on or after which the state of this resource is intended to change toDELETED. 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 theimageFamilyViews.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 anRFC3339 timestamp on or after which the update is considered rolled out to the specified location.

deprecated.stateOverride.defaultRolloutTime

string

An optionalRFC3339 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 disk 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.

defaultDiskSizeGb

string (int64 format)

[Output Only] Server-defined default disk size in GB.

region

string

[Output Only] URL of the region where the disk type resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

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 theAuthentication Overview.

IAM Permissions

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

  • compute.diskTypes.get

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

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-09-18 UTC.