Method: regionCommitments.insert

Creates a commitment in the specified project using the data included in the request.

HTTP request

POST https://compute.googleapis.com/compute/v1/projects/{project}/regions/{region}/commitments

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project

string

Project ID for this request.
region

string

Name of the region 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,
  "name": string,
  "description": string,
  "region": string,
  "selfLink": string,
  "status": enum,
  "statusMessage": string,
  "plan": enum,
  "startTimestamp": string,
  "endTimestamp": string,
  "resources": [
    {
      "type": enum,
      "amount": string,
      "acceleratorType": string
    }
  ],
  "reservations": [
    {
      "id": string,
      "creationTimestamp": string,
      "selfLink": string,
      "zone": string,
      "description": string,
      "name": string,
      "specificReservation": {
        "instanceProperties": {
          "machineType": string,
          "guestAccelerators": [
            {
              "acceleratorType": string,
              "acceleratorCount": integer
            }
          ],
          "minCpuPlatform": string,
          "localSsds": [
            {
              "diskSizeGb": string,
              "interface": enum
            }
          ],
          "maintenanceInterval": enum
        },
        "count": string,
        "inUseCount": string
      },
      "commitment": string,
      "specificReservationRequired": boolean,
      "status": enum,
      "kind": string
    }
  ],
  "category": enum,
  "licenseResource": {
    "license": string,
    "amount": string,
    "coresPerLicense": string
  },
  "kind": string
}
Fields
id

string (fixed64 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.
name

string

Name of the resource. Provided by the client when the resource is created. The 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.
description

string

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

string

[Output Only] URL of the region where this commitment may be used.
status

enum

[Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED.
statusMessage

string

[Output Only] An optional, human-readable explanation of the status.
plan

enum

The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years).
startTimestamp

string

[Output Only] Commitment start time in RFC3339 text format.
endTimestamp

string

[Output Only] Commitment end time in RFC3339 text format.
resources[]

object

A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together.
resources[].type

enum

Type of resource for which this commitment applies. Possible values are VCPU and MEMORY
resources[].amount

string (int64 format)

The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU.
resources[].acceleratorType

string

Name of the accelerator type resource. Applicable only when the type is ACCELERATOR.
reservations[]

object

globalOperations.list of reservations in this commitment.
reservations[].id

string (fixed64 format)

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

string

[Output Only] Creation timestamp in RFC3339 text format.
reservations[].selfLink

string

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

string

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

string

An optional description of this resource. Provide this property when you create the resource.
reservations[].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.
reservations[].specificReservation

object

Reservation for instances with specific machine shapes.
reservations[].specificReservation.instanceProperties

object

The instance properties for the reservation.
reservations[].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.
reservations[].specificReservation.instanceProperties.guestAccelerators[]

object

Specifies accelerator type and count.
reservations[].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.
reservations[].specificReservation.instanceProperties.guestAccelerators[].acceleratorCount

integer

The number of the guest accelerator cards exposed to this instance.
reservations[].specificReservation.instanceProperties.minCpuPlatform

string

Minimum cpu platform the reservation.
reservations[].specificReservation.instanceProperties.localSsds[]

object

Specifies amount of local ssd to reserve with each instance. The type of disk is local-ssd.
reservations[].specificReservation.instanceProperties.localSsds[].diskSizeGb

string (int64 format)

Specifies the size of the disk in base-2 GB.
reservations[].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.
reservations[].specificReservation.instanceProperties.maintenanceInterval

enum

Specifies whether this VM may be a stable fleet VM. Setting this to "Periodic" designates this VM as a Stable Fleet VM.

See go/stable-fleet-ug for more details.
reservations[].specificReservation.count

string (int64 format)

Specifies the number of resources that are allocated.
reservations[].specificReservation.inUseCount

string (int64 format)

[Output Only] Indicates how many instances are in use.
reservations[].commitment

string

[Output Only] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment.
reservations[].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.
reservations[].status

enum

[Output Only] The status of the reservation.
reservations[].kind

string

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

enum

The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified.
licenseResource

object

The license specification required as part of a license commitment.
licenseResource.license

string

Any applicable license URI.
licenseResource.amount

string (int64 format)

The number of licenses purchased.
licenseResource.coresPerLicense

string

Specifies the core range of the instance for which this license applies.
kind

string

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

Response body

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

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,
  "kind": string
}
Fields
id

string (fixed64 format)

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

string

[Deprecated] This field is deprecated.
name

string

[Output Only] Name of the operation.
zone

string

[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
clientOperationId

string

[Output Only] The value of requestId if you provided it in the request. Not present otherwise.
operationType

string

[Output Only] The type of operation, such as insert, update, or delete, and so on.
targetId

string (fixed64 format)

[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
status

enum

[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
statusMessage

string

[Output Only] An optional textual description of the current status of the operation.
user

string

[Output Only] User who requested the operation, for example: user@example.com.
progress

integer

[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
insertTime

string

[Output Only] The time that this operation was requested. This value is in RFC3339 text format.
startTime

string

[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
endTime

string

[Output Only] The time that this operation was completed. This value is in RFC3339 text format.
error

object

[Output Only] If errors are generated during processing of the operation, this field will be populated.
error.errors[]

object

[Output Only] The array of errors encountered while processing this operation.
error.errors[].code

string

[Output Only] The error type identifier for this error.
error.errors[].location

string

[Output Only] Indicates the field in the request that caused the error. This property is optional.
error.errors[].message

string

[Output Only] An optional, human-readable error message.
warnings[]

object

[Output Only] If warning messages are generated during processing of the operation, this field will be populated.
warnings[].code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
warnings[].message

string

[Output Only] A human-readable description of the warning code.
warnings[].data[]

object

[Output Only] Metadata about this warning in key: value format. For example: 

"data": [  {  "key": "scope",  "value": "zones/us-east1-d"  }
warnings[].data[].key

string

[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
warnings[].data[].value

string

[Output Only] A warning data value corresponding to the key.
httpErrorStatusCode

integer

[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
httpErrorMessage

string

[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
region

string

[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
description

string

[Output Only] A textual description of the operation, which is set when the operation is created.
kind

string

[Output Only] Type of the resource. Always compute#operation for Operation resources.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/compute
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

In addition to any permissions specified on the fields above, authorization requires one or more of the following IAM permissions:

  • compute.commitments.create