Method: reservationSubBlocks.get

Retrieves information about the specified reservation subBlock.

HTTP request

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

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.
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,
    "status": enum,
    "physicalTopology": {
      "cluster": string,
      "block": string,
      "subBlock": string
    }
  }
}
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.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.

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.