Method: reservationSubBlocks.get

Retrieves information about the specified reservation subBlock.

HTTP request

GET https://compute.googleapis.com/compute/beta/projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}

The URL uses gRPC Transcoding syntax. To know more about valid error responses that can be thrown by this HTTP request, please refer to the service error catalog

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.
parentName

string

The name of the parent reservation and parent block. In the format of reservations/{reservationName}/reservationBlocks/{reservation_block_name}
reservationSubBlock

string

The name of the reservation subBlock. 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,
    "reservationSubBlockMaintenance": {
      "upcomingGroupMaintenance": {
        "type": enum,
        "canReschedule": boolean,
        "windowStartTime": string,
        "windowEndTime": string,
        "latestWindowStartTime": string,
        "maintenanceStatus": enum,
        "maintenanceOnShutdown": boolean,
        "maintenanceReasons": [
          enum
        ]
      },
      "maintenanceOngoingCount": integer,
      "maintenancePendingCount": integer,
      "schedulingType": enum,
      "subblockInfraMaintenanceOngoingCount": integer,
      "subblockInfraMaintenancePendingCount": integer,
      "instanceMaintenanceOngoingCount": integer,
      "instanceMaintenancePendingCount": integer
    },
    "status": enum,
    "physicalTopology": {
      "cluster": string,
      "block": string,
      "subBlock": string
    },
    "inUseHostCount": integer,
    "healthInfo": {
      "healthStatus": enum,
      "healthyHostCount": integer,
      "degradedHostCount": integer,
      "healthyInfraCount": integer,
      "degradedInfraCount": integer
    }
  }
}
Fields
resource

object
resource.kind

string

[Output Only] Type of the resource. Always compute#reservationSubBlock for reservation subBlocks.
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 subBlock 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 subBlock 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 hosts that are allocated in this reservation subBlock.
resource.inUseCount

integer

[Output Only] The number of instances that are currently in use on this reservation subBlock.
resource.reservationSubBlockMaintenance

object

Maintenance information for this reservation subBlock.
resource.reservationSubBlockMaintenance.upcomingGroupMaintenance

object

Maintenance information on this group of VMs.
resource.reservationSubBlockMaintenance.upcomingGroupMaintenance.type

enum

Defines the type of maintenance.
resource.reservationSubBlockMaintenance.upcomingGroupMaintenance.canReschedule

boolean

Indicates if the maintenance can be customer triggered.
resource.reservationSubBlockMaintenance.upcomingGroupMaintenance.windowStartTime

string

The current start time of the maintenance window. This timestamp value is in RFC3339 text format.
resource.reservationSubBlockMaintenance.upcomingGroupMaintenance.windowEndTime

string

The time by which the maintenance disruption will be completed. This timestamp value is in RFC3339 text format.
resource.reservationSubBlockMaintenance.upcomingGroupMaintenance.latestWindowStartTime

string

The latest time for the planned maintenance window to start. This timestamp value is in RFC3339 text format.
resource.reservationSubBlockMaintenance.upcomingGroupMaintenance.maintenanceStatus

enum
resource.reservationSubBlockMaintenance.upcomingGroupMaintenance.maintenanceOnShutdown

boolean

Indicates whether the UpcomingMaintenance will be triggered on VM shutdown.
resource.reservationSubBlockMaintenance.upcomingGroupMaintenance.maintenanceReasons[]

enum

The reasons for the maintenance. Only valid for vms.
resource.reservationSubBlockMaintenance.maintenanceOngoingCount

integer

Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have ongoing maintenance.
resource.reservationSubBlockMaintenance.maintenancePendingCount

integer

Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have pending maintenance.
resource.reservationSubBlockMaintenance.schedulingType

enum

The type of maintenance for the reservation.
resource.reservationSubBlockMaintenance.subblockInfraMaintenanceOngoingCount

integer

Describes number of subblock Infrastructure that has ongoing maintenance. Here, Subblock Infrastructure Maintenance pertains to upstream hardware contained in the Subblock that is necessary for a VM Family(e.g. NVLink Domains). Not all VM Families will support this field.
resource.reservationSubBlockMaintenance.subblockInfraMaintenancePendingCount

integer

Describes number of subblock Infrastructure that has pending maintenance. Here, Subblock Infrastructure Maintenance pertains to upstream hardware contained in the Subblock that is necessary for a VM Family (e.g. NVLink Domains). Not all VM Families will support this field.
resource.reservationSubBlockMaintenance.instanceMaintenanceOngoingCount

integer

Describes number of instances that have ongoing maintenance.
resource.reservationSubBlockMaintenance.instanceMaintenancePendingCount

integer

Describes number of instances that have pending maintenance.
resource.status

enum

[Output Only] Status of the reservation subBlock.
resource.physicalTopology

object

[Output Only] The physical topology of the reservation subBlock.
resource.physicalTopology.cluster

string

The cluster name of the reservation subBlock.
resource.physicalTopology.block

string

The hash of the capacity block within the cluster.
resource.physicalTopology.subBlock

string

The hash of the capacity sub-block within the capacity block.
resource.inUseHostCount

integer

Number of hosts currently in use. If there is one or more Instances running on the host, it is considered in use.
resource.healthInfo

object

[Output Only] Health information for the reservation subBlock.
resource.healthInfo.healthStatus

enum

The health status of the reservation subBlock.
resource.healthInfo.healthyHostCount

integer

The number of healthy hosts in the reservation subBlock.
resource.healthInfo.degradedHostCount

integer

The number of degraded hosts in the reservation subBlock.
resource.healthInfo.healthyInfraCount

integer

The number of healthy infrastructure (e.g NV link domain) in the reservation subblock.
resource.healthInfo.degradedInfraCount

integer

The number of degraded infrastructure (e.g NV link domain) in the reservation subblock.

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.

IAM Permissions

In addition to any permissions specified on the fields above, authorization requires one or more of the following IAM permissions:

  • compute.reservationSubBlocks.get

To find predefined roles that contain those permissions, see Compute Engine IAM Roles.