GOgoogle
reservations

GET /projects/{project}/zones/{zone}/reservations/{reservation}

Changed on

Retrieves information about the specified reservation.

Request

  • Base URL
    https://compute.googleapis.com/compute/v1
  • URL
    https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/reservations/{reservation}
  • Auth
    • OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/cloud-platform
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/cloud-platform
    • or OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/compute
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/compute
    • or OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/compute.readonly
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/compute.readonly

Path parameters

projectstring required

Project ID for this request.

zonestring required

Name of the zone for this request.

reservationstring required

Name of the reservation to retrieve.

Response

Successful response

commitmentstring

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

confidentialComputeType'CONFIDENTIAL_COMPUTE_TYPE_BMSAI' | 'CONFIDENTIAL_COMPUTE_TYPE_TDX' | 'CONFIDENTIAL_COMPUTE_TYPE_UNSPECIFIED'
creationTimestampstring

Output only. [Output Only] Creation timestamp inRFC3339 text format.

deleteAtTimestring

Absolute time in future when the reservation will be auto-deleted by Compute Engine. Timestamp is represented inRFC3339 text format.

deploymentType'DENSE' | 'DEPLOYMENT_TYPE_UNSPECIFIED'

Specifies the deployment strategy for this reservation.

descriptionstring

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

earlyAccessMaintenance'NO_EARLY_ACCESS' | 'WAVE1' | 'WAVE2'

Indicates the early access maintenance for the reservation. If this field is absent or set to NO_EARLY_ACCESS, the reservation is not enrolled in early access maintenance and the standard notice applies.

enableEmergentMaintenanceboolean

Indicates whether Compute Engine allows unplanned maintenance for your VMs; for example, to fix hardware errors.

idstring uint64

Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server.

kindstring

Output only. [Output Only] Type of the resource. Alwayscompute#reservations for reservations.

linkedCommitmentsstring[]

Output only. [Output Only] Full or partial URL to parent commitments. This field displays for reservations that are tied to multiple commitments.

namestring

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

protectionTier'CAPACITY_OPTIMIZED' | 'PROTECTION_TIER_UNSPECIFIED' | 'STANDARD'

Protection tier for the workload which specifies the workload expectations in the event of infrastructure failures at data center (e.g. power and/or cooling failures).

resourcePoliciesobject

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.

satisfiesPzsboolean

Output only. [Output Only] Reserved for future use.

schedulingType'GROUPED' | 'GROUP_MAINTENANCE_TYPE_UNSPECIFIED' | 'INDEPENDENT'

The type of maintenance for the reservation.

selfLinkstring

Output only. [Output Only] Server-defined fully-qualified URL for this resource.

specificReservationRequiredboolean

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'CREATING' | 'DELETING' | 'INVALID' | 'READY' | 'UPDATING'

Output only. [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.
zonestring

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

Changes

  • 8b85e897d3dcRevision changes
    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/compute.readonly was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/compute.readonly was removed from the endpoint's security scheme Oauth2c

  • 48929bf89eebRevision changes
    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/compute.readonly was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/compute.readonly was removed from the endpoint's security scheme Oauth2c