Method: reservationSlots.list

Retrieves a list of reservation slots under a single reservation.

HTTP request

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

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}

Query parameters

Parameters
maxResults

integer (uint32 format)

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)
pageToken

string

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter

string

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request.

If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either =, !=, >, <, <=, >= or :.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use:

labels.owner:*

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example:

(scheduling.automaticRestart = true)
(cpuPlatform = "Intel Skylake")

By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example:

(cpuPlatform = "Intel Skylake") OR
(cpuPlatform = "Intel Broadwell") AND
(scheduling.automaticRestart = true)

If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples:

fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal")

The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field.

For example, to filter for instances that do not end with name "instance", you would use name ne .*instance.

You cannot combine constraints on multiple fields using regular expressions.
orderBy

string

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
returnPartialSuccess

boolean

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

Request body

The request body must be empty.

Response body

A list of reservation slots within a single reservation.

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

JSON representation 
{
  "kind": string,
  "id": string,
  "items": [
    {
      "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
          },
          ...
        }
      }
    }
  ],
  "nextPageToken": string,
  "selfLink": string,
  "warning": {
    "code": enum,
    "message": string,
    "data": [
      {
        "key": string,
        "value": string
      }
    ]
  }
}
Fields
kind

string

The type of resource. Always compute#reservationSlot for a list of reservation slots.
id

string

The unique identifier for the resource; defined by the server.
items[]

object

A list of reservation slot resources.
items[].kind

string

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

string (uint64 format)

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

string

Output only. The creation timestamp, formatted as RFC3339 text.
items[].name

string

Output only. The name of the reservation slot.
items[].zone

string

Output only. The zone in which the reservation slot resides.
items[].selfLink

string

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

string

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

object

Output only. The physical topology of the reservation slot.
items[].physicalTopology
(deprecated).cluster

string

The cluster name of the reservation sub-block.
items[].physicalTopology
(deprecated).block

string

The unique identifier of the capacity block within the cluster.
items[].physicalTopology
(deprecated).subBlock

string

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

string

The unique identifier of the capacity host within the capacity sub-block.
items[].state

enum

Output only. The state of the reservation slot.
items[].status

object

Output only. The status of the reservation slot.
items[].status.physicalTopology

object

Output only. The physical topology of the reservation sub-block.
items[].status.physicalTopology.cluster

string

The cluster name of the reservation sub-block.
items[].status.physicalTopology.block

string

The unique identifier of the capacity block within the cluster.
items[].status.physicalTopology.subBlock

string

The unique identifier of the capacity sub-block within the capacity block.
items[].status.physicalTopology.host

string

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

string

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

string

Output only. The URIs of the instances currently running on this slot.
items[].shareSettings

object

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

enum

Type of sharing for this shared-reservation
items[].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.
items[].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.
items[].shareSettings.projectMap[].projectId

string

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

string

This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
warning

object

An informational warning message.
warning.code

enum

Output only. A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
warning.message

string

Output only. A human-readable description of the warning code.
warning.data[]

object

Output only. Metadata about this warning in key: value format. For example: 

"data": [  {  "key": "scope",  "value": "zones/us-east1-d"  }
warning.data[].key

string

Output only. A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
warning.data[].value

string

Output only. A warning data value corresponding to the key.

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

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