Method: regionCommitments.aggregatedList

HTTP request
Path parameters
Query parameters
Request body
Response body
- JSON representation
Authorization Scopes
IAM Permissions

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

Parameters
`project`	`string` Project ID for this request.

project

string

Project ID for this request.

Query parameters

Parameters
`maxResults`	`integer (uint32 format)` The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
`pageToken`	`string` Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
`filter`	`string` 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 `=`, `!=`, `>`, or `<`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, `(scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake")`. By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example, `(cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true)`.
`orderBy`	`string` 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 `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.

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 } ], "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 } ] }, "kind": string }

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
            }
          ],
          "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
      }
    ]
  },
  "kind": string
}

Fields
`id`	`string` [Output Only] Unique identifier for the resource; defined by the server.
`items[]`	`object` A list of CommitmentsScopedList resources.
`items[].scopeName`	`string` [Output Only] Name of the scope containing this set of commitments.
`items[].commitments[]`	`object` [Output Only] A list of commitments contained in this scope.
`items[].commitments[].id`	`string (fixed64 format)` [Output Only] The unique identifier for the resource. This identifier is defined by the server.
`items[].commitments[].creationTimestamp`	`string` [Output Only] Creation timestamp in RFC3339 text format.
`items[].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.
`items[].commitments[].description`	`string` An optional description of this resource. Provide this property when you create the resource.
`items[].commitments[].region`	`string` [Output Only] URL of the region where this commitment may be used.
`items[].commitments[].selfLink`	`string` [Output Only] Server-defined URL for the resource.
`items[].commitments[].status`	`enum` [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.`
`items[].commitments[].statusMessage`	`string` [Output Only] An optional, human-readable explanation of the status.
`items[].commitments[].plan`	`enum` 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).
`items[].commitments[].startTimestamp`	`string` [Output Only] Commitment start time in RFC3339 text format.
`items[].commitments[].endTimestamp`	`string` [Output Only] Commitment end time in RFC3339 text format.
`items[].commitments[].resources[]`	`object` A list of commitment amounts for particular resources. Note that `VCPU` and `MEMORY` resource commitments must occur together.
`items[].commitments[].resources[].type`	`enum` Type of resource for which this commitment applies. Possible values are `VCPU` and `MEMORY`
`items[].commitments[].resources[].amount`	`string (int64 format)` 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`	`string` Name of the accelerator type resource. Applicable only when the type is ACCELERATOR.
`items[].commitments[].type`	`enum` The type of commitment, which affects the discount rate and the eligible resources. Type `MEMORY_OPTIMIZED` specifies a commitment that will only apply to memory optimized machines.
`items[].commitments[].reservations[]`	`object` globalOperations.list of reservations in this commitment.
`items[].commitments[].reservations[].id`	`string (fixed64 format)` [Output Only] The unique identifier for the resource. This identifier is defined by the server.
`items[].commitments[].reservations[].creationTimestamp`	`string` [Output Only] Creation timestamp in RFC3339 text format.
`items[].commitments[].reservations[].selfLink`	`string` [Output Only] Server-defined fully-qualified URL for this resource.
`items[].commitments[].reservations[].zone`	`string` Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment.
`items[].commitments[].reservations[].description`	`string` An optional description of this resource. Provide this property when you create the resource.
`items[].commitments[].reservations[].name`	`string` 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.
`items[].commitments[].reservations[].specificReservation`	`object` Reservation for instances with specific machine shapes.
`items[].commitments[].reservations[].specificReservation.instanceProperties`	`object` The instance properties for the reservation.
`items[].commitments[].reservations[].specificReservation.instanceProperties.machineType`	`string` 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[]`	`object` Specifies accelerator type and count.
`items[].commitments[].reservations[].specificReservation.instanceProperties.guestAccelerators[].acceleratorType`	`string` 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.
`items[].commitments[].reservations[].specificReservation.instanceProperties.guestAccelerators[].acceleratorCount`	`integer` The number of the guest accelerator cards exposed to this instance.
`items[].commitments[].reservations[].specificReservation.instanceProperties.minCpuPlatform`	`string` Minimum cpu platform the reservation.
`items[].commitments[].reservations[].specificReservation.instanceProperties.localSsds[]`	`object` Specifies amount of local ssd to reserve with each instance. The type of disk is local-ssd.
`items[].commitments[].reservations[].specificReservation.instanceProperties.localSsds[].diskSizeGb`	`string (int64 format)` Specifies the size of the disk in base-2 GB.
`items[].commitments[].reservations[].specificReservation.instanceProperties.localSsds[].interface`	`enum` 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.
`items[].commitments[].reservations[].specificReservation.count`	`string (int64 format)` Specifies the number of resources that are allocated.
`items[].commitments[].reservations[].specificReservation.inUseCount`	`string (int64 format)` [Output Only] Indicates how many instances are in use.
`items[].commitments[].reservations[].commitment`	`string` [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`	`boolean` 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`	`enum` [Output Only] The status of the reservation.
`items[].commitments[].reservations[].kind`	`string` [Output Only] Type of the resource. Always `compute#reservations` for reservations.
`items[].commitments[].kind`	`string` [Output Only] Type of the resource. Always `compute#commitment` for commitments.
`items[].warning`	`object` [Output Only] Informational warning which replaces the list of commitments when the list is empty.
`items[].warning.code`	`enum` [Output Only] A warning code, if applicable. For example, Compute Engine returns `NO_RESULTS_ON_PAGE` if there are no results in the response.
`items[].warning.message`	`string` [Output Only] A human-readable description of the warning code.
`items[].warning.data[]`	`object` [Output Only] Metadata about this warning in `key: value` format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
`items[].warning.data[].key`	`string` [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 `scope` and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
`items[].warning.data[].value`	`string` [Output Only] A warning data value corresponding to the key.
`nextPageToken`	`string` [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than `maxResults`, use the `nextPageToken` as a value for the query parameter `pageToken` in the next list request. Subsequent list requests will have their own `nextPageToken` to continue paging through the results.
`selfLink`	`string` [Output Only] Server-defined URL for this resource.
`warning`	`object` [Output Only] Informational warning message.
`warning.code`	`enum` [Output Only] A warning code, if applicable. For example, Compute Engine returns `NO_RESULTS_ON_PAGE` if there are no results in the response.
`warning.message`	`string` [Output Only] A human-readable description of the warning code.
`warning.data[]`	`object` [Output Only] Metadata about this warning in `key: value` format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
`warning.data[].key`	`string` [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 `scope` and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
`warning.data[].value`	`string` [Output Only] A warning data value corresponding to the key.
`kind`	`string` [Output Only] Type of resource. Always `compute#commitmentAggregatedList` for aggregated lists of commitments.

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 Google IAM permissions:

compute.commitments.list

To find predefined roles that contain those permissions, see Compute Engine IAM Roles.

Was this page helpful? Let us know how we did:

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see our Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated December 18, 2019.