Method: regionCommitments.get

Returns the specified commitment resource.

HTTP request

GET https://compute.googleapis.com/compute/beta/projects/{project}/regions/{region}/commitments/{commitment}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters

Parameters
`project`	`string` Project ID for this request.
`region`	`string` Name of the region for this request.
`commitment`	`string` Name of the commitment to return.

project

string

Project ID for this request.

region

string

Name of the region for this request.

commitment

string

Name of the commitment to return.

Request body

The request body must be empty.

Response body

Represents a regional Commitment resource.

Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts.

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

JSON representation
{ "kind": string, "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": [ { "kind": string, "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 } ], "maintenanceFreezeDurationHours": integer, "locationHint": string, "maintenanceInterval": enum }, "count": string, "inUseCount": string, "assuredCount": string, "sourceInstanceTemplate": string }, "aggregateReservation": { "vmFamily": enum, "reservedResources": [ { "accelerator": { "acceleratorCount": integer, "acceleratorType": string } } ], "inUseResources": [ { "accelerator": { "acceleratorCount": integer, "acceleratorType": string } } ], "workloadType": enum }, "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 }, "deleteAtTime": string, "deleteAfterDuration": { "seconds": string, "nanos": integer }, "reservationSharingPolicy": { "serviceShareType": enum }, "deploymentType": enum, "instanceTerminationAction": enum } ], "category": enum, "licenseResource": { "license": string, "amount": string, "coresPerLicense": string }, "autoRenew": boolean, "mergeSourceCommitments": [ string ], "splitSourceCommitment": string, "resourceStatus": { "customTermEligibilityEndTimestamp": string }, "existingReservations": [ string ], "customEndTimestamp": string }

JSON representation

{
  "kind": string,
  "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": [
    {
      "kind": string,
      "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
            }
          ],
          "maintenanceFreezeDurationHours": integer,
          "locationHint": string,
          "maintenanceInterval": enum
        },
        "count": string,
        "inUseCount": string,
        "assuredCount": string,
        "sourceInstanceTemplate": string
      },
      "aggregateReservation": {
        "vmFamily": enum,
        "reservedResources": [
          {
            "accelerator": {
              "acceleratorCount": integer,
              "acceleratorType": string
            }
          }
        ],
        "inUseResources": [
          {
            "accelerator": {
              "acceleratorCount": integer,
              "acceleratorType": string
            }
          }
        ],
        "workloadType": enum
      },
      "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
      },
      "deleteAtTime": string,
      "deleteAfterDuration": {
        "seconds": string,
        "nanos": integer
      },
      "reservationSharingPolicy": {
        "serviceShareType": enum
      },
      "deploymentType": enum,
      "instanceTerminationAction": enum
    }
  ],
  "category": enum,
  "licenseResource": {
    "license": string,
    "amount": string,
    "coresPerLicense": string
  },
  "autoRenew": boolean,
  "mergeSourceCommitments": [
    string
  ],
  "splitSourceCommitment": string,
  "resourceStatus": {
    "customTermEligibilityEndTimestamp": string
  },
  "existingReservations": [
    string
  ],
  "customEndTimestamp": string
}

Fields
`kind`	`string` [Output Only] Type of the resource. Always `compute#commitment` for commitments.
`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.
`selfLink`	`string` [Output Only] Server-defined URL for the resource.
`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`, `MEMORY`, `LOCAL_SSD`, and `ACCELERATOR`.
`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` regionCommitments.list of create-on-create reservations for this commitment.
`reservations[].kind`	`string` [Output Only] Type of the resource. Always `compute#reservations` for reservations.
`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 (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.maintenanceFreezeDurationHours`	`integer` Specifies the number of hours after reservation creation where instances using the reservation won't be scheduled for maintenance.
`reservations[].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.
`reservations[].specificReservation.instanceProperties.maintenanceInterval`	`enum` Specifies the frequency of planned maintenance events. The accepted values are: `PERIODIC`.
`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[].specificReservation.assuredCount`	`string (int64 format)` [Output Only] Indicates how many instances are actually usable currently.
`reservations[].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`
`reservations[].aggregateReservation`	`object` Reservation for aggregated resources, providing shape flexibility.
`reservations[].aggregateReservation.vmFamily`	`enum` The VM family that all instances scheduled against this reservation must belong to.
`reservations[].aggregateReservation.reservedResources[]`	`object` regionCommitments.list of reserved resources (CPUs, memory, accelerators).
`reservations[].aggregateReservation.reservedResources[].accelerator`	`object` Properties of accelerator resources in this reservation.
`reservations[].aggregateReservation.reservedResources[].accelerator.acceleratorCount`	`integer` Number of accelerators of specified type.
`reservations[].aggregateReservation.reservedResources[].accelerator.acceleratorType`	`string` Full or partial URL to accelerator type. e.g. "projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l"
`reservations[].aggregateReservation.inUseResources[]`	`object` [Output only] regionCommitments.list of resources currently in use.
`reservations[].aggregateReservation.inUseResources[].accelerator`	`object` Properties of accelerator resources in this reservation.
`reservations[].aggregateReservation.inUseResources[].accelerator.acceleratorCount`	`integer` Number of accelerators of specified type.
`reservations[].aggregateReservation.inUseResources[].accelerator.acceleratorType`	`string` Full or partial URL to accelerator type. e.g. "projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l"
`reservations[].aggregateReservation.workloadType`	`enum` The workload type of the instances that will target this reservation.
`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. `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.
`reservations[].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.
`reservations[].shareSettings.shareType`	`enum` Type of sharing for this shared-reservation
`reservations[].shareSettings.projects[]`	`string` A regionCommitments.list of Project names to specify consumer projects for this shared-reservation. This is only valid when shareType's value is SPECIFIC_PROJECTS.
`reservations[].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.
`reservations[].shareSettings.projectMap[].projectId`	`string` The project ID, should be same as the key of this project config in the parent map.
`reservations[].satisfiesPzs`	`boolean` [Output Only] Reserved for future use.
`reservations[].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.
`reservations[].resourceStatus`	`object` [Output Only] Status information for Reservation resource.
`reservations[].resourceStatus.specificSkuAllocation`	`object` Allocation Properties of this reservation.
`reservations[].resourceStatus.specificSkuAllocation.sourceInstanceTemplateId`	`string` ID of the instance template used to populate reservation properties.
`reservations[].resourceStatus.specificSkuAllocation.utilizations`	`map (key: string, value: string (int64 format))` Per service utilization breakdown. The Key is the Google Cloud managed service name.
`reservations[].resourceStatus.reservationMaintenance`	`object` Maintenance information for this reservation
`reservations[].resourceStatus.reservationMaintenance.upcomingGroupMaintenance`	`object` Maintenance information on this group of VMs.
`reservations[].resourceStatus.reservationMaintenance.upcomingGroupMaintenance.type`	`enum` Defines the type of maintenance.
`reservations[].resourceStatus.reservationMaintenance.upcomingGroupMaintenance.canReschedule`	`boolean` Indicates if the maintenance can be customer triggered.
`reservations[].resourceStatus.reservationMaintenance.upcomingGroupMaintenance.windowStartTime`	`string` The current start time of the maintenance window. This timestamp value is in RFC3339 text format.
`reservations[].resourceStatus.reservationMaintenance.upcomingGroupMaintenance.windowEndTime`	`string` The time by which the maintenance disruption will be completed. This timestamp value is in RFC3339 text format.
`reservations[].resourceStatus.reservationMaintenance.upcomingGroupMaintenance.latestWindowStartTime`	`string` The latest time for the planned maintenance window to start. This timestamp value is in RFC3339 text format.
`reservations[].resourceStatus.reservationMaintenance.upcomingGroupMaintenance.maintenanceStatus`	`enum`
`reservations[].resourceStatus.reservationMaintenance.enableOpportunisticMaintenance`	`boolean` This setting enables or disables opportunistic maintenance. If enabled, maintenance is performed on unused reservations whenever possible.
`reservations[].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.
`reservations[].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.
`reservations[].resourceStatus.reservationMaintenance.schedulingType`	`enum` The type of maintenance for the reservation.
`reservations[].resourceStatus.reservationBlockCount`	`integer` The number of reservation blocks associated with this reservation.
`reservations[].deleteAtTime`	`string` Absolute time in future when the reservation will be auto-deleted by Compute Engine. Timestamp is represented in RFC3339 text format.
`reservations[].deleteAfterDuration`	`object` Duration time relative to reservation creation when Compute Engine will automatically delete this resource.
`reservations[].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
`reservations[].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.
`reservations[].reservationSharingPolicy`	`object` Specify the reservation sharing policy. If unspecified, the reservation will not be shared with Google Cloud managed services.
`reservations[].reservationSharingPolicy.serviceShareType`	`enum` Sharing config for all Google Cloud services.
`reservations[].deploymentType`	`enum` Specifies the deployment strategy for this reservation.
`reservations[].instanceTerminationAction`	`enum` Instance termination action is invoked when the reservation is deleted. This only applies to reservations with a Deployment type.
`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.
`autoRenew`	`boolean` Specifies whether to enable automatic renewal for the commitment. The default value is `false` if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment.
`mergeSourceCommitments[]`	`string` regionCommitments.list of source commitments to be merged into a new commitment.
`splitSourceCommitment`	`string` Source commitment to be split into a new commitment.
`resourceStatus`	`object` [Output Only] Status information for Commitment resource.
`resourceStatus.customTermEligibilityEndTimestamp`	`string` [Output Only] Indicates the end time of customer's eligibility to send custom term requests in RFC3339 text format. Term extension requests that (not the end time in the request) after this time will be rejected.
`existingReservations[]`	`string` Specifies the already existing reservations to attach to the Commitment. This field is optional, and it can be a full or partial URL. For example, the following are valid URLs to an reservation: `https://www.googleapis.com/compute/v1/projects/project/zones/zone/reservations/reservation` `projects/project/zones/zone/reservations/reservation`
`customEndTimestamp`	`string` [Input Only] Optional, specifies the CUD end time requested by the customer in RFC3339 text format. Needed when the customer wants CUD's end date is later than the start date + term duration.

Authorization scopes

Requires one of the following OAuth scopes:

https://www.googleapis.com/auth/compute.readonly
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.get

To find predefined roles that contain those permissions, see Compute Engine IAM Roles.