- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Try it!
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 |
Project ID for this request. |
zone |
Name of the zone for this request. Name should conform to RFC1035. |
Query parameters
Parameters | |
---|---|
max |
The maximum number of results per page that should be returned. If the number of available results is larger than |
page |
Specifies a page token to use. Set |
filter |
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 For example, if you are filtering Compute Engine instances, you can exclude instances named The
You can also filter nested fields. For example, you could specify To filter on multiple expressions, provide each separate expression within parentheses. For example:
By default, each expression is an
If you want to use a regular expression, use the
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 You cannot combine constraints on multiple fields using regular expressions. |
order |
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 Currently, only sorting by |
return |
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 |
Fields | |
---|---|
kind |
[Output Only] Type of resource.Always |
id |
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
items[] |
[Output Only] A list of future reservation resources. |
items[]. |
[Output Only] Type of the resource. Always |
items[]. |
[Output Only] A unique identifier for this future reservation. The server defines this identifier. |
items[]. |
[Output Only] The creation timestamp for this future reservation in RFC3339 text format. |
items[]. |
[Output Only] Server-defined fully-qualified URL for this resource. |
items[]. |
[Output Only] Server-defined URL for this resource with the resource id. |
items[]. |
[Output Only] URL of the Zone where this future reservation resides. |
items[]. |
An optional description of this resource. Provide this property when you create the future reservation. |
items[]. |
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 |
items[]. |
Future Reservation configuration to indicate instance properties and total count. |
items[]. |
Properties of the SKU instances being reserved. |
items[]. |
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[]. |
Specifies accelerator type and count. |
items[]. |
Full or partial URL of the accelerator type resource to attach to this instance. For example: |
items[]. |
The number of the guest accelerator cards exposed to this instance. |
items[]. |
Minimum cpu platform the reservation. |
items[]. |
Specifies amount of local ssd to reserve with each instance. The type of disk is local-ssd. |
items[]. |
Specifies the size of the disk in base-2 GB. |
items[]. |
Specifies the disk interface to use for attaching this disk, which is either |
items[]. |
Specifies the number of hours after reservation creation where instances using the reservation won't be scheduled for maintenance. |
items[]. |
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[]. |
Specifies the frequency of planned maintenance events. The accepted values are: |
items[]. |
Total number of instances for which capacity assurance is requested at a future time period. |
items[]. |
The instance template that will be used to populate the ReservedInstanceProperties of the future reservation |
items[]. |
Time window for this Future Reservation. |
items[]. |
Start time of the Future Reservation. The startTime is an RFC3339 string. |
items[]. |
|
items[]. |
|
items[]. |
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[]. |
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 |
items[]. |
futureReservations.list of Projects/Folders to share with. |
items[]. |
Type of sharing for this shared-reservation |
items[]. |
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[]. |
A map of project id and project config. This is only valid when shareType's value is SPECIFIC_PROJECTS. |
items[]. |
The project ID, should be same as the key of this project config in the parent map. |
items[]. |
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 |
items[]. |
[Output only] Status of the Future Reservation |
items[]. |
Current state of this Future Reservation |
items[]. |
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[]. |
Fully qualified urls of the automatically created reservations at startTime. |
items[]. |
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[]. |
|
items[]. |
ID of the instance template used to populate the Future Reservation properties. |
items[]. |
[Output Only] The current status of the requested amendment. |
items[]. |
[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[]. |
|
items[]. |
[Output Only] The previous instance related properties of the Future Reservation. |
items[]. |
Properties of the SKU instances being reserved. |
items[]. |
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[]. |
Specifies accelerator type and count. |
items[]. |
Full or partial URL of the accelerator type resource to attach to this instance. For example: |
items[]. |
The number of the guest accelerator cards exposed to this instance. |
items[]. |
Minimum cpu platform the reservation. |
items[]. |
Specifies amount of local ssd to reserve with each instance. The type of disk is local-ssd. |
items[]. |
Specifies the size of the disk in base-2 GB. |
items[]. |
Specifies the disk interface to use for attaching this disk, which is either |
items[]. |
Specifies the number of hours after reservation creation where instances using the reservation won't be scheduled for maintenance. |
items[]. |
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[]. |
Specifies the frequency of planned maintenance events. The accepted values are: |
items[]. |
Total number of instances for which capacity assurance is requested at a future time period. |
items[]. |
The instance template that will be used to populate the ReservedInstanceProperties of the future reservation |
items[]. |
[Output Only] The previous time window of the Future Reservation. |
items[]. |
Start time of the Future Reservation. The startTime is an RFC3339 string. |
items[]. |
|
items[]. |
|
items[]. |
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[]. |
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 |
items[]. |
[Output Only] The previous share settings of the Future Reservation. |
items[]. |
Type of sharing for this shared-reservation |
items[]. |
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[]. |
A map of project id and project config. This is only valid when shareType's value is SPECIFIC_PROJECTS. |
items[]. |
The project ID, should be same as the key of this project config in the parent map. |
items[]. |
[Output Only] The status of the last known good state for the Future Reservation. |
items[]. |
[Output Only] The name prefix of the Future Reservation before an amendment was requested. |
items[]. |
[Output Only] The description of the FutureReservation before an amendment was requested. |
items[]. |
[Output Only] The lock time of the FutureReservation before an amendment was requested. |
items[]. |
[Output Only] Represents the matching usage for the future reservation before an amendment was requested. |
items[]. |
Count to represent min(FR totalCount, matching_reserved_capacity+matching_unreserved_instances) |
items[]. |
Timestamp when the matching usage was calculated |
items[]. |
[Output Only] Represents the existing matching usage for the future reservation. |
items[]. |
Count to represent min(FR totalCount, matching_reserved_capacity+matching_unreserved_instances) |
items[]. |
Timestamp when the matching usage was calculated |
items[]. |
Planning state before being submitted for evaluation |
items[]. |
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[]. |
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[]. |
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[]. |
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 |
items[]. |
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. |
items[]. |
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. |
items[]. |
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. |
items[]. |
Type of the deployment requested as part of future reservation. |
items[]. |
Action to take during reservation termination. |
items[]. |
Indicates if this group of VMs have opportunistic maintenance enabled. This will be set on the FR by customers, and will be used for reservation and reservation block maintenance . |
items[]. |
Maintenance information for this reservation |
next |
[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than |
warning |
[Output Only] Informational warning message. |
warning. |
[Output Only] A warning code, if applicable. For example, Compute Engine returns |
warning. |
[Output Only] A human-readable description of the warning code. |
warning. |
[Output Only] Metadata about this warning in "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
warning. |
[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 |
warning. |
[Output Only] A warning data value corresponding to the key. |
self |
[Output Only] Server-defined URL for this resource. |
etag |
|
unreachables[] |
[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.