Contact usConsole
© 2023 Nebius Israel Ltd
Compute Cloud

Compute Cloud API, REST: GpuCluster.list

Retrieves the list of GPU clusters in the specified folder.

HTTP request

GET https://compute.api.il.nebius.cloud/compute/v1/gpuClusters

Query parameters

Parameter Description
folderId

Required. ID of the folder to list GPU clusters in.

To get the folder ID, make a list request.

The maximum string length in characters is 50.
pageSize

The maximum number of results per page to return. If the number of available results is larger than page_size, the service returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

The maximum value is 1000.
pageToken

Page token. To get the next page of results, set page_token to the nextPageToken returned by a previous list request.

The maximum string length in characters is 100.
filter

A filter expression that filters GPU clusters listed in the response.

The expression must specify:

  1. The field name. Currently you can use filtering only on GpuCluster.name field.
  2. An operator. Can be either = or != for single values, IN or NOT IN for lists of values.
  3. The value. Must be 3-63 characters long and match the regular expression ^[a-z][-a-z0-9]{1,61}[a-z0-9]. Example of a filter: name=my-schedule.

The maximum string length in characters is 1000.
orderBy

A sorting expression that sorts GPU clusters listed in the response.

The expression must specify the field name from GpuCluster and ascending or descending order, e.g. createdAt desc.

Default value: id asc.

The maximum string length in characters is 100.

Response

HTTP Code: 200 - OK

{
  "gpuClusters": [
    {
      "id": "string",
      "folderId": "string",
      "createdAt": "string",
      "name": "string",
      "description": "string",
      "labels": "object",
      "status": "string",
      "zoneId": "string",
      "interconnectType": "string"
    }
  ],
  "nextPageToken": "string"
}
Field Description
gpuClusters[] object

List of GPU clusters in the specified folder.
gpuClusters[].
id		 string

ID of GPU cluster.
gpuClusters[].
folderId		 string

ID of the folder that the GPU cluster belongs to.
gpuClusters[].
createdAt		 string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
gpuClusters[].
name		 string

Name of the GPU cluster.

The name is unique within the folder.
gpuClusters[].
description		 string

Description of the GPU cluster.
gpuClusters[].
labels		 object

GPU cluster labels as key:value pairs.
gpuClusters[].
status		 string

Status of the GPU cluster.

  • CREATING: GPU cluster is being created.
  • READY: GPU cluster is ready to use.
  • ERROR: GPU cluster encountered a problem and cannot operate.
  • DELETING: GPU cluster is being deleted.
gpuClusters[].
zoneId		 string

ID of the availability zone where the GPU cluster resides.
gpuClusters[].
interconnectType		 string

Type of interconnect used for this GPU cluster.

  • INFINIBAND: InfiniBand interconnect.
nextPageToken string

Token for getting the next page of the list. If the number of results is greater than the specified pageSize, use next_page_token as the value for the pageToken parameter in the next list request.

Each subsequent page will have its own next_page_token to continue paging through the results.
© 2023 Nebius Israel Ltd
In this article: