REST Resource: reservationBlocks

Resource: ReservationBlocksGetResponse

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,
        "maintenanceOnShutdown": boolean
      },
      "maintenanceOngoingCount": integer,
      "maintenancePendingCount": integer,
      "schedulingType": enum
    },
    "status": enum,
    "physicalTopology": {
      "cluster": string,
      "block": string
    },
    "reservationSubBlockCount": integer,
    "reservationSubBlockInUseCount": integer
  }
}
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.upcomingGroupMaintenance.maintenanceOnShutdown

boolean

Indicates whether the UpcomingMaintenance will be triggered on VM shutdown.

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.

resource.reservationSubBlockCount

integer

[Output Only] The number of reservation subBlocks associated with this reservation block.

resource.reservationSubBlockInUseCount

integer

[Output Only] The number of in-use reservation subBlocks associated with this reservation block. If at least one VM is running on a subBlock, it is considered in-use.

Methods

get

Retrieves information about the specified reservation block.

list

Retrieves a list of reservation blocks under a single reservation.

performMaintenance

Allows customers to perform maintenance on a reservation block