Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-131,0021,0174.3 MB
reservations

Creates a new reservation. For more information, readReserving zonal resources.

post/projects/{project}/zones/{zone}/reservations

Path parameters

projectstring required

Project ID for this request.

zonestring required

Name of the zone for this request.

Query parameters

requestIdstring

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Request body

descriptionstring

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

commitmentstring

Output only. [Output Only] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment.

deploymentType'DENSE' | 'DEPLOYMENT_TYPE_UNSPECIFIED'

Specifies the deployment strategy for this reservation.

confidentialComputeType'CONFIDENTIAL_COMPUTE_TYPE_TDX' | 'CONFIDENTIAL_COMPUTE_TYPE_UNSPECIFIED'
kindstring

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

satisfiesPzsboolean

Output only. [Output Only] Reserved for future use.

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

The type of maintenance for the reservation.

linkedCommitmentsstring[]

Output only. [Output Only] Full or partial URL to parent commitments. This field displays for reservations that are tied to multiple commitments.

status'CREATING' | 'DELETING' | 'INVALID' | 'READY' | 'UPDATING'

Output only. [Output Only] The status of the reservation.

 - CREATING: Reservation resources are being
   allocated.
 - READY: Reservation resources have been allocated,
   and the reservation is ready for use.
 - DELETING: Reservation deletion is in progress.
 - UPDATING: Reservation update is in progress.
protectionTier'CAPACITY_OPTIMIZED' | 'PROTECTION_TIER_UNSPECIFIED' | 'STANDARD'

Protection tier for the workload which specifies the workload expectations in the event of infrastructure failures at data center (e.g. power and/or cooling failures).

selfLinkstring

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

deleteAtTimestring

Absolute time in future when the reservation will be auto-deleted by Compute Engine. Timestamp is represented inRFC3339 text format.

earlyAccessMaintenance'NO_EARLY_ACCESS' | 'WAVE1' | 'WAVE2'

Indicates the early access maintenance for the reservation. If this field is absent or set to NO_EARLY_ACCESS, the reservation is not enrolled in early access maintenance and the standard notice applies.

specificReservationRequiredboolean

Indicates whether the 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 this reservation.

creationTimestampstring

Output only. [Output Only] Creation timestamp inRFC3339 text format.

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.

enableEmergentMaintenanceboolean

Indicates whether Compute Engine allows unplanned maintenance for your VMs; for example, to fix hardware errors.

idstring uint64

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

zonestring

Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment.

resourcePoliciesobject

Resource policies to be added to this reservation. The key is defined by user, and the value is resource policy url. This is to define placement policy with reservation.

Response

Successful response