Method: machineTypes.get

Returns the specified machine type. Gets a list of available machine types by making a list() request.

HTTP request

GET https://www.googleapis.com/compute/v1/projects/{project}/zones/{zone}/machineTypes/{resourceId}

The URL uses Google API HTTP annotation syntax.

Path parameters

Parameters
project

string

Project ID for this request.

zone

string

The name of the zone for this request.

resourceId

string

Name of the machine type to return.

Request body

The request body must be empty.

Response body

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

A Machine Type resource.

JSON representation
{
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "guestCpus": number,
  "memoryMb": number,
  "imageSpaceGb": number,
  "scratchDisks": [
    {
      "diskGb": number
    }
  ],
  "maximumPersistentDisks": number,
  "maximumPersistentDisksSizeGb": string,
  "deprecated": {
    "state": enum,
    "replacement": string,
    "deprecated": string,
    "obsolete": string,
    "deleted": string
  },
  "zone": string,
  "selfLink": string,
  "isSharedCpu": boolean,
  "kind": string
}
Fields
id

string (fixed64 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 textual description of the resource.

guestCpus

number

[Output Only] The number of virtual CPUs that are available to the instance.

memoryMb

number

[Output Only] The amount of physical memory available to the instance, defined in MB.

imageSpaceGb

number

[Deprecated] This property is deprecated and will never be populated with any relevant values.

scratchDisks[]

object

[Output Only] A list of extended scratch disks assigned to the instance.

scratchDisks[].diskGb

number

Size of the scratch disk, defined in GB.

maximumPersistentDisks

number

[Output Only] Maximum persistent disks allowed.

maximumPersistentDisksSizeGb

string (int64 format)

[Output Only] Maximum total persistent disks size (GB) allowed.

deprecated

object

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

deprecated.state

enum

The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED. 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] The name of the zone where the machine type resides, such as us-central1-a.

isSharedCpu

boolean

[Output Only] Whether this machine type has a shared CPU. See Shared-core machine types for more information.

kind

string

[Output Only] The type of the resource. Always compute#machineType for machine types.

Authorization Scopes

Requires one of the following OAuth scopes:

  • 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 Google IAM permissions:

  • compute.machineTypes.get
Was this page helpful? Let us know how we did:

Send feedback about...

Compute Engine