Method: futureReservations.list

A list of all the future reservations that have been configured for the specified project in specified zone.

HTTP request

GET https://compute.googleapis.com/compute/beta/projects/{project}/zones/{zone}/futureReservations

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. Name should conform to RFC1035.

Query parameters

Parameters
maxResults

integer (uint32 format)

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)
pageToken

string

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter

string

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request.

If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either =, !=, >, <, <=, >= or :.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use:

labels.owner:*

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example:

(scheduling.automaticRestart = true)
(cpuPlatform = "Intel Skylake")

By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example:

(cpuPlatform = "Intel Skylake") OR
(cpuPlatform = "Intel Broadwell") AND
(scheduling.automaticRestart = true)

If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples:

fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal")

The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field.

For example, to filter for instances that do not end with name "instance", you would use name ne .*instance.

You cannot combine constraints on multiple fields using regular expressions.
orderBy

string

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
returnPartialSuccess

boolean

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

Request body

The request body must be empty.

Response body

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

JSON representation 
{
  "kind": string,
  "id": string,
  "items": [
    {
      "kind": string,
      "id": string,
      "creationTimestamp": string,
      "selfLink": string,
      "selfLinkWithId": string,
      "zone": string,
      "description": string,
      "name": string,
      "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
          },
          ...
        }
      },
      "namePrefix": string,
      "status": {
        "procurementStatus": enum,
        "lockTime": string,
        "autoCreatedReservations": [
          string
        ],
        "fulfilledCount": string,
        "specificSkuProperties": {
          "sourceInstanceTemplateId": string
        },
        "amendmentStatus": enum,
        "lastKnownGoodState": {
          "futureReservationSpecs": {
            "timeWindow": {
              "startTime": string,
              "endTime": string,
              "duration": {
                "seconds": string,
                "nanos": integer
              }
            },
            "shareSettings": {
              "shareType": enum,
              "projects": [
                string
              ],
              "projectMap": {
                string: {
                  "projectId": string
                },
                ...
              }
            },

            // 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
            }
            // End of list of possible types for union field type.
          },
          "procurementStatus": enum,
          "namePrefix": string,
          "description": string,
          "lockTime": string,
          "existingMatchingUsageInfo": {
            "count": string,
            "timestamp": string
          }
        },
        "existingMatchingUsageInfo": {
          "count": string,
          "timestamp": string
        }
      },
      "planningStatus": enum,
      "autoCreatedReservationsDeleteTime": string,
      "autoCreatedReservationsDuration": {
        "seconds": string,
        "nanos": integer
      },
      "autoDeleteAutoCreatedReservations": boolean
    }
  ],
  "nextPageToken": string,
  "warning": {
    "code": enum,
    "message": string,
    "data": [
      {
        "key": string,
        "value": string
      }
    ]
  },
  "selfLink": string,
  "etag": string,
  "unreachables": [
    string
  ]
}
Fields
kind

string

[Output Only] Type of resource.Always compute#FutureReservationsListResponse for lists of reservations
id

string

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

object

[Output Only] A list of future reservation resources.
items[].kind

string

[Output Only] Type of the resource. Always compute#futureReservation for future reservations.
items[].id

string (uint64 format)

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

string

[Output Only] The creation timestamp for this future reservation in RFC3339 text format.
items[].selfLink

string

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

string

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

string

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

string

An optional description of this resource. Provide this property when you create the future reservation.
items[].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.
items[].specificSkuProperties

object

Future Reservation configuration to indicate instance properties and total count.
items[].specificSkuProperties.instanceProperties

object

Properties of the SKU instances being reserved.
items[].specificSkuProperties.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.
items[].specificSkuProperties.instanceProperties.guestAccelerators[]

object

Specifies accelerator type and count.
items[].specificSkuProperties.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.
items[].specificSkuProperties.instanceProperties.guestAccelerators[].acceleratorCount

integer

The number of the guest accelerator cards exposed to this instance.
items[].specificSkuProperties.instanceProperties.minCpuPlatform

string

Minimum cpu platform the reservation.
items[].specificSkuProperties.instanceProperties.localSsds[]

object

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

string (int64 format)

Specifies the size of the disk in base-2 GB.
items[].specificSkuProperties.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.
items[].specificSkuProperties.instanceProperties.maintenanceFreezeDurationHours

integer

Specifies the number of hours after reservation creation where instances using the reservation won't be scheduled for maintenance.
items[].specificSkuProperties.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.
items[].specificSkuProperties.instanceProperties.maintenanceInterval

enum

Specifies the frequency of planned maintenance events. The accepted values are: PERIODIC.
items[].specificSkuProperties.totalCount

string (int64 format)

Total number of instances for which capacity assurance is requested at a future time period.
items[].specificSkuProperties.sourceInstanceTemplate

string

The instance template that will be used to populate the ReservedInstanceProperties of the future reservation
items[].timeWindow

object

Time window for this Future Reservation.
items[].timeWindow.startTime

string

Start time of the Future Reservation. The startTime is an RFC3339 string.
items[].timeWindow.endTime

string
items[].timeWindow.duration

object
items[].timeWindow.duration.seconds

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
items[].timeWindow.duration.nanos

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.
items[].shareSettings

object

futureReservations.list of Projects/Folders to share with.
items[].shareSettings.shareType

enum

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

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.
items[].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.
items[].shareSettings.projectMap[].projectId

string

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

string

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-####.
items[].status

object

[Output only] Status of the Future Reservation
items[].status.procurementStatus

enum

Current state of this Future Reservation
items[].status.lockTime

string

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.
items[].status.autoCreatedReservations[]

string

Fully qualified urls of the automatically created reservations at startTime.
items[].status.fulfilledCount

string (int64 format)

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.
items[].status.specificSkuProperties

object
items[].status.specificSkuProperties.sourceInstanceTemplateId

string

ID of the instance template used to populate the Future Reservation properties.
items[].status.amendmentStatus

enum

[Output Only] The current status of the requested amendment.
items[].status.lastKnownGoodState

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.
items[].status.lastKnownGoodState.futureReservationSpecs

object
items[].status.lastKnownGoodState.futureReservationSpecs.specificSkuProperties

object

[Output Only] The previous instance related properties of the Future Reservation.
items[].status.lastKnownGoodState.futureReservationSpecs.specificSkuProperties.instanceProperties

object

Properties of the SKU instances being reserved.
items[].status.lastKnownGoodState.futureReservationSpecs.specificSkuProperties.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.
items[].status.lastKnownGoodState.futureReservationSpecs.specificSkuProperties.instanceProperties.guestAccelerators[]

object

Specifies accelerator type and count.
items[].status.lastKnownGoodState.futureReservationSpecs.specificSkuProperties.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.
items[].status.lastKnownGoodState.futureReservationSpecs.specificSkuProperties.instanceProperties.guestAccelerators[].acceleratorCount

integer

The number of the guest accelerator cards exposed to this instance.
items[].status.lastKnownGoodState.futureReservationSpecs.specificSkuProperties.instanceProperties.minCpuPlatform

string

Minimum cpu platform the reservation.
items[].status.lastKnownGoodState.futureReservationSpecs.specificSkuProperties.instanceProperties.localSsds[]

object

Specifies amount of local ssd to reserve with each instance. The type of disk is local-ssd.
items[].status.lastKnownGoodState.futureReservationSpecs.specificSkuProperties.instanceProperties.localSsds[].diskSizeGb

string (int64 format)

Specifies the size of the disk in base-2 GB.
items[].status.lastKnownGoodState.futureReservationSpecs.specificSkuProperties.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.
items[].status.lastKnownGoodState.futureReservationSpecs.specificSkuProperties.instanceProperties.maintenanceFreezeDurationHours

integer

Specifies the number of hours after reservation creation where instances using the reservation won't be scheduled for maintenance.
items[].status.lastKnownGoodState.futureReservationSpecs.specificSkuProperties.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.
items[].status.lastKnownGoodState.futureReservationSpecs.specificSkuProperties.instanceProperties.maintenanceInterval

enum

Specifies the frequency of planned maintenance events. The accepted values are: PERIODIC.
items[].status.lastKnownGoodState.futureReservationSpecs.specificSkuProperties.totalCount

string (int64 format)

Total number of instances for which capacity assurance is requested at a future time period.
items[].status.lastKnownGoodState.futureReservationSpecs.specificSkuProperties.sourceInstanceTemplate

string

The instance template that will be used to populate the ReservedInstanceProperties of the future reservation
items[].status.lastKnownGoodState.futureReservationSpecs.timeWindow

object

[Output Only] The previous time window of the Future Reservation.
items[].status.lastKnownGoodState.futureReservationSpecs.timeWindow.startTime

string

Start time of the Future Reservation. The startTime is an RFC3339 string.
items[].status.lastKnownGoodState.futureReservationSpecs.timeWindow.endTime

string
items[].status.lastKnownGoodState.futureReservationSpecs.timeWindow.duration

object
items[].status.lastKnownGoodState.futureReservationSpecs.timeWindow.duration.seconds

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
items[].status.lastKnownGoodState.futureReservationSpecs.timeWindow.duration.nanos

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.
items[].status.lastKnownGoodState.futureReservationSpecs.shareSettings

object

[Output Only] The previous share settings of the Future Reservation.
items[].status.lastKnownGoodState.futureReservationSpecs.shareSettings.shareType

enum

Type of sharing for this shared-reservation
items[].status.lastKnownGoodState.futureReservationSpecs.shareSettings.projects[]

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.
items[].status.lastKnownGoodState.futureReservationSpecs.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.
items[].status.lastKnownGoodState.futureReservationSpecs.shareSettings.projectMap[].projectId

string

The project ID, should be same as the key of this project config in the parent map.
items[].status.lastKnownGoodState.procurementStatus

enum

[Output Only] The status of the last known good state for the Future Reservation.
items[].status.lastKnownGoodState.namePrefix

string

[Output Only] The name prefix of the Future Reservation before an amendment was requested.
items[].status.lastKnownGoodState.description

string

[Output Only] The description of the FutureReservation before an amendment was requested.
items[].status.lastKnownGoodState.lockTime

string

[Output Only] The lock time of the FutureReservation before an amendment was requested.
items[].status.lastKnownGoodState.existingMatchingUsageInfo

object

[Output Only] Represents the matching usage for the future reservation before an amendment was requested.
items[].status.lastKnownGoodState.existingMatchingUsageInfo.count

string (int64 format)

Count to represent min(FR totalCount, matching_reserved_capacity+matching_unreserved_instances)
items[].status.lastKnownGoodState.existingMatchingUsageInfo.timestamp

string

Timestamp when the matching usage was calculated
items[].status.existingMatchingUsageInfo

object

[Output Only] Represents the existing matching usage for the future reservation.
items[].status.existingMatchingUsageInfo.count

string (int64 format)

Count to represent min(FR totalCount, matching_reserved_capacity+matching_unreserved_instances)
items[].status.existingMatchingUsageInfo.timestamp

string

Timestamp when the matching usage was calculated
items[].planningStatus

enum

Planning state before being submitted for evaluation
items[].autoCreatedReservationsDeleteTime

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.
items[].autoCreatedReservationsDuration

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.
items[].autoCreatedReservationsDuration.seconds

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
items[].autoCreatedReservationsDuration.nanos

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.
items[].autoDeleteAutoCreatedReservations

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

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
warning

object

[Output Only] Informational warning message.
warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
warning.message

string

[Output Only] A human-readable description of the warning code.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: 

"data": [  {  "key": "scope",  "value": "zones/us-east1-d"  }
warning.data[].key

string

[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
warning.data[].value

string

[Output Only] A warning data value corresponding to the key.
etag

string
unreachables[]

string

[Output Only] Unreachable resources.

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.futureReservations.list

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