RegionCommitments

For a list of methods for this resource, see the end of this page.

Resource representations

Represents a 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.

Committed use discounts are subject to Google Cloud Platform's Service Specific Terms. By purchasing a committed use discount, you agree to these terms. Committed use discounts will not renew, so you must purchase a new commitment to continue receiving discounts.

{
  "kind": "compute#commitment",
  "id": unsigned long,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "region": string,
  "selfLink": string,
  "status": string,
  "statusMessage": string,
  "plan": string,
  "startTimestamp": string,
  "endTimestamp": string,
  "resources": [
    {
      "type": string,
      "amount": long
    }
  ]
}
Property name Value Description Notes
creationTimestamp string [Output Only] Creation timestamp in RFC3339 text format.
description string An optional description of this resource. Provide this property when you create the resource.
endTimestamp string [Output Only] Commitment end time in RFC3339 text format.
id unsigned long [Output Only] The unique identifier for the resource. This identifier is defined by the server.
kind string [Output Only] Type of the resource. Always compute#commitment for commitments.
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.
plan string 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).
region string [Output Only] URL of the region where this commitment may be used.
resources[] list List of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together.
resources[].amount long 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[].type string Type of resource for which this commitment applies. Possible values are VCPU and MEMORY
startTimestamp string [Output Only] Commitment start time in RFC3339 text format.
status string [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.

Methods

aggregatedList
Retrieves an aggregated list of commitments.
get
Returns the specified commitment resource. Get a list of available commitments by making a list() request.
insert
Creates a commitment in the specified project using the data included in the request.
list
Retrieves a list of commitments contained within the specified region.

Monitor your resources on the go

Get the Google Cloud Console app to help you manage your projects.

Send feedback about...

Compute Engine