Resource: Commitment
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.
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 } ] }, "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 |
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
creationTimestamp |
[Output Only] Creation timestamp in RFC3339 text format. |
name |
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 |
description |
An optional description of this resource. Provide this property when you create the resource. |
region |
[Output Only] URL of the region where this commitment may be used. |
selfLink |
[Output Only] Server-defined URL for the resource. |
status |
[Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: |
statusMessage |
[Output Only] An optional, human-readable explanation of the status. |
plan |
The plan for this commitment, which determines duration and discount rate. The currently supported plans are |
startTimestamp |
[Output Only] Commitment start time in RFC3339 text format. |
endTimestamp |
[Output Only] Commitment end time in RFC3339 text format. |
resources[] |
A list of commitment amounts for particular resources. Note that |
resources[].type |
Type of resource for which this commitment applies. Possible values are |
resources[].amount |
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 |
Name of the accelerator type resource. Applicable only when the type is ACCELERATOR. |
type |
The type of commitment, which affects the discount rate and the eligible resources. Type |
reservations[] |
globalOperations.list of reservations in this commitment. |
reservations[].id |
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
reservations[].creationTimestamp |
[Output Only] Creation timestamp in RFC3339 text format. |
reservations[].selfLink |
[Output Only] Server-defined fully-qualified URL for this resource. |
reservations[].zone |
Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment. |
reservations[].description |
An optional description of this resource. Provide this property when you create the resource. |
reservations[].name |
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 |
reservations[].specificReservation |
Reservation for instances with specific machine shapes. |
reservations[].specificReservation.instanceProperties |
The instance properties for the reservation. |
reservations[].specificReservation.instanceProperties.machineType |
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[] |
Specifies accelerator type and count. |
reservations[].specificReservation.instanceProperties.guestAccelerators[].acceleratorType |
Full or partial URL of the accelerator type resource to attach to this instance. For example: |
reservations[].specificReservation.instanceProperties.guestAccelerators[].acceleratorCount |
The number of the guest accelerator cards exposed to this instance. |
reservations[].specificReservation.instanceProperties.minCpuPlatform |
Minimum cpu platform the reservation. |
reservations[].specificReservation.instanceProperties.localSsds[] |
Specifies amount of local ssd to reserve with each instance. The type of disk is local-ssd. |
reservations[].specificReservation.instanceProperties.localSsds[].diskSizeGb |
Specifies the size of the disk in base-2 GB. |
reservations[].specificReservation.instanceProperties.localSsds[].interface |
Specifies the disk interface to use for attaching this disk, which is either |
reservations[].specificReservation.count |
Specifies the number of resources that are allocated. |
reservations[].specificReservation.inUseCount |
[Output Only] Indicates how many instances are in use. |
reservations[].commitment |
[Output Only] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment. |
reservations[].specificReservationRequired |
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 |
[Output Only] The status of the reservation. |
reservations[].kind |
[Output Only] Type of the resource. Always |
category |
The category of the commitment. Category |
licenseResource |
The license specification required as part of a license commitment. |
licenseResource.license |
Any applicable license URI. |
licenseResource.amount |
The number of licenses purchased. |
licenseResource.coresPerLicense |
Specifies the core range of the instance for which this license applies. |
kind |
[Output Only] Type of the resource. Always |
Methods |
|
---|---|
|
Retrieves an aggregated list of commitments. |
|
Returns the specified commitment resource. |
|
Creates a commitment in the specified project using the data included in the request. |
|
Retrieves a list of commitments contained within the specified region. |
|
Returns permissions that a caller has on the specified resource. |
|
Transfers GPUs or local SSDs between reservations within commitments. |