Method: instanceSettings.get

instanceSettings.get Instance settings.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project

string

Project ID for this request.
zone

string

Name of the zone for this request.

Request body

The request body must be empty.

Response body

Represents a Instance Settings resource. You can use instance settings to configure default settings for Compute Engine VM instances. For example, you can use it to configure default machine type of Compute Engine VM instances.

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

JSON representation 
{
  "kind": string,
  "fingerprint": string,
  "metadata": {
    "kind": string,
    "items": {
      string: string,
      ...
    }
  },
  "zone": string
}
Fields
kind

string

[Output Only] Type of the resource. Always compute#instance_settings for instance settings.
fingerprint

string (bytes format)

Specifies a fingerprint for instance settings, which is essentially a hash of the instance settings resource's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update the instance settings resource. You must always provide an up-to-date fingerprint hash in order to update or change the resource, otherwise the request will fail with error 412 conditionNotMet.

To see the latest fingerprint, make a get() request to retrieve the resource.

A base64-encoded string.
metadata

object

The metadata key/value pairs assigned to all the instances in the corresponding scope.
metadata.kind

string

[Output Only] Type of the resource. Always compute#metadata for metadata.
metadata.items

map (key: string, value: string)

A metadata key/value items map. The total size of all keys and values must be less than 512KB.
zone

string

[Output Only] URL of the zone where the resource resides 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.instanceSettings.get

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