REST Resource: reservations

Resource: Reservation
- JSON representation
Methods

Resource: Reservation

Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources.

JSON representation

JSON representation
{ "kind": string, "id": string, "creationTimestamp": string, "selfLink": string, "zone": string, "description": string, "name": string, "commitment": string, "specificReservationRequired": boolean, "status": enum, "shareSettings": { "shareType": enum, "projects": [ string ], "projectMap": { string: { "projectId": string }, ... } }, "satisfiesPzs": boolean, "resourcePolicies": { string: string, ... }, "resourceStatus": { "specificSkuAllocation": { "sourceInstanceTemplateId": string, "utilizations": { string: string, ... } }, "reservationMaintenance": { "upcomingGroupMaintenance": { "type": enum, "canReschedule": boolean, "windowStartTime": string, "windowEndTime": string, "latestWindowStartTime": string, "maintenanceStatus": enum }, "enableOpportunisticMaintenance": boolean, "maintenanceOngoingCount": integer, "maintenancePendingCount": integer, "schedulingType": enum }, "reservationBlockCount": integer }, "reservationSharingPolicy": { "serviceShareType": enum }, "deploymentType": enum, "instanceTerminationAction": enum, // Union field `type` can be only one of the following: "specificReservation": { "instanceProperties": { "machineType": string, "guestAccelerators": [ { "acceleratorType": string, "acceleratorCount": integer } ], "minCpuPlatform": string, "localSsds": [ { "diskSizeGb": string, "interface": enum } ], "maintenanceFreezeDurationHours": integer, "locationHint": string, "maintenanceInterval": enum }, "count": string, "inUseCount": string, "assuredCount": string, "sourceInstanceTemplate": string }, "aggregateReservation": { "vmFamily": enum, "reservedResources": [ { // Union field `reserved_resource` can be only one of the following: "accelerator": { "acceleratorCount": integer, "acceleratorType": string } // End of list of possible types for union field `reserved_resource`. } ], "inUseResources": [ { // Union field `reserved_resource` can be only one of the following: "accelerator": { "acceleratorCount": integer, "acceleratorType": string } // End of list of possible types for union field `reserved_resource`. } ], "workloadType": enum } // End of list of possible types for union field `type`. // Union field `auto_delete_time` can be only one of the following: "deleteAtTime": string, "deleteAfterDuration": { "seconds": string, "nanos": integer } // End of list of possible types for union field `auto_delete_time`. }

{
  "kind": string,
  "id": string,
  "creationTimestamp": string,
  "selfLink": string,
  "zone": string,
  "description": string,
  "name": string,
  "commitment": string,
  "specificReservationRequired": boolean,
  "status": enum,
  "shareSettings": {
    "shareType": enum,
    "projects": [
      string
    ],
    "projectMap": {
      string: {
        "projectId": string
      },
      ...
    }
  },
  "satisfiesPzs": boolean,
  "resourcePolicies": {
    string: string,
    ...
  },
  "resourceStatus": {
    "specificSkuAllocation": {
      "sourceInstanceTemplateId": string,
      "utilizations": {
        string: string,
        ...
      }
    },
    "reservationMaintenance": {
      "upcomingGroupMaintenance": {
        "type": enum,
        "canReschedule": boolean,
        "windowStartTime": string,
        "windowEndTime": string,
        "latestWindowStartTime": string,
        "maintenanceStatus": enum
      },
      "enableOpportunisticMaintenance": boolean,
      "maintenanceOngoingCount": integer,
      "maintenancePendingCount": integer,
      "schedulingType": enum
    },
    "reservationBlockCount": integer
  },
  "reservationSharingPolicy": {
    "serviceShareType": enum
  },
  "deploymentType": enum,
  "instanceTerminationAction": enum,

  // Union field type can be only one of the following:
  "specificReservation": {
    "instanceProperties": {
      "machineType": string,
      "guestAccelerators": [
        {
          "acceleratorType": string,
          "acceleratorCount": integer
        }
      ],
      "minCpuPlatform": string,
      "localSsds": [
        {
          "diskSizeGb": string,
          "interface": enum
        }
      ],
      "maintenanceFreezeDurationHours": integer,
      "locationHint": string,
      "maintenanceInterval": enum
    },
    "count": string,
    "inUseCount": string,
    "assuredCount": string,
    "sourceInstanceTemplate": string
  },
  "aggregateReservation": {
    "vmFamily": enum,
    "reservedResources": [
      {

        // Union field reserved_resource can be only one of the following:
        "accelerator": {
          "acceleratorCount": integer,
          "acceleratorType": string
        }
        // End of list of possible types for union field reserved_resource.
      }
    ],
    "inUseResources": [
      {

        // Union field reserved_resource can be only one of the following:
        "accelerator": {
          "acceleratorCount": integer,
          "acceleratorType": string
        }
        // End of list of possible types for union field reserved_resource.
      }
    ],
    "workloadType": enum
  }
  // End of list of possible types for union field type.

  // Union field auto_delete_time can be only one of the following:
  "deleteAtTime": string,
  "deleteAfterDuration": {
    "seconds": string,
    "nanos": integer
  }
  // End of list of possible types for union field auto_delete_time.
}

Fields
`kind`	`string` [Output Only] Type of the resource. Always `compute#reservations` for reservations.
`id`	`string (uint64 format)` [Output Only] The unique identifier for the resource. This identifier is defined by the server.
`creationTimestamp`	`string` [Output Only] Creation timestamp in RFC3339 text format.
`selfLink`	`string` [Output Only] Server-defined fully-qualified URL for this resource.
`zone`	`string` Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment.
`description`	`string` An optional description of this resource. Provide this property when you create the resource.
`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.
`commitment`	`string` [Output Only] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment.
`specificReservationRequired`	`boolean` 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.
`status`	`enum` [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.
`shareSettings`	`object` 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.
`shareSettings.shareType`	`enum` Type of sharing for this shared-reservation
`shareSettings.projects[]`	`string` A reservations.list of Project names to specify consumer projects for this shared-reservation. This is only valid when shareType's value is SPECIFIC_PROJECTS.
`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.
`shareSettings.projectMap[].projectId`	`string` The project ID, should be same as the key of this project config in the parent map.
`satisfiesPzs`	`boolean` [Output Only] Reserved for future use.
`resourcePolicies`	`map (key: string, value: string)` 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.
`resourceStatus`	`object` [Output Only] Status information for Reservation resource.
`resourceStatus.specificSkuAllocation`	`object` Allocation Properties of this reservation.
`resourceStatus.specificSkuAllocation.sourceInstanceTemplateId`	`string` ID of the instance template used to populate reservation properties.
`resourceStatus.specificSkuAllocation.utilizations`	`map (key: string, value: string (int64 format))` Per service utilization breakdown. The Key is the Google Cloud managed service name.
`resourceStatus.reservationMaintenance`	`object` Maintenance information for this reservation
`resourceStatus.reservationMaintenance.upcomingGroupMaintenance`	`object` Maintenance information on this group of VMs.
`resourceStatus.reservationMaintenance.upcomingGroupMaintenance.type`	`enum` Defines the type of maintenance.
`resourceStatus.reservationMaintenance.upcomingGroupMaintenance.canReschedule`	`boolean` Indicates if the maintenance can be customer triggered.
`resourceStatus.reservationMaintenance.upcomingGroupMaintenance.windowStartTime`	`string` The current start time of the maintenance window. This timestamp value is in RFC3339 text format.
`resourceStatus.reservationMaintenance.upcomingGroupMaintenance.windowEndTime`	`string` The time by which the maintenance disruption will be completed. This timestamp value is in RFC3339 text format.
`resourceStatus.reservationMaintenance.upcomingGroupMaintenance.latestWindowStartTime`	`string` The latest time for the planned maintenance window to start. This timestamp value is in RFC3339 text format.
`resourceStatus.reservationMaintenance.upcomingGroupMaintenance.maintenanceStatus`	`enum`
`resourceStatus.reservationMaintenance.enableOpportunisticMaintenance`	`boolean` This setting enables or disables opportunistic maintenance. If enabled, maintenance is performed on unused reservations whenever possible.
`resourceStatus.reservationMaintenance.maintenanceOngoingCount`	`integer` Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have ongoing maintenance.
`resourceStatus.reservationMaintenance.maintenancePendingCount`	`integer` Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have pending maintenance.
`resourceStatus.reservationMaintenance.schedulingType`	`enum` The type of maintenance for the reservation.
`resourceStatus.reservationBlockCount`	`integer` The number of reservation blocks associated with this reservation.
`reservationSharingPolicy`	`object` Specify the reservation sharing policy. If unspecified, the reservation will not be shared with Google Cloud managed services.
`reservationSharingPolicy.serviceShareType`	`enum` Sharing config for all Google Cloud services.
`deploymentType`	`enum` Specifies the deployment strategy for this reservation.
`instanceTerminationAction`	`enum` Instance termination action is invoked when the reservation is deleted. This only applies to reservations with a Deployment type.
Union field `type`. `type` can be only one of the following:
`specificReservation`	`object` Reservation for instances with specific machine shapes.
`specificReservation.instanceProperties`	`object` The instance properties for the reservation.
`specificReservation.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.
`specificReservation.instanceProperties.guestAccelerators[]`	`object` Specifies accelerator type and count.
`specificReservation.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.
`specificReservation.instanceProperties.guestAccelerators[].acceleratorCount`	`integer` The number of the guest accelerator cards exposed to this instance.
`specificReservation.instanceProperties.minCpuPlatform`	`string` Minimum cpu platform the reservation.
`specificReservation.instanceProperties.localSsds[]`	`object` Specifies amount of local ssd to reserve with each instance. The type of disk is local-ssd.
`specificReservation.instanceProperties.localSsds[].diskSizeGb`	`string (int64 format)` Specifies the size of the disk in base-2 GB.
`specificReservation.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.
`specificReservation.instanceProperties.maintenanceFreezeDurationHours`	`integer` Specifies the number of hours after reservation creation where instances using the reservation won't be scheduled for maintenance.
`specificReservation.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.
`specificReservation.instanceProperties.maintenanceInterval`	`enum` Specifies the frequency of planned maintenance events. The accepted values are: `PERIODIC`.
`specificReservation.count`	`string (int64 format)` Specifies the number of resources that are allocated.
`specificReservation.inUseCount`	`string (int64 format)` [Output Only] Indicates how many instances are in use.
`specificReservation.assuredCount`	`string (int64 format)` [Output Only] Indicates how many instances are actually usable currently.
`specificReservation.sourceInstanceTemplate`	`string` Specifies the instance template to create the reservation. If you use this field, you must exclude the `instanceProperties` field. This field is optional, and it can be a full or partial URL. For example, the following are all valid URLs to an instance template: `https://www.googleapis.com/compute/v1/projects/project/global/instanceTemplates/instanceTemplate` `projects/project/global/instanceTemplates/instanceTemplate` `global/instanceTemplates/instanceTemplate`
`aggregateReservation`	`object` Reservation for aggregated resources, providing shape flexibility.
`aggregateReservation.vmFamily`	`enum` The VM family that all instances scheduled against this reservation must belong to.
`aggregateReservation.reservedResources[]`	`object` reservations.list of reserved resources (CPUs, memory, accelerators).
`aggregateReservation.reservedResources[].accelerator`	`object` Properties of accelerator resources in this reservation.
`aggregateReservation.reservedResources[].accelerator.acceleratorCount`	`integer` Number of accelerators of specified type.
`aggregateReservation.reservedResources[].accelerator.acceleratorType`	`string` Full or partial URL to accelerator type. e.g. "projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l"
`aggregateReservation.inUseResources[]`	`object` [Output only] reservations.list of resources currently in use.
`aggregateReservation.inUseResources[].accelerator`	`object` Properties of accelerator resources in this reservation.
`aggregateReservation.inUseResources[].accelerator.acceleratorCount`	`integer` Number of accelerators of specified type.
`aggregateReservation.inUseResources[].accelerator.acceleratorType`	`string` Full or partial URL to accelerator type. e.g. "projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l"
`aggregateReservation.workloadType`	`enum` The workload type of the instances that will target this reservation.
Union field `auto_delete_time`. `auto_delete_time` can be only one of the following:
`deleteAtTime`	`string` Absolute time in future when the reservation will be auto-deleted by Compute Engine. Timestamp is represented in RFC3339 text format.
`deleteAfterDuration`	`object` Duration time relative to reservation creation when Compute Engine will automatically delete this resource.
`deleteAfterDuration.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
`deleteAfterDuration.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.

Methods
`aggregatedList`	Retrieves an aggregated list of reservations.
`delete`	Deletes the specified reservation.
`get`	Retrieves information about the specified reservation.
`getIamPolicy`	Gets the access control policy for a resource.
`insert`	Creates a new reservation.
`list`	A list of all the reservations that have been configured for the specified project in specified zone.
`resize`	Resizes the reservation (applicable to standalone reservations only).
`setIamPolicy`	Sets the access control policy on the specified resource.
`testIamPermissions`	Returns permissions that a caller has on the specified resource.
`update`	Update share settings of the reservation.

REST Resource: reservations

Resource: Reservation

Methods

`aggregatedList`

`delete`

`get`

`getIamPolicy`

`insert`

`list`

`resize`

`setIamPolicy`

`testIamPermissions`

`update`