--- title: "PATCH /projects/{project}/zones/{zone}/futureReservations/{futureReservation}" method: PATCH path: "/projects/{project}/zones/{zone}/futureReservations/{futureReservation}" tags: ["futureReservations"] --- # PATCH /projects/{project}/zones/{zone}/futureReservations/{futureReservation} `PATCH /projects/{project}/zones/{zone}/futureReservations/{futureReservation}` Updates the specified future reservation. ## Path parameters - `project` string, required - `zone` string, required - `futureReservation` string, required ## Query parameters - `requestId` string - `updateMask` string ## Request body - FutureReservation - `autoCreatedReservationsDuration` Duration — A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. - `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. - `seconds` string, int64 — 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 - `selfLink` string — Output only. [Output Only] Server-defined fully-qualified URL for this resource. - `schedulingType` 'GROUPED' | 'GROUP_MAINTENANCE_TYPE_UNSPECIFIED' | 'INDEPENDENT' — Maintenance information for this reservation - `reservationName` 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 reservation_name or a name_prefix. - `status` FutureReservationStatus — [Output only] Represents status related to the future reservation. - `autoCreatedReservations` string[] — Output only. Fully qualified urls of the automatically created reservations at start_time. - `amendmentStatus` 'AMENDMENT_APPROVED' | 'AMENDMENT_DECLINED' | 'AMENDMENT_IN_REVIEW' | 'AMENDMENT_STATUS_UNSPECIFIED' — Output only. [Output Only] The current status of the requested amendment. - `existingMatchingUsageInfo` FutureReservationStatusExistingMatchingUsageInfo — [Output Only] Represents the existing matching usage for the future reservation. - `count` string, int64 — Output only. Count to represent min(FR total_count, matching_reserved_capacity+matching_unreserved_instances) - `timestamp` string — Output only. Timestamp when the matching usage was calculated - `lockTime` 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 lock_time is an RFC3339 string. The procurement_status will transition to PROCURING state at this time. - `fulfilledCount` string, int64 — 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. - `specificSkuProperties` FutureReservationStatusSpecificSKUProperties — Properties to be set for the Future Reservation. - `sourceInstanceTemplateId` string — ID of the instance template used to populate the Future Reservation properties. - `lastKnownGoodState` FutureReservationStatusLastKnownGoodState — The state that the future reservation will be reverted to should the amendment be declined. - `existingMatchingUsageInfo` FutureReservationStatusExistingMatchingUsageInfo — [Output Only] Represents the existing matching usage for the future reservation. - `count` string, int64 — Output only. Count to represent min(FR total_count, matching_reserved_capacity+matching_unreserved_instances) - `timestamp` string — Output only. Timestamp when the matching usage was calculated - `namePrefix` string — Output only. [Output Only] The name prefix of the Future Reservation before an amendment was requested. - `description` string — Output only. [Output Only] The description of the FutureReservation before an amendment was requested. - `procurementStatus` 'APPROVED' | 'CANCELLED' | 'COMMITTED' | 'DECLINED' | 'DRAFTING' | 'FAILED' | 'FAILED_PARTIALLY_FULFILLED' | 'FULFILLED' | 'PENDING_AMENDMENT_APPROVAL' | 'PENDING_APPROVAL' | 'PROCUREMENT_STATUS_UNSPECIFIED' | 'PROCURING' | 'PROVISIONING' — Output only. [Output Only] The status of the last known good state for the Future Reservation. - `futureReservationSpecs` FutureReservationStatusLastKnownGoodStateFutureReservationSpecs — The properties of the last known good state for the Future Reservation. - `shareSettings` ShareSettings — The share setting for reservations and sole tenancy node groups. - `shareType` 'LOCAL' | 'ORGANIZATION' | 'SHARE_TYPE_UNSPECIFIED' | 'SPECIFIC_PROJECTS' — Type of sharing for this shared-reservation - `projectMap` object — A map of project id and project config. This is only valid when share_type's value is SPECIFIC_PROJECTS. - `timeWindow` FutureReservationTimeWindow - `startTime` string — Start time of the Future Reservation. The start_time is an RFC3339 string. - `endTime` string - `duration` Duration — A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. - `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. - `seconds` string, int64 — 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 - `specificSkuProperties` FutureReservationSpecificSKUProperties - `totalCount` string, int64 — Total number of instances for which capacity assurance is requested at a future time period. - `instanceProperties` AllocationSpecificSKUAllocationReservedInstanceProperties — Properties of the SKU instances being reserved. Next ID: 10 - `localSsds` AllocationSpecificSKUAllocationAllocatedInstancePropertiesReservedDisk[] — Specifies amount of local ssd to reserve with each instance. The type of disk is local-ssd. - … - `minCpuPlatform` string — Minimum cpu platform the reservation. - `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. - `guestAccelerators` AcceleratorConfig[] — Specifies accelerator type and count. - … - `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. - `sourceInstanceTemplate` string — The instance template that will be used to populate the ReservedInstanceProperties of the future reservation - `lockTime` string — Output only. [Output Only] The lock time of the FutureReservation before an amendment was requested. - `procurementStatus` 'APPROVED' | 'CANCELLED' | 'COMMITTED' | 'DECLINED' | 'DRAFTING' | 'FAILED' | 'FAILED_PARTIALLY_FULFILLED' | 'FULFILLED' | 'PENDING_AMENDMENT_APPROVAL' | 'PENDING_APPROVAL' | 'PROCUREMENT_STATUS_UNSPECIFIED' | 'PROCURING' | 'PROVISIONING' — Output only. Current state of this Future Reservation - `selfLinkWithId` string — Output only. [Output Only] Server-defined URL for this resource with the resource id. - `kind` string — Output only. [Output Only] Type of the resource. Alwayscompute#futureReservation for future reservations. - `commitmentInfo` FutureReservationCommitmentInfo - `commitmentPlan` 'INVALID' | 'THIRTY_SIX_MONTH' | 'TWELVE_MONTH' — 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. - `previousCommitmentTerms` 'EXTEND' | 'PREVIOUSCOMMITMENTTERM_UNSPECIFIED' — 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. - `commitmentName` string — name of the commitment where capacity is being delivered to. - `shareSettings` ShareSettings — The share setting for reservations and sole tenancy node groups. - `shareType` 'LOCAL' | 'ORGANIZATION' | 'SHARE_TYPE_UNSPECIFIED' | 'SPECIFIC_PROJECTS' — Type of sharing for this shared-reservation - `projectMap` object — A map of project id and project config. This is only valid when share_type's value is SPECIFIC_PROJECTS. - `description` string — An optional description of this resource. Provide this property when you create the future reservation. - `deploymentType` 'DENSE' | 'DEPLOYMENT_TYPE_UNSPECIFIED' — Type of the deployment requested as part of future reservation. - `confidentialComputeType` 'CONFIDENTIAL_COMPUTE_TYPE_TDX' | 'CONFIDENTIAL_COMPUTE_TYPE_UNSPECIFIED' - `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-####. - `specificSkuProperties` FutureReservationSpecificSKUProperties - `totalCount` string, int64 — Total number of instances for which capacity assurance is requested at a future time period. - `instanceProperties` AllocationSpecificSKUAllocationReservedInstanceProperties — Properties of the SKU instances being reserved. Next ID: 10 - `localSsds` AllocationSpecificSKUAllocationAllocatedInstancePropertiesReservedDisk[] — Specifies amount of local ssd to reserve with each instance. The type of disk is local-ssd. - `diskSizeGb` string, int64 — Specifies the size of the disk in base-2 GB. - `interface` 'NVME' | 'SCSI' — Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default isSCSI. For performance characteristics of SCSI over NVMe, seeLocal SSD performance. - `minCpuPlatform` string — Minimum cpu platform the reservation. - `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. - `guestAccelerators` AcceleratorConfig[] — Specifies accelerator type and count. - `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. - `acceleratorCount` integer — The number of the guest accelerator cards exposed to this instance. - `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. - `sourceInstanceTemplate` string — The instance template that will be used to populate the ReservedInstanceProperties of the future reservation - `zone` string — Output only. [Output Only] URL of the Zone where this future reservation resides. - `planningStatus` 'DRAFT' | 'PLANNING_STATUS_UNSPECIFIED' | 'SUBMITTED' — Planning state before being submitted for evaluation - `params` FutureReservationParams — Additional future reservation params. - `resourceManagerTags` object — 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|project_id}/{tag_key_short_name}` and `{tag_value_short_name}`. The field is ignored (both PUT & PATCH) when empty. - `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 [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. - `id` string, uint64 — Output only. [Output Only] A unique identifier for this future reservation. The server defines this identifier. - `timeWindow` FutureReservationTimeWindow - `startTime` string — Start time of the Future Reservation. The start_time is an RFC3339 string. - `endTime` string - `duration` Duration — A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. - `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. - `seconds` string, int64 — 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 - `aggregateReservation` AllocationAggregateReservation — This reservation type is specified by total resource amounts (e.g. total count of CPUs) and can account for multiple instance SKUs. In other words, one can create instances of varying shapes against this reservation. - `reservedResources` AllocationAggregateReservationReservedResourceInfo[] — List of reserved resources (CPUs, memory, accelerators). - `accelerator` AllocationAggregateReservationReservedResourceInfoAccelerator - `acceleratorType` string — Full or partial URL to accelerator type. e.g. "projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l" - `acceleratorCount` integer — Number of accelerators of specified type. - `inUseResources` AllocationAggregateReservationReservedResourceInfo[] — Output only. [Output only] List of resources currently in use. - `accelerator` AllocationAggregateReservationReservedResourceInfoAccelerator - `acceleratorType` string — Full or partial URL to accelerator type. e.g. "projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l" - `acceleratorCount` integer — Number of accelerators of specified type. - `workloadType` 'BATCH' | 'SERVING' | 'UNSPECIFIED' — The workload type of the instances that will target this reservation. - `vmFamily` 'VM_FAMILY_CLOUD_TPU_DEVICE_CT3' | 'VM_FAMILY_CLOUD_TPU_LITE_DEVICE_CT5L' | 'VM_FAMILY_CLOUD_TPU_LITE_POD_SLICE_CT5LP' | 'VM_FAMILY_CLOUD_TPU_LITE_POD_SLICE_CT6E' | 'VM_FAMILY_CLOUD_TPU_POD_SLICE_CT3P' | 'VM_FAMILY_CLOUD_TPU_POD_SLICE_CT4P' | 'VM_FAMILY_CLOUD_TPU_POD_SLICE_CT5P' | 'VM_FAMILY_CLOUD_TPU_POD_SLICE_TPU7X' — The VM family that all instances scheduled against this reservation must belong to. - `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 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. - `enableEmergentMaintenance` boolean — Indicates if this group of VMs have emergent maintenance enabled. - `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. - `reservationMode` 'CALENDAR' | 'DEFAULT' | 'RESERVATION_MODE_UNSPECIFIED' — The reservation mode which determines reservation-termination behavior and expected pricing. - `specificReservationRequired` 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. - `creationTimestamp` string — Output only. [Output Only] The creation timestamp for this future reservation inRFC3339 text format. ## Response `200` Successful response --- [API](https://skmtc.net/google/apis/compute.md) · [All operations](https://skmtc.net/google/apis/compute/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/google/compute/revisions/6120ed8969d4/schema)