Method: snapshotSettings.get

snapshotSettings.get snapshot settings.

HTTP request

GET https://compute.googleapis.com/compute/beta/projects/{project}/global/snapshotSettings

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project

string

Project ID for this request.

Request body

The request body must be empty.

Response body

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

JSON representation
{
  "storageLocation": {
    "policy": enum,
    "locations": {
      string: {
        "name": string
      },
      ...
    }
  }
}
Fields
storageLocation

object

Policy of which storage location is going to be resolved, and additional data that particularizes how the policy is going to be carried out.

storageLocation.policy

enum

The chosen location policy.

storageLocation.locations[]

map (key: string, value: object)

When the policy is SPECIFIC_LOCATIONS, snapshots will be stored in the locations listed in this field. Keys are GCS bucket locations.

storageLocation.locations[].name

string

Name of the location. It should be one of the GCS buckets.

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

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