Method: reservationSlots.get

Retrieves information about the specified reservation slot.

HTTP request

GET https://compute.googleapis.com/compute/beta/projects/{project}/zones/{zone}/{parentName=reservations/*/reservationBlocks/*/reservationSubBlocks/*}/reservationSlots/{reservationSlot}

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

The project ID for this request.
zone

string

The name of the zone for this request, formatted as RFC1035.
parentName

string

The name of the parent reservation and parent block, formatted as reservations/{reservationName}/reservationBlocks/{reservation_block_name}/reservationSubBlocks/{reservation_sub_block_name}
reservationSlot

string

The name of the reservation slot, formatted as RFC1035 or a resource ID number.

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,
    "physicalTopology": {
      "cluster": string,
      "block": string,
      "subBlock": string,
      "host": string
    },
    "state": enum,
    "status": {
      "physicalTopology": {
        "cluster": string,
        "block": string,
        "subBlock": string,
        "host": string
      },
      "rdmaIpAddresses": [
        string
      ],
      "runningInstances": [
        string
      ]
    },
    "shareSettings": {
      "shareType": enum,
      "projects": [
        string
      ],
      "projectMap": {
        string: {
          "projectId": string
        },
        ...
      }
    }
  }
}
Fields
resource

object
resource.kind

string

Output only. The type of resource. Always compute#reservationSlot for reservation slots.
resource.id

string (uint64 format)

Output only. The unique identifier for this resource. This identifier is defined by the server.
resource.creationTimestamp

string

Output only. The creation timestamp, formatted as RFC3339 text.
resource.name

string

Output only. The name of the reservation slot.
resource.zone

string

Output only. The zone in which the reservation slot resides.
resource.selfLink

string

Output only. A server-defined fully-qualified URL for this resource.
resource.selfLinkWithId

string

Output only. A server-defined URL for this resource with the resource ID.
resource.physicalTopology
(deprecated)

object

Output only. The physical topology of the reservation slot.
resource.physicalTopology
(deprecated).cluster

string

The cluster name of the reservation sub-block.
resource.physicalTopology
(deprecated).block

string

The unique identifier of the capacity block within the cluster.
resource.physicalTopology
(deprecated).subBlock

string

The unique identifier of the capacity sub-block within the capacity block.
resource.physicalTopology
(deprecated).host

string

The unique identifier of the capacity host within the capacity sub-block.
resource.state

enum

Output only. The state of the reservation slot.
resource.status

object

Output only. The status of the reservation slot.
resource.status.physicalTopology

object

Output only. The physical topology of the reservation sub-block.
resource.status.physicalTopology.cluster

string

The cluster name of the reservation sub-block.
resource.status.physicalTopology.block

string

The unique identifier of the capacity block within the cluster.
resource.status.physicalTopology.subBlock

string

The unique identifier of the capacity sub-block within the capacity block.
resource.status.physicalTopology.host

string

The unique identifier of the capacity host within the capacity sub-block.
resource.status.rdmaIpAddresses[]

string

Output only. The RDMA IP address of the physical host.
resource.status.runningInstances[]

string

Output only. The URIs of the instances currently running on this slot.
resource.shareSettings

object

Specify share settings to create a shared slot. Set to empty to inherit the share settings from a parent resource.
resource.shareSettings.shareType

enum

Type of sharing for this shared-reservation
resource.shareSettings.projects[]

string

A reservationSlots.list of Project names to specify consumer projects for this shared-reservation. This is only valid when shareType's value is SPECIFIC_PROJECTS.
resource.shareSettings.projectMap[]

map (key: string, value: object)

A map of project id and project config. This is only valid when shareType's value is SPECIFIC_PROJECTS.
resource.shareSettings.projectMap[].projectId

string

The project ID, should be same as the key of this project config in the parent map.

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.reservationSlots.get

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