Method: regionCommitments.get

Response body

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.

Represents a regional resource-based commitment resource.

Creating this commitment resource means that you are purchasing a resource-based committed use contract, with an explicit start and end time. You can purchase resource-based commitments for both hardware and software resources. For more information, read Resource-based 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, "category": enum, "resources": [ { "type": enum, "amount": string, "acceleratorType": string } ], "type": enum, "reservations": [ { "specificReservation": { "instanceProperties": { "machineType": string, "guestAccelerators": [ { "acceleratorType": string, "acceleratorCount": integer } ], "minCpuPlatform": string, "localSsds": [ { "diskSizeGb": string, "interface": enum } ], "locationHint": string }, "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 }, "deleteAtTime": string, "deleteAfterDuration": { "seconds": string, "nanos": integer }, "kind": string, "id": string, "creationTimestamp": string, "selfLink": string, "zone": string, "description": string, "name": string, "commitment": string, "linkedCommitments": [ string ], "specificReservationRequired": boolean, "status": enum, "shareSettings": { "shareType": enum, "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, "maintenanceOnShutdown": boolean, "maintenanceReasons": [ enum ] }, "maintenanceOngoingCount": integer, "maintenancePendingCount": integer, "schedulingType": enum, "subblockInfraMaintenanceOngoingCount": integer, "subblockInfraMaintenancePendingCount": integer, "instanceMaintenanceOngoingCount": integer, "instanceMaintenancePendingCount": integer }, "reservationBlockCount": integer, "healthInfo": { "healthStatus": enum, "healthyBlockCount": integer, "degradedBlockCount": integer } }, "reservationSharingPolicy": { "serviceShareType": enum }, "deploymentType": enum, "advancedDeploymentControl": { "reservationOperationalMode": enum }, "enableEmergentMaintenance": boolean, "protectionTier": enum, "schedulingType": enum, "params": { "resourceManagerTags": { string: string, ... } }, "confidentialComputeType": enum, "earlyAccessMaintenance": enum, "resourceMetadata": { "resourceType": string, "apiVersion": string } } ], "licenseResource": { "license": string, "amount": string, "coresPerLicense": string }, "autoRenew": boolean, "mergeSourceCommitments": [ string ], "splitSourceCommitment": string, "resourceStatus": { "customTermEligibilityEndTimestamp": string }, "existingReservations": [ string ], "customEndTimestamp": string, "params": { "resourceManagerTags": { string: 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,
  "category": enum,
  "resources": [
    {
      "type": enum,
      "amount": string,
      "acceleratorType": string
    }
  ],
  "type": enum,
  "reservations": [
    {
      "specificReservation": {
        "instanceProperties": {
          "machineType": string,
          "guestAccelerators": [
            {
              "acceleratorType": string,
              "acceleratorCount": integer
            }
          ],
          "minCpuPlatform": string,
          "localSsds": [
            {
              "diskSizeGb": string,
              "interface": enum
            }
          ],
          "locationHint": string
        },
        "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
      },
      "deleteAtTime": string,
      "deleteAfterDuration": {
        "seconds": string,
        "nanos": integer
      },
      "kind": string,
      "id": string,
      "creationTimestamp": string,
      "selfLink": string,
      "zone": string,
      "description": string,
      "name": string,
      "commitment": string,
      "linkedCommitments": [
        string
      ],
      "specificReservationRequired": boolean,
      "status": enum,
      "shareSettings": {
        "shareType": enum,
        "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,
            "maintenanceOnShutdown": boolean,
            "maintenanceReasons": [
              enum
            ]
          },
          "maintenanceOngoingCount": integer,
          "maintenancePendingCount": integer,
          "schedulingType": enum,
          "subblockInfraMaintenanceOngoingCount": integer,
          "subblockInfraMaintenancePendingCount": integer,
          "instanceMaintenanceOngoingCount": integer,
          "instanceMaintenancePendingCount": integer
        },
        "reservationBlockCount": integer,
        "healthInfo": {
          "healthStatus": enum,
          "healthyBlockCount": integer,
          "degradedBlockCount": integer
        }
      },
      "reservationSharingPolicy": {
        "serviceShareType": enum
      },
      "deploymentType": enum,
      "advancedDeploymentControl": {
        "reservationOperationalMode": enum
      },
      "enableEmergentMaintenance": boolean,
      "protectionTier": enum,
      "schedulingType": enum,
      "params": {
        "resourceManagerTags": {
          string: string,
          ...
        }
      },
      "confidentialComputeType": enum,
      "earlyAccessMaintenance": enum,
      "resourceMetadata": {
        "resourceType": string,
        "apiVersion": string
      }
    }
  ],
  "licenseResource": {
    "license": string,
    "amount": string,
    "coresPerLicense": string
  },
  "autoRenew": boolean,
  "mergeSourceCommitments": [
    string
  ],
  "splitSourceCommitment": string,
  "resourceStatus": {
    "customTermEligibilityEndTimestamp": string
  },
  "existingReservations": [
    string
  ],
  "customEndTimestamp": string,
  "params": {
    "resourceManagerTags": {
      string: string,
      ...
    }
  }
}

Output only. The unique identifier for the resource. This identifier is defined by the server.

Name of the commitment. You must specify a name when you purchase the commitment. 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.

An optional description of the commitment. You can provide this property when you create the resource.

Output only. URL of the region where the commitment and committed resources are located.

The minimum time duration that you commit to purchasing resources. The plan that you choose determines the preset term length of the commitment (which is 1 year or 3 years) and affects the discount rate that you receive for your resources. Committing to a longer time duration typically gives you a higher discount rate. The supported values for this field are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years).

The category of the commitment; specifies whether the commitment is for hardware or software resources. Category MACHINE specifies that you are committing to hardware machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies that you are committing to software licenses, listed in licenseResources. Note that if you specify MACHINE commitments, then you must also specify a type to indicate the machine series of the hardware resource that you are committing to.

The list of all the hardware resources, with their types and amounts, that you want to commit to. Specify as a separate entry in the list for each individual resource type.

The type of hardware resource that you want to specify. You can specify any of the following values:

The quantity of the hardware resource that you want to commit to purchasing (in a type-dependent unit).

Name of the accelerator type or GPU resource. Specify this field only when the type of hardware resource is ACCELERATOR.

The type of commitment; specifies the machine series for which you want to commit to purchasing resources. The choice of machine series affects the discount rate and the eligible resource types.

The type must be one of the following: ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3, ACCELERATOR_OPTIMIZED_A3_MEGA, COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D, COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D, COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE, GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2, GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D, GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D, GRAPHICS_OPTIMIZED, GRAPHICS_OPTIMIZED_G4, GRAPHICS_OPTIMIZED_G4_VGPU, MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3, MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3. For example, type MEMORY_OPTIMIZED specifies a commitment that applies only to eligible resources of memory optimized M1 and M2 machine series. Type GENERAL_PURPOSE specifies a commitment that applies only to eligible resources of general purpose N1 machine series.

The list of new reservations that you want to create and attach to this commitment.

Specify this property only if you want to create new reservations to attach. To attach existing reservations, specify the existingReservations property instead.

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.

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.

Specifies amount of local ssd to reserve with each instance. The type of disk is local-ssd.

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.

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.

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:

The VM family that all instances scheduled against this reservation must belong to.

Full or partial URL to accelerator type. e.g. "projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l"

Absolute time in future when the reservation will be auto-deleted by Compute Engine. Timestamp is represented in RFC3339 text format.

Duration time relative to reservation creation when Compute Engine will automatically delete this resource.

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

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.

Output only. Type of the resource. Always compute#reservations for reservations.

Output only. The unique identifier for the resource. This identifier is defined by the server.

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

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

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.

Output only. Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment.

Output only. Full or partial URL to parent commitments. This field displays for reservations that are tied to multiple commitments.

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.

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.

A map of project id and project config. This is only valid when shareType's value is SPECIFIC_PROJECTS.

The project ID, should be same as the key of this project config in the parent map.

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.

Per service utilization breakdown. The Key is the Google Cloud managed service name.

The current start time of the maintenance window. This timestamp value is in RFC3339 text format.

The time by which the maintenance disruption will be completed. This timestamp value is in RFC3339 text format.

The latest time for the planned maintenance window to start. This timestamp value is in RFC3339 text format.

Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have ongoing maintenance.

Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have pending maintenance.

Describes number of subblock Infrastructure that has ongoing maintenance. Here, Subblock Infrastructure Maintenance pertains to upstream hardware contained in the Subblock that is necessary for a VM Family(e.g. NVLink Domains). Not all VM Families will support this field.

Describes number of subblock Infrastructure that has pending maintenance. Here, Subblock Infrastructure Maintenance pertains to upstream hardware contained in the Subblock that is necessary for a VM Family (e.g. NVLink Domains). Not all VM Families will support this field.

Specify the reservation sharing policy. If unspecified, the reservation will not be shared with Google Cloud managed services.

Advanced control for cluster management, applicable only to DENSE deployment type reservations.

Indicates whether Compute Engine allows unplanned maintenance for your VMs; for example, to fix hardware errors.

Protection tier for the workload which specifies the workload expectations in the event of infrastructure failures at data center (e.g. power and/or cooling failures).

Input only. Additional params passed with the request, but not persisted as part of resource payload.

Input only. Resource manager tags to be bound to the reservation. Tag keys and values have the same definition as resource manager tags. Keys and values can be either in numeric format, such as tagKeys/{tag_key_id} and tagValues/{tag_value_id} or in namespaced format such as {org_id|projectId}/{tag_key_short_name} and {tag_value_short_name}. The field is ignored (both PUT & PATCH) when empty.

Indicates the early access maintenance for the reservation. If this field is absent or set to NO_EARLY_ACCESS, the reservation is not enrolled in early access maintenance and the standard notice applies.

Output only. Contains standard resource metadata for an Allocation resource. It is populated for each instance of the Allocation resource, and includes the apiVersion the instance was retrieved through, and its canonical resourceType name.

The canonical resource type name in the format of a resource type as defined by AIP-123. For example, "compute.googleapis.com/Instance".

The version of the API interface that this resource was retrieved through. For example, "2025-01-01" or "2025-01-01-preview".

Specifies whether to automatically renew the commitment at the end of its current term. The default value is false. If you set the field to true, each time your commitment reaches the end of its term, Compute Engine automatically renews it for another term. You can update this field anytime before the commitment expires. For example, if the commitment is set to expire at 12 AM UTC-8 on January 3, 2027, you can update this field until 11:59 PM UTC-8 on January 2, 2027.

The list of source commitments that you are merging to create the new merged commitment. For more information, see Merging commitments.

The source commitment from which you are transferring resources to create the new split commitment. For more information, see Split commitments.

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.

[Input Only] Optional, specifies the requested commitment end time in RFC3339 text format. Use this option when the desired commitment's end date is later than the start date + term duration.

Input only. Additional params passed with the request, but not persisted as part of resource payload.

Input only. Resource manager tags to be bound to the commitment. Tag keys and values have the same definition as resource manager tags. Keys and values can be either in numeric format, such as tagKeys/{tag_key_id} and tagValues/{tag_value_id} or in namespaced format such as {org_id|projectId}/{tag_key_short_name} and {tag_value_short_name}. The field is ignored (both PUT & PATCH) when empty.

Method: regionCommitments.get

HTTP request

Path parameters

Request body

Response body

Authorization scopes

IAM Permissions

Method: regionCommitments.get Stay organized with collections Save and categorize content based on your preferences.

HTTP request

Path parameters

Request body

Response body

Authorization scopes

IAM Permissions

Method: regionCommitments.get