Compute Cloud API, REST: GpuCluster.List
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 |
pageToken |
string Page token. To get the next page of results, set |
filter |
string A filter expression that filters GPU clusters listed in the response. The expression must specify:
|
orderBy |
string A sorting expression that sorts GPU clusters listed in the response. The expression must specify the field name from GpuCluster and Default value: |
Response
HTTP Code: 200 - OK
{
"gpuClusters": [
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "string",
"status": "string",
"zoneId": "string",
"interconnectType": "string"
}
],
"nextPageToken": "string"
}
Field |
Description |
gpuClusters[] |
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 Each subsequent page will have its own |
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 To work with values in this field, use the APIs described in the |
name |
string Name of the GPU cluster. The name is unique within the folder. |
description |
string Description of the GPU cluster. |
labels |
string GPU cluster labels as |
status |
enum (Status) Status of the GPU cluster.
|
zoneId |
string ID of the availability zone where the GPU cluster resides. |
interconnectType |
enum (GpuInterconnectType) Type of interconnect used for this GPU cluster.
|