Contact UsTry it for free
© 2026 Direct Cursus Technology L.L.C.

Information about existing clusters

Written by
Updated at January 29, 2026

You can request detailed information for each YTsaurus cluster you have created.

Getting a list of clusters in a folder

  1. In the management console, navigate to the relevant folder.
  2. Go to Managed Service for YTsaurus.

If you do not have the Yandex Cloud CLI installed yet, install and initialize it.

By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.

To get a list of YTsaurus clusters in the default folder, run this command:

yc managed-ytsaurus cluster list

Result:

+----------------------+---------------------+---------------+----------------------+---------------------+---------+
|          ID          |        NAME         |    ZONE ID    |      SUBNET ID       |     CREATED AT      | STATUS  |
+----------------------+---------------------+---------------+----------------------+---------------------+---------+
| cnkvtb40gk87******** | my-ytsaurus-cluster | ru-central1-a | e9bp8qmchqh28******* | 2025-10-06 11:07:44 | RUNNING |
+----------------------+---------------------+---------------+----------------------+---------------------+---------+

  1. Get an IAM token for API authentication and put it in an environment variable:

    export IAM_TOKEN="<IAM_token>"

  2. Call the Cluster.List method, e.g., via the following cURL request:

    curl \
    --request GET \
    --header "Authorization: Bearer $IAM_TOKEN" \
    --url 'https://ytsaurus.api.cloud.yandex.net/ytsaurus/v1/clusters' \
    --url-query folderId=<folder_ID>

    You can get the folder ID with the list of folders in the cloud.

  3. Check the server response to make sure your request was successful.

  1. Get an IAM token for API authentication and put it in an environment variable:

    export IAM_TOKEN="<IAM_token>"

  2. Clone the cloudapi repository:

    cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi

    Below, we assume that the repository contents reside in the ~/cloudapi/ directory.

  3. Call the ClusterService.List method, e.g., via the following gRPCurl request:

    grpcurl \
    -format json \
    -import-path ~/cloudapi/ \
    -import-path ~/cloudapi/third_party/googleapis/ \
    -proto ~/cloudapi/yandex/cloud/ytsaurus/v1/cluster_service.proto \
    -rpc-header "Authorization: Bearer $IAM_TOKEN" \
    -d '{
            "folder_id": "<folder_ID>"
        }' \
    ytsaurus.api.cloud.yandex.net:443 \
    yandex.cloud.ytsaurus.v1.ClusterService.List

    You can get the folder ID with the list of folders in the cloud.

  4. Check the server response to make sure your request was successful.

Getting detailed information about a cluster

  1. In the management console, navigate to the relevant folder.
  2. Go to Managed Service for YTsaurus.
  3. Click the name of your cluster.

If you do not have the Yandex Cloud CLI installed yet, install and initialize it.

By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.

To get YTsaurus cluster details, run the following command:

yc managed-ytsaurus cluster get <cluster_name_or_ID>

You can get the cluster ID and name with the list of clusters in the folder.

  1. Get an IAM token for API authentication and put it in an environment variable:

    export IAM_TOKEN="<IAM_token>"

  2. Call the Cluster.Get method, e.g., via the following cURL request:

    curl \
    --request GET \
    --header "Authorization: Bearer $IAM_TOKEN" \
    --url 'https://ytsaurus.api.cloud.yandex.net/ytsaurus/v1/clusters/<cluster_ID>'

    You can get the cluster ID with the list of clusters in the folder.

  3. Check the server response to make sure your request was successful.

  1. Get an IAM token for API authentication and put it in an environment variable:

    export IAM_TOKEN="<IAM_token>"

  2. Clone the cloudapi repository:

    cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi

    Below, we assume that the repository contents reside in the ~/cloudapi/ directory.

  3. Call the ClusterService.Get method, e.g., via the following gRPCurl request:

    grpcurl \
    -format json \
    -import-path ~/cloudapi/ \
    -import-path ~/cloudapi/third_party/googleapis/ \
    -proto ~/cloudapi/yandex/cloud/ytsaurus/v1/cluster_service.proto \
    -rpc-header "Authorization: Bearer $IAM_TOKEN" \
    -d '{
            "cluster_id": "<cluster_ID>"
        }' \
    ytsaurus.api.cloud.yandex.net:443 \
    yandex.cloud.ytsaurus.v1.ClusterService.Get

    You can get the cluster ID with the list of clusters in the folder.

  4. Check the server response to make sure your request was successful.

Viewing operations with clusters

All actions performed on YTsaurus clusters are logged, Each operation gets its own unique ID.

Getting a list of operations

To get a list of operations for a YTsaurus cluster:

  1. In the management console, open the folder containing your cluster.

  2. Go to Managed Service for YTsaurus.

  3. In the left-hand panel, select Clusters.

  4. Select the cluster.

  5. Navigate to the Operations panel for the selected cluster.

    You will see a list of operations with the cluster.

Getting operation details

  1. Get the list of cluster operations.

  2. Copy the ID of the operation you need.

  3. Get operation details:

    If you do not have the Yandex Cloud CLI installed yet, install and initialize it.

    By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.

    Run this command:

    yc operation get <operation_ID>

    Result:

    id: b9k4900r7k**********
description: Create cluster
created_at: "2025-07-11T14:17:29.915505Z"
created_by: ajeuoi52dg**********
modified_at: "2025-07-11T15:12:44.572840Z"
done: true
metadata:
  '@type': type.googleapis.com/yandex.cloud.ytsaurus.v1.CreateClusterMetadata
  cluster_id: cnkgf75gu***********
response:
  '@type': type.googleapis.com/yandex.cloud.ytsaurus.v1.Cluster
  ...

    1. Get an IAM token for API authentication and put it in an environment variable:

      export IAM_TOKEN="<IAM_token>"

    2. Call the Operation.Get method, e.g., via the following cURL request:

      curl \
    --request GET \
    --header "Authorization: Bearer $IAM_TOKEN" \
    --url 'https://operation.api.cloud.yandex.net/operations/<operation_ID>'

    3. Check the server response to make sure your request was successful.

    1. Get an IAM token for API authentication and put it in an environment variable:

      export IAM_TOKEN="<IAM_token>"

    2. Clone the cloudapi repository:

      cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi

      Below, we assume that the repository contents reside in the ~/cloudapi/ directory.

    3. Call the OperationService.Get method, e.g., via the following gRPCurl request:

      grpcurl \
    -format json \
    -import-path ~/cloudapi/ \
    -import-path ~/cloudapi/third_party/googleapis/ \
    -proto ~/cloudapi/yandex/cloud/operation/operation_service.proto \
    -rpc-header "Authorization: Bearer $IAM_TOKEN" \
    -d '{
            "operation_id": "<operation_ID>"
        }' \
    operation.api.cloud.yandex.net:443 \
    yandex.cloud.operation.OperationService.Get

    4. Check the server response to make sure your request was successful.

Previous
All guides
Next
Creating a cluster