get_reservation_details
Read-onlyIdempotent
Get Compute Engine reservation details. Returns reservation details including name, ID, status, creation timestamp, specific reservation properties like machine type, guest accelerators and local SSDs, aggregate reservation properties like VM family and reserved resources, commitment and linked commitments, sharing settings, and resource status. Requires project, zone, and reservation name as input.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Required. Identifier. Name of the reservation to retrieve. | |
| zone | Yes | Required. The zone of the reservation. | |
| project | Yes | Required. Project ID for this request. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server. | |
| kind | No | Output only. [Output Only] Type of the resource. Always compute#reservations for reservations. | compute#reservation |
| name | No | 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 <https://www.ietf.org/rfc/rfc1035.txt>. 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. | |
| zone | No | Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment. | |
| params | No | Input only. Additional params passed with the request, but not persisted as part of resource payload. | |
| status | No | 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. | |
| selfLink | No | Output only. [Output Only] Server-defined fully-qualified URL for this resource. | |
| commitment | No | Output only. [Output Only] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment. | |
| description | No | An optional description of this resource. Provide this property when you create the resource. | |
| deleteAtTime | No | Absolute time in future when the reservation will be auto-deleted by Compute Engine. Timestamp is represented in RFC3339 <https://www.ietf.org/rfc/rfc3339.txt> text format. Only one of this field or deleteAfterDuration should be set. | |
| satisfiesPzs | No | Output only. [Output Only] Reserved for future use. | |
| shareSettings | No | Specify share-settings to create a shared reservation. This property is optional. For more information about the syntax and options for this field and its subfields, see the guide for creating a shared reservation. <https://cloud.google.com/compute/docs/instances/reservations-shared#creating_a_shared_reservation> | |
| deploymentType | No | Specifies the deployment strategy for this reservation. | |
| protectionTier | No | 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). | |
| resourceStatus | No | Output only. [Output Only] Status information for Reservation resource. | |
| schedulingType | No | The type of maintenance for the reservation. | |
| resourceMetadata | No | Output only. [Output Only] Contains standard resource metadata for an Allocation resource. It is populated for each instance of the Allocation resource, and includes the api_version the instance was retrieved through, and its canonical resource_type name. | |
| resourcePolicies | No | 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. | |
| creationTimestamp | No | Output only. [Output Only] Creation timestamp in RFC3339 <https://www.ietf.org/rfc/rfc3339.txt> text format. | |
| linkedCommitments | No | Output only. [Output Only] Full or partial URL to parent commitments. This field displays for reservations that are tied to multiple commitments. | |
| deleteAfterDuration | No | Duration time relative to reservation creation when Compute Engine will automatically delete this resource. Only one of this field or deleteAtTime should be set. | |
| specificReservation | No | Reservation for instances with specific machine shapes. Only one of this field or aggregateReservation should be set. | |
| aggregateReservation | No | Reservation for aggregated resources, providing shape flexibility. Only one of this field or specificReservation should be set. | |
| earlyAccessMaintenance | No | 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. | |
| confidentialComputeType | No | ||
| reservationSharingPolicy | No | Specify the reservation sharing policy. If unspecified, the reservation will not be shared with Google Cloud managed services. | |
| advancedDeploymentControl | No | Advanced control for cluster management, applicable only to DENSE deployment type reservations. | |
| enableEmergentMaintenance | No | Indicates whether Compute Engine allows unplanned maintenance for your VMs; for example, to fix hardware errors. | |
| specificReservationRequired | No | 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. |