Method: diskTypes.get

Returns the specified disk type.

HTTP request

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

The URL uses gRPC Transcoding syntax.

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, read Storage options.

The diskTypes resource represents disk types for a zonal persistent disk. For more information, read Zonal persistent disks.

The regionDiskTypes resource represents disk types for a regional persistent disk. For more information, read Regional 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
  },
  "zone": string,
  "selfLink": string,
  "defaultDiskSizeGb": string,
  "region": string
}
Fields
kind

string

[Output Only] Type of the resource. Always compute#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 in RFC3339 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 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.
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.
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 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.diskTypes.get

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