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


You will need authorization for at least one of the following scopes to make a valid call:


If unset, the scope for this method defaults to You can set the scope for this method like this: compute1 --scope <scope> reservations insert ...

Required Scalar Arguments

  • <project> (string)
    • Project ID for this request.
  • <zone> (string)
    • Name of the zone for this request.

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

    vm-family: string
    workload-type: string
  commitment: string
  creation-timestamp: string
  description: string
  id: string
  kind: string
  name: string
  resource-policies: { string: string }
      source-instance-template-id: string
  satisfies-pzs: boolean
  self-link: string
    share-type: string
    assured-count: int64
    count: string
    in-use-count: int64
      location-hint: string
      machine-type: string
      min-cpu-platform: string
    source-instance-template: string
  specific-reservation-required: boolean
  status: string
  zone: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

  • -r .aggregate-reservation vm-family=amet
    • The VM family that all instances scheduled against this reservation must belong to.
  • workload-type=clita

    • The workload type of the instances that will target this reservation.
  • .. commitment=dolor

    • [Output Only] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment.
  • creation-timestamp=clita
    • [Output Only] Creation timestamp in RFC3339 text format.
  • description=et
    • An optional description of this resource. Provide this property when you create the resource.
  • id=dolor
    • [Output Only] The unique identifier for the resource. This identifier is defined by the server.
  • kind=dolor
    • [Output Only] Type of the resource. Always compute#reservations for reservations.
  • name=nonumy
    • 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.
  • resource-policies=key=labore
    • 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.
    • the value will be associated with the given key
  • resource-status.specific-sku-allocation source-instance-template-id=dolore

    • ID of the instance template used to populate reservation properties.
  • ... satisfies-pzs=true

    • [Output Only] Reserved for future use.
  • self-link=justo
    • [Output Only] Server-defined fully-qualified URL for this resource.
  • share-settings share-type=dolor

    • Type of sharing for this shared-reservation
  • ..specific-reservation assured-count=-88

    • [Output Only] Indicates how many instances are actually usable currently.
  • count=dolores
    • Specifies the number of resources that are allocated.
  • in-use-count=-57
    • [Output Only] Indicates how many instances are in use.
  • instance-properties location-hint=sadipscing
    • 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.
  • machine-type=sed
    • 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.
  • min-cpu-platform=sea

    • Minimum cpu platform the reservation.
  • .. source-instance-template=elitr

    • 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: - /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate
  • .. specific-reservation-required=false

    • 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=et
    • [Output Only] The status of the reservation.
  • zone=et
    • Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

  • The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
  • The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
  • You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
  • You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional Method Properties

You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness.

  • -p request-id=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).

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p $-xgafv=string

    • V1 error format.
  • -p access-token=string

    • OAuth access token.
  • -p alt=string

    • Data format for response.
  • -p callback=string

    • JSONP
  • -p fields=string

    • Selector specifying which fields to include in a partial response.
  • -p key=string

    • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • -p oauth-token=string

    • OAuth 2.0 token for the current user.
  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.
  • -p quota-user=string

    • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • -p upload-type=string

    • Legacy upload protocol for media (e.g. "media", "multipart").
  • -p upload-protocol=string

    • Upload protocol for media (e.g. "raw", "multipart").
  • -p user-ip=string

    • Legacy name for parameter that has been superseded by quotaUser.