Method: reservations.insert

Creates a new reservation. For more information, read Reserving zonal resources.

HTTP request

POST https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/reservations

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project

string

Project ID for this request.

zone

string

Name of the zone for this request.

Query parameters

Parameters
requestId

string

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

The request body contains data with the following structure:

JSON representation
{
  "id": string,
  "creationTimestamp": string,
  "selfLink": string,
  "zone": string,
  "description": string,
  "name": string,
  "commitment": string,
  "specificReservationRequired": boolean,
  "status": enum,
  "satisfiesPzs": boolean,
  "kind": string,
  "specificReservation": {
    "instanceProperties": {
      "machineType": string,
      "guestAccelerators": [
        {
          "acceleratorType": string,
          "acceleratorCount": integer
        }
      ],
      "minCpuPlatform": string,
      "localSsds": [
        {
          "diskSizeGb": string,
          "interface": enum
        }
      ],
      "locationHint": string
    },
    "count": string,
    "inUseCount": string
  }
}
Fields
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.

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.

satisfiesPzs

boolean

[Output Only] Reserved for future use.

kind

string

[Output Only] Type of the resource. Always compute#reservations for reservations.

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.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.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.

Response body

If successful, the response body contains data with the following structure:

Represents an Operation resource.

Google Compute Engine has three Operation resources:

You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

Operations can be global, regional or zonal.

  • For global operations, use the globalOperations resource.
  • For regional operations, use the regionOperations resource.
  • For zonal operations, use the zonalOperations resource.

For more information, read Global, Regional, and Zonal Resources.

JSON representation
{
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "zone": string,
  "clientOperationId": string,
  "operationType": string,
  "targetLink": string,
  "targetId": string,
  "status": enum,
  "statusMessage": string,
  "user": string,
  "progress": integer,
  "insertTime": string,
  "startTime": string,
  "endTime": string,
  "error": {
    "errors": [
      {
        "code": string,
        "location": string,
        "message": string
      }
    ]
  },
  "warnings": [
    {
      "code": enum,
      "message": string,
      "data": [
        {
          "key": string,
          "value": string
        }
      ]
    }
  ],
  "httpErrorStatusCode": integer,
  "httpErrorMessage": string,
  "selfLink": string,
  "region": string,
  "description": string,
  "operationGroupId": string,
  "kind": string
}
Fields
id

string (uint64 format)

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

creationTimestamp

string

[Deprecated] This field is deprecated.

name