/

Console

• English
• Deutsch
• Español – América Latina
• Français
• Português – Brasil
• 中文 – 简体
• 日本語
• 한국어

Sign in

• Compute Engine

Start free

Method: futureReservations.get

• HTTP request
• Path parameters
• Request body
• Response body
  • JSON representation
    • JSON representation
    • JSON representation
    • JSON representation
      • JSON representation
        • JSON representation
        • JSON representation
      • JSON representation
      • JSON representation
    • JSON representation
    • JSON representation
    • JSON representation
    • JSON representation
• Authorization scopes
• IAM Permissions
• Try it!

Response body

{
  "kind": string,
  "id": string,
  "creationTimestamp": string,
  "selfLink": string,
  "selfLinkWithId": string,
  "zone": string,
  "description": string,
  "name": string,
  "timeWindow": {
    "endTime": string,
    "duration": {
      "seconds": string,
      "nanos": integer
    },
    "startTime": string
  },
  "shareSettings": {
    "shareType": enum,
    "projects": [
      string
    ],
    "projectMap": {
      string: {
        "projectId": string
      },
      ...
    }
  },
  "namePrefix": string,
  "status": {
    "procurementStatus": enum,
    "lockTime": string,
    "autoCreatedReservations": [
      string
    ],
    "fulfilledCount": string,
    "specificSkuProperties": {
      "sourceInstanceTemplateId": string
    },
    "amendmentStatus": enum,
    "lastKnownGoodState": {
      "futureReservationSpecs": {
        "specificSkuProperties": {
          "instanceProperties": {
            "machineType": string,
            "guestAccelerators": [
              {
                "acceleratorType": string,
                "acceleratorCount": integer
              }
            ],
            "minCpuPlatform": string,
            "localSsds": [
              {
                "diskSizeGb": string,
                "interface": enum
              }
            ],
            "maintenanceFreezeDurationHours": integer,
            "locationHint": string,
            "maintenanceInterval": enum
          },
          "totalCount": string,
          "sourceInstanceTemplate": string
        },
        "timeWindow": {
          "startTime": string,

          // Union field time can be only one of the following:
          "endTime": string,
          "duration": {
            "seconds": string,
            "nanos": integer
          }
          // End of list of possible types for union field time.
        },
        "shareSettings": {
          "shareType": enum,
          "projects": [
            string
          ],
          "projectMap": {
            string: {
              "projectId": string
            },
            ...
          }
        }
      },
      "procurementStatus": enum,
      "namePrefix": string,
      "description": string,
      "lockTime": string,
      "existingMatchingUsageInfo": {
        "count": string,
        "timestamp": string
      }
    },
    "existingMatchingUsageInfo": {
      "count": string,
      "timestamp": string
    }
  },
  "planningStatus": enum,
  "autoDeleteAutoCreatedReservations": boolean,
  "specificReservationRequired": boolean,
  "reservationName": string,
  "deploymentType": enum,
  "commitmentInfo": {
    "commitmentPlan": enum,
    "commitmentName": string,
    "previousCommitmentTerms": enum
  },
  "schedulingType": enum,
  "reservationMode": enum,
  "advancedDeploymentControl": {
    "reservationOperationalMode": enum
  },
  "enableEmergentMaintenance": boolean,
  "protectionTier": enum,
  "params": {
    "resourceManagerTags": {
      string: string,
      ...
    }
  },
  "confidentialComputeType": enum,

  // Union field type can be only one of the following:
  "specificSkuProperties": {
    "instanceProperties": {
      "machineType": string,
      "guestAccelerators": [
        {
          "acceleratorType": string,
          "acceleratorCount": integer
        }
      ],
      "minCpuPlatform": string,
      "localSsds": [
        {
          "diskSizeGb": string,
          "interface": enum
        }
      ],
      "maintenanceFreezeDurationHours": integer,
      "locationHint": string,
      "maintenanceInterval": enum
    },
    "totalCount": 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,
    "hostCount": integer,
    "inUseHostCount": integer,
    "inUseInstanceCount": integer
  }
  // End of list of possible types for union field type.

  // Union field auto_delete_auto_created_reservations_time can be only one of
  // the following:
  "autoCreatedReservationsDeleteTime": string,
  "autoCreatedReservationsDuration": {
    "seconds": string,
    "nanos": integer
  }
  // End of list of possible types for union field
  // auto_delete_auto_created_reservations_time.
}

string

Output only. Type of the resource. Always compute#futureReservation for future reservations.

string (uint64 format)

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

string

Output only. The creation timestamp for this future reservation in RFC3339 text format.

string

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

string

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

string

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

string

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

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.

object

Time window for this Future Reservation.

string

object

string (int64 format)

Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

integer

Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.

string

Start time of the Future Reservation. The startTime is an RFC3339 string.

object

futureReservations.list of Projects/Folders to share with.

enum

Type of sharing for this shared-reservation

string

A futureReservations.list of Project names to specify consumer projects for this shared-reservation. This is only valid when shareType's value is SPECIFIC_PROJECTS.

map (key: string, value: object)

A map of project id and project config. This is only valid when shareType's value is SPECIFIC_PROJECTS.

string

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

string

object

Output only. Status of the Future Reservation

enum

Output only. Current state of this Future Reservation

string

Output only. Time when Future Reservation would become LOCKED, after which no modifications to Future Reservation will be allowed. Applicable only after the Future Reservation is in the APPROVED state. The lockTime is an RFC3339 string. The procurementStatus will transition to PROCURING state at this time.

string

Output only. Fully qualified urls of the automatically created reservations at startTime.

string (int64 format)

Output only. This count indicates the fulfilled capacity so far. This is set during "PROVISIONING" state. This count also includes capacity delivered as part of existing matching reservations.

object

string

ID of the instance template used to populate the Future Reservation properties.

enum

Output only. The current status of the requested amendment.

object

Output only. This field represents the future reservation before an amendment was requested. If the amendment is declined, the Future Reservation will be reverted to the last known good state. The last known good state is not set when updating a future reservation whose Procurement Status is DRAFTING.

object

object

Output only. The previous instance related properties of the Future Reservation.

object

Properties of the SKU instances being reserved.

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.

object

Specifies accelerator type and count.

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.

integer

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

string

Minimum cpu platform the reservation.

object

Specifies amount of local ssd to reserve with each instance. The type of disk is local-ssd.

string (int64 format)

Specifies the size of the disk in base-2 GB.

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.

integer

Specifies the number of hours after reservation creation where instances using the reservation won't be scheduled for maintenance.

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.

enum

Specifies the frequency of planned maintenance events. The accepted values are: PERIODIC.

string (int64 format)

Total number of instances for which capacity assurance is requested at a future time period.

string

The instance template that will be used to populate the ReservedInstanceProperties of the future reservation

object

Output only. The previous time window of the Future Reservation.

string

object

string (int64 format)

Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

integer

Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.

string

Start time of the Future Reservation. The startTime is an RFC3339 string.

object

Output only. The previous share settings of the Future Reservation.

enum

Type of sharing for this shared-reservation

string

A futureReservations.list of Project names to specify consumer projects for this shared-reservation. This is only valid when shareType's value is SPECIFIC_PROJECTS.

map (key: string, value: object)

A map of project id and project config. This is only valid when shareType's value is SPECIFIC_PROJECTS.

string

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

enum

Output only. The status of the last known good state for the Future Reservation.

string

Output only. The name prefix of the Future Reservation before an amendment was requested.

string

Output only. The description of the FutureReservation before an amendment was requested.

string

Output only. The lock time of the FutureReservation before an amendment was requested.

object

Output only. Represents the matching usage for the future reservation before an amendment was requested.

string (int64 format)

Output only. Count to represent min(FR totalCount, matching_reserved_capacity+matching_unreserved_instances)

string

Output only. Timestamp when the matching usage was calculated

object

Output only. Represents the existing matching usage for the future reservation.

string (int64 format)

Output only. Count to represent min(FR totalCount, matching_reserved_capacity+matching_unreserved_instances)

string

Output only. Timestamp when the matching usage was calculated

enum

Planning state before being submitted for evaluation

boolean

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 [autoCreatedReservationsDeleteTime, autoCreatedReservationsDuration] values is specified. For keeping auto-created reservation indefinitely, this value should be set to false.

boolean

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.

string

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 reservationName or a namePrefix.

enum

Type of the deployment requested as part of future reservation.

object

If not present, then FR will not deliver a new commitment or update an existing commitment.

enum

Indicates if a Commitment needs to be created as part of FR delivery. If this field is not present, then no commitment needs to be created.

string

name of the commitment where capacity is being delivered to.

enum

Only applicable if FR is delivering to the same reservation. If set, all parent commitments will be extended to match the end date of the plan for this commitment.

enum

Maintenance information for this reservation

enum

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

object

Advanced control for cluster management, applicable only to DENSE deployment type future reservations.

enum

Indicates chosen reservation operational mode for the reservation.

boolean

Indicates if this group of VMs have emergent maintenance enabled.

enum

Protection tier for the workload.

object

Input only. Additional params passed with the request, but not persisted as part of resource payload.

map (key: string, value: string)

Input only. Resource manager tags to be bound to the future reservation. Tag keys and values have the same definition as resource manager tags. Keys and values can be either in numeric format, such as tagKeys/{tag_key_id} and tagValues/{tag_value_id} or in namespaced format such as {org_id|projectId}/{tag_key_short_name} and {tag_value_short_name}. The field is ignored (both PUT & PATCH) when empty.

enum

Union field type.

type can be only one of the following:

object

Future Reservation configuration to indicate instance properties and total count.

object

Properties of the SKU instances being reserved.

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.

object

Specifies accelerator type and count.

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.

integer

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

string

Minimum cpu platform the reservation.

object

Specifies amount of local ssd to reserve with each instance. The type of disk is local-ssd.

string (int64 format)

Specifies the size of the disk in base-2 GB.

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.

integer

Specifies the number of hours after reservation creation where instances using the reservation won't be scheduled for maintenance.

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.

enum

Specifies the frequency of planned maintenance events. The accepted values are: PERIODIC.

string (int64 format)

Total number of instances for which capacity assurance is requested at a future time period.

string

The instance template that will be used to populate the ReservedInstanceProperties of the future reservation

object

Aggregate reservation details for the future reservation.

enum

The VM family that all instances scheduled against this reservation must belong to.

object

futureReservations.list of reserved resources (CPUs, memory, accelerators).

object

Properties of accelerator resources in this reservation.

integer

Number of accelerators of specified type.

string

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

object

Output only. futureReservations.list of resources currently in use.

object

Properties of accelerator resources in this reservation.

integer

Number of accelerators of specified type.

string

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

enum

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

integer

Count of reserved hosts of specified VM family. The host has fixed number of accelerators based on the accelerator/vm-family selected.

integer

Output only. Number of hosts currently in use. If there is one or more Instances running on the host, it is considered in use.

integer

Output only. Number of instances currently in use in this reservation.

Union field auto_delete_auto_created_reservations_time.

auto_delete_auto_created_reservations_time can be only one of the following:

string

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.

object

Specifies the duration of auto-created reservations. It represents relative time to future reservation startTime when auto-created reservations will be automatically deleted by Compute Engine. Duration time unit is represented as a count of seconds and fractions of seconds at nanosecond resolution.

string (int64 format)

Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

integer

Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.