- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Try it!
Retrieves a list of reservation blocks under a single reservation.
HTTP request
GET https://compute.googleapis.com/compute/beta/projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
project |
Project ID for this request. |
zone |
Name of the zone for this request. Zone name should conform to RFC1035. |
reservation |
The name of the reservation. Name should conform to RFC1035 or be a resource ID. Authorization requires the following IAM permission on the specified resource
|
Query parameters
Parameters | |
---|---|
max |
The maximum number of results per page that should be returned. If the number of available results is larger than |
page |
Specifies a page token to use. Set |
filter |
A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either For example, if you are filtering Compute Engine instances, you can exclude instances named The
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
If you want to use a regular expression, use the
The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use You cannot combine constraints on multiple fields using regular expressions. |
order |
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 |
return |
Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. |
Request body
The request body must be empty.
Response body
A list of reservation blocks under a single reservation.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{ "kind": string, "id": string, "items": [ { "kind": string, "id": string, "creationTimestamp": string, "name": string, "zone": string, "selfLink": string, "selfLinkWithId": string, "count": integer, "inUseCount": integer, "reservationMaintenance": { "upcomingGroupMaintenance": { "type": enum, "canReschedule": boolean, "windowStartTime": string, "windowEndTime": string, "latestWindowStartTime": string, "maintenanceStatus": enum }, "enableOpportunisticMaintenance": boolean, "maintenanceOngoingCount": integer, "maintenancePendingCount": integer, "schedulingType": enum }, "status": enum, "physicalTopology": { "cluster": string, "block": string } } ], "nextPageToken": string, "selfLink": string, "warning": { "code": enum, "message": string, "data": [ { "key": string, "value": string } ] } } |
Fields | |
---|---|
kind |
Type of the resource. Always |
id |
Unique identifier for the resource; defined by the server. |
items[] |
A list of reservation block resources. |
items[]. |
[Output Only] Type of the resource. Always |
items[]. |
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
items[]. |
[Output Only] Creation timestamp in RFC3339 text format. |
items[]. |
[Output Only] The name of this reservation block generated by Google Compute Engine. The name must be 1-63 characters long, and comply with RFC1035 @pattern a-z? |
items[]. |
[Output Only] Zone in which the reservation block resides. |
items[]. |
[Output Only] Server-defined fully-qualified URL for this resource. |
items[]. |
[Output Only] Server-defined URL for this resource with the resource id. |
items[]. |
[Output Only] The number of resources that are allocated in this reservation block. |
items[]. |
[Output Only] The number of instances that are currently in use on this reservation block. |
items[]. |
[Output Only] Maintenance information for this reservation block. |
items[]. |
Maintenance information on this group of VMs. |
items[]. |
Defines the type of maintenance. |
items[]. |
Indicates if the maintenance can be customer triggered. |
items[]. |
The current start time of the maintenance window. This timestamp value is in RFC3339 text format. |
items[]. |
The time by which the maintenance disruption will be completed. This timestamp value is in RFC3339 text format. |
items[]. |
The latest time for the planned maintenance window to start. This timestamp value is in RFC3339 text format. |
items[]. |
|
items[]. |
This setting enables or disables opportunistic maintenance. If enabled, maintenance is performed on unused reservations whenever possible. |
items[]. |
Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have ongoing maintenance. |
items[]. |
Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have pending maintenance. |
items[]. |
The type of maintenance for the reservation. |
items[]. |
[Output Only] Status of the reservation block. |
items[]. |
[Output Only] The physical topology of the reservation block. |
items[]. |
The cluster name of the reservation block. |
items[]. |
The hash of the capacity block within the cluster. |
next |
This token allows you to get the next page of results for list requests. If the number of results is larger than |
self |
Server-defined URL for this resource. |
warning |
Informational warning message. |
warning. |
[Output Only] A warning code, if applicable. For example, Compute Engine returns |
warning. |
[Output Only] A human-readable description of the warning code. |
warning. |
[Output Only] Metadata about this warning in "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
warning. |
[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. |
[Output Only] A warning data value corresponding to the key. |
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/compute.readonly
https://www.googleapis.com/auth/compute
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.