Method: reservationBlocks.get

HTTP request
Path parameters
Request body
Response body
- JSON representation
  - JSON representation
  - JSON representation
Authorization scopes
Try it!

Retrieves information about the specified reservation block.

HTTP request

GET https://compute.googleapis.com/compute/beta/projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks/{reservationBlock}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
`project`	`string` Project ID for this request.
`zone`	`string` Name of the zone for this request. Zone name should conform to RFC1035.
`reservation`	`string` 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 `reservation`: `compute.reservationBlocks.get`
`reservationBlock`	`string` The name of the reservation block. Name should conform to RFC1035 or be a resource ID.

Request body

The request body must be empty.

Response body

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

JSON representation
{ "resource": { "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 } } }

JSON representation

{
  "resource": {
    "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
    }
  }
}

Fields
`resource`	`object`
`resource.kind`	`string` [Output Only] Type of the resource. Always `compute#reservationBlock` for reservation blocks.
`resource.id`	`string (uint64 format)` [Output Only] The unique identifier for the resource. This identifier is defined by the server.
`resource.creationTimestamp`	`string` [Output Only] Creation timestamp in RFC3339 text format.
`resource.name`	`string` [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?
`resource.zone`	`string` [Output Only] Zone in which the reservation block resides.
`resource.selfLink`	`string` [Output Only] Server-defined fully-qualified URL for this resource.
`resource.selfLinkWithId`	`string` [Output Only] Server-defined URL for this resource with the resource id.
`resource.count`	`integer` [Output Only] The number of resources that are allocated in this reservation block.
`resource.inUseCount`	`integer` [Output Only] The number of instances that are currently in use on this reservation block.
`resource.reservationMaintenance`	`object` [Output Only] Maintenance information for this reservation block.
`resource.reservationMaintenance.upcomingGroupMaintenance`	`object` Maintenance information on this group of VMs.
`resource.reservationMaintenance.upcomingGroupMaintenance.type`	`enum` Defines the type of maintenance.
`resource.reservationMaintenance.upcomingGroupMaintenance.canReschedule`	`boolean` Indicates if the maintenance can be customer triggered.
`resource.reservationMaintenance.upcomingGroupMaintenance.windowStartTime`	`string` The current start time of the maintenance window. This timestamp value is in RFC3339 text format.
`resource.reservationMaintenance.upcomingGroupMaintenance.windowEndTime`	`string` The time by which the maintenance disruption will be completed. This timestamp value is in RFC3339 text format.
`resource.reservationMaintenance.upcomingGroupMaintenance.latestWindowStartTime`	`string` The latest time for the planned maintenance window to start. This timestamp value is in RFC3339 text format.
`resource.reservationMaintenance.upcomingGroupMaintenance.maintenanceStatus`	`enum`
`resource.reservationMaintenance.enableOpportunisticMaintenance`	`boolean` This setting enables or disables opportunistic maintenance. If enabled, maintenance is performed on unused reservations whenever possible.
`resource.reservationMaintenance.maintenanceOngoingCount`	`integer` Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have ongoing maintenance.
`resource.reservationMaintenance.maintenancePendingCount`	`integer` Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have pending maintenance.
`resource.reservationMaintenance.schedulingType`	`enum` The type of maintenance for the reservation.
`resource.status`	`enum` [Output Only] Status of the reservation block.
`resource.physicalTopology`	`object` [Output Only] The physical topology of the reservation block.
`resource.physicalTopology.cluster`	`string` The cluster name of the reservation block.
`resource.physicalTopology.block`	`string` The hash of the capacity block within the cluster.

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.