Method: reservations.get

Retrieves information about the specified reservation.

HTTP request

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

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.
reservation

string

Name of the reservation to retrieve.

Request body

The request body must be empty.

Response body

Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources.

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

JSON representation 
{
  "kind": string,
  "id": string,
  "creationTimestamp": string,
  "selfLink": string,
  "zone": string,
  "description": string,
  "name": string,
  "commitment": string,
  "specificReservationRequired": boolean,
  "status": enum,
  "shareSettings": {
    "shareType": enum,
    "projectMap": {
      string: {
        "projectId": string
      },
      ...
    }
  },
  "satisfiesPzs": boolean,
  "resourcePolicies": {
    string: string,
    ...
  },
  "resourceStatus": {
    "specificSkuAllocation": {
      "sourceInstanceTemplateId": string
    }
  },

  // Union field type can be only one of the following:
  "specificReservation": {
    "instanceProperties": {
      "machineType": string,
      "guestAccelerators": [
        {
          "acceleratorType": string,
          "acceleratorCount": integer
        }
      ],
      "minCpuPlatform": string,
      "localSsds": [
        {
          "diskSizeGb": string,
          "interface": enum
        }
      ],
      "locationHint": string
    },
    "count": string,
    "inUseCount": string,
    "assuredCount": string,
    "sourceInstanceTemplate": string
  },
  "aggregateReservation": {
    "vmFamily": enum,
    "reservedResources": [
      {

        // Union field reserved_resource can be only one of the following:
        "accelerator": {
          "acceleratorCount": integer,
          "acceleratorType": string
        }
        // End of list of possible types for union field reserved_resource.
      }
    ],
    "inUseResources": [
      {

        // Union field reserved_resource can be only one of the following:
        "accelerator": {
          "acceleratorCount": integer,
          "acceleratorType": string
        }
        // End of list of possible types for union field reserved_resource.
      }
    ],
    "workloadType": enum
  }
  // End of list of possible types for union field type.
}
Fields
kind

string

[Output Only] Type of the resource. Always compute#reservations for reservations.
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.
zone

string

Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment.
description

string

An optional description of this resource. Provide this property when you create the resource.
name

string

The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
commitment

string

[Output Only] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment.
specificReservationRequired

boolean

Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation.
status

enum

[Output Only] The status of the reservation.

  • CREATING: Reservation resources are being allocated.
  • READY: Reservation resources have been allocated, and the reservation is ready for use.
  • DELETING: Reservation deletion is in progress.
  • UPDATING: Reservation update is in progress.
shareSettings

object

Specify share-settings to create a shared reservation. This property is optional. For more information about the syntax and options for this field and its subfields, see the guide for creating a shared reservation.
shareSettings.shareType

enum

Type of sharing for this shared-reservation
shareSettings.projectMap[]

map (key: string, value: object)

A map of project id and project config. This is only valid when shareType's value is SPECIFIC_PROJECTS.
shareSettings.projectMap[].projectId

string

The project ID, should be same as the key of this project config in the parent map.
satisfiesPzs

boolean

[Output Only] Reserved for future use.
resourcePolicies

map (key: string, value: string)

Resource policies to be added to this reservation. The key is defined by user, and the value is resource policy url. This is to define placement policy with reservation.
resourceStatus

object

[Output Only] Status information for Reservation resource.
resourceStatus.specificSkuAllocation

object

Allocation Properties of this reservation.
resourceStatus.specificSkuAllocation.sourceInstanceTemplateId

string

ID of the instance template used to populate reservation properties.

Union field type.

type can be only one of the following:
specificReservation

object

Reservation for instances with specific machine shapes.
specificReservation.instanceProperties

object

The instance properties for the reservation.
specificReservation.instanceProperties.machineType

string

Specifies type of machine (name only) which has fixed number of vCPUs and fixed amount of memory. This also includes specifying custom machine type following custom-NUMBER_OF_CPUS-AMOUNT_OF_MEMORY pattern.
specificReservation.instanceProperties.guestAccelerators[]

object

Specifies accelerator type and count.
specificReservation.instanceProperties.guestAccelerators[].acceleratorType

string

Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types.
specificReservation.instanceProperties.guestAccelerators[].acceleratorCount

integer

The number of the guest accelerator cards exposed to this instance.
specificReservation.instanceProperties.minCpuPlatform

string

Minimum cpu platform the reservation.
specificReservation.instanceProperties.localSsds[]

object

Specifies amount of local ssd to reserve with each instance. The type of disk is local-ssd.
specificReservation.instanceProperties.localSsds[].diskSizeGb

string (int64 format)

Specifies the size of the disk in base-2 GB.
specificReservation.instanceProperties.localSsds[].interface

enum

Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
specificReservation.instanceProperties.locationHint

string

An opaque location hint used to place the allocation close to other resources. This field is for use by internal tools that use the public API.
specificReservation.count

string (int64 format)

Specifies the number of resources that are allocated.
specificReservation.inUseCount

string (int64 format)

[Output Only] Indicates how many instances are in use.
specificReservation.assuredCount

string (int64 format)

[Output Only] Indicates how many instances are actually usable currently.
specificReservation.sourceInstanceTemplate

string

Specifies the instance template to create the reservation. If you use this field, you must exclude the instanceProperties field.

This field is optional, and it can be a full or partial URL. For example, the following are all valid URLs to an instance template:

aggregateReservation

object

Reservation for aggregated resources, providing shape flexibility.
aggregateReservation.vmFamily

enum

The VM family that all instances scheduled against this reservation must belong to.
aggregateReservation.reservedResources[]

object

reservations.list of reserved resources (CPUs, memory, accelerators).
aggregateReservation.reservedResources[].accelerator

object

Properties of accelerator resources in this reservation.
aggregateReservation.reservedResources[].accelerator.acceleratorCount

integer

Number of accelerators of specified type.
aggregateReservation.reservedResources[].accelerator.acceleratorType

string

Full or partial URL to accelerator type. e.g. "projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l"
aggregateReservation.inUseResources[]

object

[Output only] reservations.list of resources currently in use.
aggregateReservation.inUseResources[].accelerator

object

Properties of accelerator resources in this reservation.
aggregateReservation.inUseResources[].accelerator.acceleratorCount

integer

Number of accelerators of specified type.
aggregateReservation.inUseResources[].accelerator.acceleratorType

string

Full or partial URL to accelerator type. e.g. "projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l"
aggregateReservation.workloadType

enum

The workload type of the instances that will target this reservation.

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

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