Contact UsGet started

Compute Cloud API, REST: GpuCluster.List

Written by
Updated at January 14, 2025

Retrieves the list of GPU clusters in the specified folder.

HTTP request

GET https://compute.api.cloud.yandex.net/compute/v1/gpuClusters

Query parameters

Field

Description

folderId

string

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

To get the folder ID, make a yandex.cloud.resourcemanager.v1.FolderService.List request.

pageSize

string (int64)

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

pageToken

string

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

filter

string

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.

orderBy

string

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.

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[]

GpuCluster

List of GPU clusters in the specified folder.

nextPageToken

string

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

Each subsequent page will have its own next_page_token to continue paging through the results.

GpuCluster

A GPU cluster. For details about the concept, see documentation.

Field

Description

id

string

ID of GPU cluster.

folderId

string

ID of the folder that the GPU cluster belongs to.

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

name

string

Name of the GPU cluster.

The name is unique within the folder.

description

string

Description of the GPU cluster.

labels

object (map<string, string>)

GPU cluster labels as key:value pairs.

status

enum (Status)

Status of the GPU cluster.

  • STATUS_UNSPECIFIED
  • 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.

zoneId

string

ID of the availability zone where the GPU cluster resides.

interconnectType

enum (GpuInterconnectType)

Type of interconnect used for this GPU cluster.

  • GPU_INTERCONNECT_TYPE_UNSPECIFIED
  • INFINIBAND: InfiniBand interconnect.
Previous
Get
Next
Create