GOgoogle
futureReservations

GET /projects/{project}/zones/{zone}/futureReservations/{futureReservation}

Changed on

Retrieves information about the specified future reservation.

Request

  • Base URL
    https://compute.googleapis.com/compute/v1
  • URL
    https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/futureReservations/{futureReservation}
  • 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. Name should conform to RFC1035.

futureReservationstring required

Name of the future reservation to retrieve. Name should conform to RFC1035.

Response

Successful response

autoCreatedReservationsDeleteTimestring

Future timestamp when the FR auto-created reservations will be deleted by Compute Engine. Format of this field must be a valid href="https://www.ietf.org/rfc/rfc3339.txt">RFC3339 value.

autoDeleteAutoCreatedReservationsboolean

Setting for enabling or disabling automatic deletion for auto-created reservation. If set to true, auto-created reservations will be deleted at Future Reservation's end time (default) or at user's defined timestamp if any of the [auto_created_reservations_delete_time, auto_created_reservations_duration] values is specified. For keeping auto-created reservation indefinitely, this value should be set to false.

colocationResourcestring

Full or partial URL of an existing future reservation to indicate intent for reserving capacity in the same cluster as the colocation resource.

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

Output only. [Output Only] The creation timestamp for this future reservation inRFC3339 text format.

deploymentType'DENSE' | 'DEPLOYMENT_TYPE_UNSPECIFIED'

Type of the deployment requested as part of future reservation.

descriptionstring

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

enableEmergentMaintenanceboolean

Indicates if this group of VMs have emergent maintenance enabled.

idstring uint64

Output only. [Output Only] A unique identifier for this future reservation. The server defines this identifier.

kindstring

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

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.

namePrefixstring

Name prefix for the reservations to be created at the time of delivery. The name prefix must comply with RFC1035. Maximum allowed length for name prefix is 20. Automatically created reservations name format will be -date-####.

planningStatus'DRAFT' | 'PLANNING_STATUS_UNSPECIFIED' | 'SUBMITTED'

Planning state before being submitted for evaluation

reservationMode'CALENDAR' | 'DEFAULT' | 'RESERVATION_MODE_UNSPECIFIED'

The reservation mode which determines reservation-termination behavior and expected pricing.

reservationNamestring

Name of reservations where the capacity is provisioned at the time of delivery of future reservations. If the reservation with the given name does not exist already, it is created automatically at the time of Approval with INACTIVE state till specified start-time. Either provide the reservation_name or a name_prefix.

resourceNamestring

Name of the resource intended to be delivered. Name should conform to RFC1035. This will be the name of storage pool or Exapool for persistent disk FRs.

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

Maintenance information for this reservation

selfLinkstring

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

selfLinkWithIdstring

Output only. [Output Only] Server-defined URL for this resource with the resource id.

specificReservationRequiredboolean

Indicates whether the auto-created 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 the delivered reservation.

zonestring

Output only. [Output Only] URL of the Zone where this future reservation resides.

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