- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization Scopes
- IAM Permissions
- Examples
- Try it!
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 |
Project ID for this request. |
region |
Name of the region for this request. |
Query parameters
Parameters | |
---|---|
requestId |
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 ( |
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 } ], "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. |
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 |
Response body
If successful, the response body contains data with the following structure:
JSON representation | |
---|---|
{ "id": string, "creationTimestamp": string, "name": string, "zone": string, "clientOperationId": string, "operationType": string, "targetLink": string, "targetId": string, "status": enum, "statusMessage": string, "user": string, "progress": integer, "insertTime": string, "startTime": string, "endTime": string, "error": { "errors": [ { "code": string, "location": string, "message": string } ] }, "warnings": [ { "code": enum, "message": string, "data": [ { "key": string, "value": string } ] } ], "httpErrorStatusCode": integer, "httpErrorMessage": string, "selfLink": string, "region": string, "description": string, "kind": string } |
Fields | |
---|---|
id |
[Output Only] The unique identifier for the operation. This identifier is defined by the server. |
creationTimestamp |
[Deprecated] This field is deprecated. |
name |
[Output Only] Name of the operation. |
zone |
[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. |
clientOperationId |
[Output Only] The value of |
operationType |
[Output Only] The type of operation, such as |
targetLink |
[Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. |
targetId |
[Output Only] The unique target ID, which identifies a specific incarnation of the target resource. |
status |
[Output Only] The status of the operation, which can be one of the following: |
statusMessage |
[Output Only] An optional textual description of the current status of the operation. |
user |
[Output Only] User who requested the operation, for example: |
progress |
[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. |
insertTime |
[Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
startTime |
[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
endTime |
[Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
error |
[Output Only] If errors are generated during processing of the operation, this field will be populated. |
error.errors[] |
[Output Only] The array of errors encountered while processing this operation. |
error.errors[].code |
[Output Only] The error type identifier for this error. |
error.errors[].location |
[Output Only] Indicates the field in the request that caused the error. This property is optional. |
error.errors[].message |
[Output Only] An optional, human-readable error message. |
warnings[] |
[Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
warnings[].code |
[Output Only] A warning code, if applicable. For example, Compute Engine returns |
warnings[].message |
[Output Only] A human-readable description of the warning code. |
warnings[].data[] |
[Output Only] Metadata about this warning in "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
warnings[].data[].key |
[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be |
warnings[].data[].value |
[Output Only] A warning data value corresponding to the key. |
httpErrorStatusCode |
[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a |
httpErrorMessage |
[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as |
selfLink |
[Output Only] Server-defined URL for the resource. |
region |
[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. |
description |
[Output Only] A textual description of the operation, which is set when the operation is created. |
kind |
[Output Only] Type of the resource. Always |
Authorization Scopes
Requires one of the following OAuth scopes:
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.create
To find predefined roles that contain those permissions, see Compute Engine IAM Roles.