Method: projects.locations.reservations.list

Retrieves the reservations for the given project in the given location.

HTTP request

GET https://tpu.googleapis.com/v2alpha1/{parent=projects/*/locations/*}/reservations

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent for reservations.

Query parameters

Parameters
pageSize

integer

The maximum number of items to return.
pageToken

string

The nextPageToken value returned from a previous List request, if any.

Request body

The request body must be empty.

Response body

Response for reservations.list.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "reservations": [
    {
      object (Reservation)
    }
  ],
  "nextPageToken": string
}
Fields
reservations[]

object (Reservation)

The listed reservations.
nextPageToken

string

The next page token or empty if none.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud.tpu
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

Reservation

A reservation describes the amount of a resource 'allotted' for a defined period of time.

JSON representation 
{
  "name": string,
  "state": enum (State),

  // Union field kind can be only one of the following:
  "standard": {
    object (Standard)
  }
  // End of list of possible types for union field kind.
}
Fields
name

string

The reservation name with the format: projects/{projectID}/locations/{location}/reservations/{reservationID}
state

enum (State)

Output only. The state of the Reservation.

Union field kind.

kind can be only one of the following:
standard

object (Standard)

Standard

JSON representation 
{
  "size": integer,
  "capacityUnits": enum (CapacityUnits),
  "resourceType": string,
  "interval": {
    object (Interval)
  },
  "usage": {
    object (Usage)
  }
}
Fields
size

integer

The size of the reservation, in the units specified in the 'capacityUnits' field.
capacityUnits

enum (CapacityUnits)
resourceType

string

The resource type of the reservation.
interval

object (Interval)

The start and end time of the reservation.
usage

object (Usage)

CapacityUnits

The units capacity for this reservation is measured in.

Enums
CAPACITY_UNITS_UNSPECIFIED The capacity units is not known/set.
CORES The capacity unit is set to CORES.
CHIPS The capacity unit is set to CHIPS.

Usage

JSON representation 
{
  "total": string
}
Fields
total

string (int64 format)

The real-time value of usage within the reservation, with the unit specified in field capacityUnits.

State

State of the Reservation.

Enums
STATE_UNSPECIFIED The Reservation state is unspecified.
APPROVED The Reservation has been approved.
PROVISIONING The Reservation is being provisioned.
ACTIVE The Reservation is active.
DEPROVISIONING The Reservation is being deprovisioned.
EXPIRED The Reservation is past its end date.
FAILED The Reservation encountered a failure during mutation.