- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization Scopes
- IAM Permissions
- Examples
- Try it!
Retrieves an aggregated list of commitments.
HTTP request
GET https://compute.googleapis.com/compute/beta/projects/{project}/aggregated/commitments
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
project |
Project ID for this request. |
Query parameters
Parameters | |
---|---|
maxResults |
The maximum number of results per page that should be returned. If the number of available results is larger than |
pageToken |
Specifies a page token to use. Set |
filter |
A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either For example, if you are filtering Compute Engine instances, you can exclude instances named You can also filter nested fields. For example, you could specify To filter on multiple expressions, provide each separate expression within parentheses. For example:
By default, each expression is an
|
orderBy |
Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using Currently, only sorting by |
returnPartialSuccess |
Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today. |
includeAllScopes |
Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. |
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
JSON representation | |
---|---|
{ "id": string, "items": [ { "scopeName": string, "commitments": [ { "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 } ], "warning": { "code": enum, "message": string, "data": [ { "key": string, "value": string } ] } } ], "nextPageToken": string, "selfLink": string, "warning": { "code": enum, "message": string, "data": [ { "key": string, "value": string } ] }, "unreachables": [ string ], "kind": string } |
Fields | |
---|---|
id |
[Output Only] Unique identifier for the resource; defined by the server. |
items[] |
A list of CommitmentsScopedList resources. |
items[].scopeName |
[Output Only] Name of the scope containing this set of commitments. |
items[].commitments[] |
[Output Only] A list of commitments contained in this scope. |
items[].commitments[].id |
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
items[].commitments[].creationTimestamp |
[Output Only] Creation timestamp in RFC3339 text format. |
items[].commitments[].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 |
items[].commitments[].description |
An optional description of this resource. Provide this property when you create the resource. |
items[].commitments[].region |
[Output Only] URL of the region where this commitment may be used. |
items[].commitments[].selfLink |
[Output Only] Server-defined URL for the resource. |
items[].commitments[].status |
[Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: |
items[].commitments[].statusMessage |
[Output Only] An optional, human-readable explanation of the status. |
items[].commitments[].plan |
The plan for this commitment, which determines duration and discount rate. The currently supported plans are |
items[].commitments[].startTimestamp |
[Output Only] Commitment start time in RFC3339 text format. |
items[].commitments[].endTimestamp |
[Output Only] Commitment end time in RFC3339 text format. |
items[].commitments[].resources[] |
A list of commitment amounts for particular resources. Note that |
items[].commitments[].resources[].type |
Type of resource for which this commitment applies. Possible values are |
items[].commitments[].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. |
items[].commitments[].resources[].acceleratorType |
Name of the accelerator type resource. Applicable only when the type is ACCELERATOR. |
items[].commitments[].type |
The type of commitment, which affects the discount rate and the eligible resources. Type |
items[].commitments[].reservations[] |
globalOperations.list of reservations in this commitment. |
items[].commitments[].reservations[].id |
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
items[].commitments[].reservations[].creationTimestamp |
[Output Only] Creation timestamp in RFC3339 text format. |
items[].commitments[].reservations[].selfLink |
[Output Only] Server-defined fully-qualified URL for this resource. |
items[].commitments[].reservations[].zone |
Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment. |
items[].commitments[].reservations[].description |
An optional description of this resource. Provide this property when you create the resource. |
items[].commitments[].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 |
items[].commitments[].reservations[].specificReservation |
Reservation for instances with specific machine shapes. |
items[].commitments[].reservations[].specificReservation.instanceProperties |
The instance properties for the reservation. |
items[].commitments[].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. |
items[].commitments[].reservations[].specificReservation.instanceProperties.guestAccelerators[] |
Specifies accelerator type and count. |
items[].commitments[].reservations[].specificReservation.instanceProperties.guestAccelerators[].acceleratorType |
Full or partial URL of the accelerator type resource to attach to this instance. For example: |
items[].commitments[].reservations[].specificReservation.instanceProperties.guestAccelerators[].acceleratorCount |
The number of the guest accelerator cards exposed to this instance. |
items[].commitments[].reservations[].specificReservation.instanceProperties.minCpuPlatform |
Minimum cpu platform the reservation. |
items[].commitments[].reservations[].specificReservation.instanceProperties.localSsds[] |
Specifies amount of local ssd to reserve with each instance. The type of disk is local-ssd. |
items[].commitments[].reservations[].specificReservation.instanceProperties.localSsds[].diskSizeGb |
Specifies the size of the disk in base-2 GB. |
items[].commitments[].reservations[].specificReservation.instanceProperties.localSsds[].interface |
Specifies the disk interface to use for attaching this disk, which is either |
items[].commitments[].reservations[].specificReservation.count |
Specifies the number of resources that are allocated. |
items[].commitments[].reservations[].specificReservation.inUseCount |
[Output Only] Indicates how many instances are in use. |
items[].commitments[].reservations[].commitment |
[Output Only] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment. |
items[].commitments[].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. |
items[].commitments[].reservations[].status |
[Output Only] The status of the reservation. |
items[].commitments[].reservations[].kind |
[Output Only] Type of the resource. Always |
items[].commitments[].category |
The category of the commitment. Category |
items[].commitments[].licenseResource |
The license specification required as part of a license commitment. |
items[].commitments[].licenseResource.license |
Any applicable license URI. |
items[].commitments[].licenseResource.amount |
The number of licenses purchased. |
items[].commitments[].licenseResource.coresPerLicense |
Specifies the core range of the instance for which this license applies. |
items[].commitments[].kind |
[Output Only] Type of the resource. Always |
items[].warning |
[Output Only] Informational warning which replaces the list of commitments when the list is empty. |
items[].warning.code |
[Output Only] A warning code, if applicable. For example, Compute Engine returns |
items[].warning.message |
[Output Only] A human-readable description of the warning code. |
items[].warning.data[] |
[Output Only] Metadata about this warning in "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
items[].warning.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 |
items[].warning.data[].value |
[Output Only] A warning data value corresponding to the key. |
nextPageToken |
[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than |
selfLink |
[Output Only] Server-defined URL for this resource. |
warning |
[Output Only] Informational warning message. |
warning.code |
[Output Only] A warning code, if applicable. For example, Compute Engine returns |
warning.message |
[Output Only] A human-readable description of the warning code. |
warning.data[] |
[Output Only] Metadata about this warning in "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
warning.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 |
warning.data[].value |
[Output Only] A warning data value corresponding to the key. |
unreachables[] |
[Output Only] Unreachable resources. |
kind |
[Output Only] Type of 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.list
To find predefined roles that contain those permissions, see Compute Engine IAM Roles.