Contact UsGet started

Compute Cloud API, gRPC: GpuClusterService.List

Written by
Updated at January 14, 2025

Retrieves the list of GPU clusters in the specified folder.

gRPC request

rpc List (ListGpuClustersRequest) returns (ListGpuClustersResponse)

ListGpuClustersRequest

{
  "folder_id": "string",
  "page_size": "int64",
  "page_token": "string",
  "filter": "string",
  "order_by": "string"
}

Field

Description

folder_id

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.

page_size

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.next_page_token
that can be used to get the next page of results in subsequent list requests.

page_token

string

Page token. To get the next page of results, set page_token to the
ListGpuClustersResponse.next_page_token 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.

order_by

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.

ListGpuClustersResponse

{
  "gpu_clusters": [
    {
      "id": "string",
      "folder_id": "string",
      "created_at": "google.protobuf.Timestamp",
      "name": "string",
      "description": "string",
      "labels": "map<string, string>",
      "status": "Status",
      "zone_id": "string",
      "interconnect_type": "GpuInterconnectType"
    }
  ],
  "next_page_token": "string"
}

Field

Description

gpu_clusters[]

GpuCluster

List of GPU clusters in the specified folder.

next_page_token

string

Token for getting the next page of the list. If the number of results is greater than
the specified ListGpuClustersRequest.page_size, use next_page_token as the value
for the ListGpuClustersRequest.page_token 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.

folder_id

string

ID of the folder that the GPU cluster belongs to.

created_at

google.protobuf.Timestamp

Creation timestamp.

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.

zone_id

string

ID of the availability zone where the GPU cluster resides.

interconnect_type

enum GpuInterconnectType

Type of interconnect used for this GPU cluster.

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