- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Reservation
- Standard
- CapacityUnits
- Usage
- Try it!
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 |
Required. The parent for reservations. |
Query parameters
Parameters | |
---|---|
pageSize |
The maximum number of items to return. |
pageToken |
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 ( |
Fields | |
---|---|
reservations[] |
The listed reservations. |
nextPageToken |
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, // Union field |
Fields | |
---|---|
name |
The reservation name with the format: projects/{projectID}/locations/{location}/reservations/{reservationID} |
Union field
|
|
standard |
|
Standard
JSON representation |
---|
{ "size": integer, "capacityUnits": enum ( |
Fields | |
---|---|
size |
The size of the reservation, in the units specified in the 'capacityUnits' field. |
capacityUnits |
|
resourceType |
The resource type of the reservation. |
interval |
The start and end time of the reservation. |
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 |
The real-time value of usage within the reservation, with the unit specified in field capacityUnits. |