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
    }
  ],
  "type": enum,
  "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
            }
          ],
          "locationHint": string
        },
        "count": string,
        "inUseCount": string
      },
      "commitment": string,
      "specificReservationRequired": boolean,
      "status": enum,
      "satisfiesPzs": boolean,
      "kind": string
    }
  ],
  "category": enum,
  "licenseResource": {
    "license": string,
    "amount": string,
    "coresPerLicense": string
  },
  "kind": 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.

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.

type

enum

The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to accelerator optimized machines.

reservations[]

object

globalOperations.list of reservations in this commitment.

reservations[].id

string (uint64 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 (