[Yandex Cloud documentation](../../index.md) > [Yandex Managed Service for Apache Kafka®](../index.md) > [Step-by-step guides](index.md) > Clusters > Information about existing clusters # Information about existing clusters in Managed Service for Apache Kafka® You can get detailed information about each Managed Service for Apache Kafka® cluster you created. ## Getting a list of clusters in a folder {#list-clusters} {% list tabs group=instructions %} - Management console {#console} 1. In the [management console](https://console.yandex.cloud), navigate to the relevant folder. 1. Navigate to **Managed Service for Kafka**. - CLI {#cli} If you do not have the Yandex Cloud CLI yet, [install and initialize it](../../cli/quickstart.md#install). The folder used by default is the one specified when [creating](../../cli/operations/profile/profile-create.md) the CLI profile. To change the default folder, use the `yc config set folder-id ` command. You can also specify a different folder for any command using `--folder-name` or `--folder-id`. If you access a resource by its name, the search will be limited to the default folder. If you access a resource by its ID, the search will be global, i.e., through all folders based on access permissions. To get a list of Apache Kafka® clusters in the default folder, run this command: ``` yc managed-kafka cluster list ``` Result: ``` +----------------------+----------+---------------------+--------+---------+ | ID | NAME | CREATED AT | HEALTH | STATUS | +----------------------+----------+---------------------+--------+---------+ | c9qaruvk2mma******** | kafka750 | 2020-12-18 05:21:27 | ALIVE | RUNNING | | ... | +----------------------+----------+---------------------+--------+---------+ ``` - REST API {#api} 1. [Get an IAM token for API authentication](../api-ref/authentication.md) and put it into an environment variable: ```bash export IAM_TOKEN="" ``` 1. Call the [Cluster.list](../api-ref/Cluster/list.md) method, e.g., via the following [cURL](https://curl.se/) request: ```bash curl \ --request GET \ --header "Authorization: Bearer $IAM_TOKEN" \ --url 'https://mdb.api.cloud.yandex.net/managed-kafka/v1/clusters' \ --url-query folderId= ``` You can get the folder ID with the [list of folders in the cloud](../../resource-manager/operations/folder/get-id.md). 1. Check the [server response](../api-ref/Cluster/list.md#yandex.cloud.mdb.kafka.v1.ListClustersResponse) to make sure your request was successful. - gRPC API {#grpc-api} 1. [Get an IAM token for API authentication](../api-ref/authentication.md) and put it into an environment variable: ```bash export IAM_TOKEN="" ``` 1. Clone the [cloudapi](https://github.com/yandex-cloud/cloudapi) repository: ```bash cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi ``` Below, we assume that the repository contents reside in the `~/cloudapi/` directory. 1. Call the [ClusterService/List](../api-ref/grpc/Cluster/list.md) method, e.g., via the following [gRPCurl](https://github.com/fullstorydev/grpcurl) request: ```bash grpcurl \ -format json \ -import-path ~/cloudapi/ \ -import-path ~/cloudapi/third_party/googleapis/ \ -proto ~/cloudapi/yandex/cloud/mdb/kafka/v1/cluster_service.proto \ -rpc-header "Authorization: Bearer $IAM_TOKEN" \ -d '{ "folder_id": "" }' \ mdb.api.cloud.yandex.net:443 \ yandex.cloud.mdb.kafka.v1.ClusterService.List ``` You can get the folder ID with the [list of folders in the cloud](../../resource-manager/operations/folder/get-id.md). 1. Check the [server response](../api-ref/grpc/Cluster/list.md#yandex.cloud.mdb.kafka.v1.ListClustersResponse) to make sure your request was successful. {% endlist %} ## Getting detailed information about a cluster {#get-cluster} {% list tabs group=instructions %} - Management console {#console} 1. In the [management console](https://console.yandex.cloud), navigate to the relevant folder. 1. Navigate to **Managed Service for Kafka**. 1. Click the cluster name. - CLI {#cli} If you do not have the Yandex Cloud CLI yet, [install and initialize it](../../cli/quickstart.md#install). The folder used by default is the one specified when [creating](../../cli/operations/profile/profile-create.md) the CLI profile. To change the default folder, use the `yc config set folder-id ` command. You can also specify a different folder for any command using `--folder-name` or `--folder-id`. If you access a resource by its name, the search will be limited to the default folder. If you access a resource by its ID, the search will be global, i.e., through all folders based on access permissions. To get Apache Kafka® cluster details, run the following command: ``` yc managed-kafka cluster get ``` You can get the cluster ID and name with the [list of clusters in the folder](#list-clusters). - REST API {#api} 1. [Get an IAM token for API authentication](../api-ref/authentication.md) and put it into an environment variable: ```bash export IAM_TOKEN="" ``` 1. Call the [Cluster.get](../api-ref/Cluster/get.md) method, e.g., via the following [cURL](https://curl.se/) request: ```bash curl \ --request GET \ --header "Authorization: Bearer $IAM_TOKEN" \ --url 'https://mdb.api.cloud.yandex.net/managed-kafka/v1/clusters/' ``` You can get the cluster ID with the [list of clusters in the folder](#list-clusters). 1. Check the [server response](../api-ref/Cluster/get.md#yandex.cloud.mdb.kafka.v1.Cluster) to make sure your request was successful. - gRPC API {#grpc-api} 1. [Get an IAM token for API authentication](../api-ref/authentication.md) and put it into an environment variable: ```bash export IAM_TOKEN="" ``` 1. Clone the [cloudapi](https://github.com/yandex-cloud/cloudapi) repository: ```bash cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi ``` Below, we assume that the repository contents reside in the `~/cloudapi/` directory. 1. Call the [ClusterService/Get](../api-ref/grpc/Cluster/get.md) method, e.g., via the following [gRPCurl](https://github.com/fullstorydev/grpcurl) request: ```bash grpcurl \ -format json \ -import-path ~/cloudapi/ \ -import-path ~/cloudapi/third_party/googleapis/ \ -proto ~/cloudapi/yandex/cloud/mdb/kafka/v1/cluster_service.proto \ -rpc-header "Authorization: Bearer $IAM_TOKEN" \ -d '{ "cluster_id": "" }' \ mdb.api.cloud.yandex.net:443 \ yandex.cloud.mdb.kafka.v1.ClusterService.Get ``` You can get the cluster ID with the [list of clusters in the folder](#list-clusters). 1. Check the [server response](../api-ref/grpc/Cluster/get.md#yandex.cloud.mdb.kafka.v1.Cluster) to make sure your request was successful. {% endlist %} ## Viewing operations with clusters {#list-operations} All actions with Managed Service for Apache Kafka® clusters are logged as a list of operations. Each operation gets an ID. ### Getting a list of operations {#get-operations} {% list tabs group=instructions %} - Management console {#console} To get a list of operations for a cluster: 1. In the [management console](https://console.yandex.cloud), open the folder containing the cluster. 1. Navigate to **Managed Service for Kafka**. 1. In the left-hand panel, select ![image](../../_assets/console-icons/cubes-3.svg) **Clusters**. 1. Select the cluster and open the ![image](../../_assets/console-icons/list-check.svg) **Operations** tab. You will see the list of operations with the cluster. - CLI {#cli} If you do not have the Yandex Cloud CLI yet, [install and initialize it](../../cli/quickstart.md#install). The folder used by default is the one specified when [creating](../../cli/operations/profile/profile-create.md) the CLI profile. To change the default folder, use the `yc config set folder-id ` command. You can also specify a different folder for any command using `--folder-name` or `--folder-id`. If you access a resource by its name, the search will be limited to the default folder. If you access a resource by its ID, the search will be global, i.e., through all folders based on access permissions. To get a list of operations for a Managed Service for Apache Kafka® cluster, run this command: ```bash yc managed-kafka cluster list-operations ``` Result: ```text +----------------------+---------------------+----------------------+---------------------+--------+-----------------------------+ | ID | CREATED AT | CREATED BY | MODIFIED AT | STATUS | DESCRIPTION | +----------------------+---------------------+----------------------+---------------------+--------+-----------------------------+ | dqh0ntf6batm******** | 2024-09-07 16:36:46 | aje9k8luj4qf******** | 2024-09-07 16:44:12 | DONE | Create Apache Kafka cluster | +----------------------+---------------------+----------------------+---------------------+--------+-----------------------------+ ``` You can get the cluster ID and name with the [list of clusters in the folder](#list-clusters). By default, information about operations is output as text. To get more details, specify `yaml` or `json` for the output data using the `--format` argument: ```bash yc managed-kafka cluster list-operations c9qk2926qqu9******** --format yaml ``` Result: ```text - id: dqh0ntf6batm******** description: Create Apache Kafka cluster created_at: "2024-09-07T16:36:46.816682Z" created_by: aje9k8luj4qf******** modified_at: "2024-09-07T16:44:12.944302Z" done: true metadata: '@type': type.googleapis.com/yandex.cloud.mdb.kafka.v1.CreateClusterMetadata cluster_id: c9q13q0acgv7******** response: '@type': type.googleapis.com/google.rpc.Status message: OK ``` - REST API {#api} 1. [Get an IAM token for API authentication](../api-ref/authentication.md) and put it into an environment variable: ```bash export IAM_TOKEN="" ``` 1. Call the [Cluster.listOperations](../api-ref/Cluster/listOperations.md) method, e.g., via the following [cURL](https://curl.se/) request: ```bash curl \ --request GET \ --header "Authorization: Bearer $IAM_TOKEN" \ --url 'https://mdb.api.cloud.yandex.net/managed-kafka/v1/clusters//operations' ``` You can get the cluster ID with the [list of clusters in the folder](#list-clusters). 1. Check the [server response](../api-ref/Cluster/listOperations.md#yandex.cloud.mdb.kafka.v1.ListClusterOperationsResponse) to make sure your request was successful. - gRPC API {#grpc-api} 1. [Get an IAM token for API authentication](../api-ref/authentication.md) and put it into an environment variable: ```bash export IAM_TOKEN="" ``` 1. Clone the [cloudapi](https://github.com/yandex-cloud/cloudapi) repository: ```bash cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi ``` Below, we assume that the repository contents reside in the `~/cloudapi/` directory. 1. Call the [ClusterService/ListOperations](../api-ref/grpc/Cluster/listOperations.md) method, e.g., via the following [gRPCurl](https://github.com/fullstorydev/grpcurl) request: ```bash grpcurl \ -format json \ -import-path ~/cloudapi/ \ -import-path ~/cloudapi/third_party/googleapis/ \ -proto ~/cloudapi/yandex/cloud/mdb/kafka/v1/cluster_service.proto \ -rpc-header "Authorization: Bearer $IAM_TOKEN" \ -d '{ "cluster_id": "" }' \ mdb.api.cloud.yandex.net:443 \ yandex.cloud.mdb.kafka.v1.ClusterService.ListOperations ``` You can get the cluster ID with the [list of clusters in the folder](#list-clusters). 1. Check the [server response](../api-ref/grpc/Cluster/listOperations.md#yandex.cloud.mdb.kafka.v1.ListClusterOperationsResponse) to make sure your request was successful. {% endlist %} ### Getting operation details {#get-operations-info} 1. [Get the list of operations](#get-operations) for the cluster. 1. Copy the ID of the operation you need. 1. Get the operation details: {% list tabs group=instructions %} - CLI {#cli} If you do not have the Yandex Cloud CLI yet, [install and initialize it](../../cli/quickstart.md#install). The folder used by default is the one specified when [creating](../../cli/operations/profile/profile-create.md) the CLI profile. To change the default folder, use the `yc config set folder-id ` command. You can also specify a different folder for any command using `--folder-name` or `--folder-id`. If you access a resource by its name, the search will be limited to the default folder. If you access a resource by its ID, the search will be global, i.e., through all folders based on access permissions. Run this command: ```bash yc operation get ``` Result: ```text id: dqh0ntf6batm******** description: Create Apache Kafka cluster created_at: "2024-09-07T16:36:46.816682Z" created_by: aje9k8luj4qf******** modified_at: "2024-09-07T16:44:12.944302Z" done: true metadata: '@type': type.googleapis.com/yandex.cloud.mdb.kafka.v1.CreateClusterMetadata cluster_id: c9q13q0acgv7******** response: '@type': type.googleapis.com/yandex.cloud.mdb.kafka.v1.Cluster ... ``` - REST API {#api} 1. [Get an IAM token for API authentication](../api-ref/authentication.md) and put it into an environment variable: ```bash export IAM_TOKEN="" ``` 1. Call the [Operation.get](../api-ref/Operation/get.md) method, e.g., via the following [cURL](https://curl.se/) request: ```bash curl \ --request GET \ --header "Authorization: Bearer $IAM_TOKEN" \ --url 'https://operation.api.cloud.yandex.net/operations/' ``` 1. Check the [server response](../api-ref/Operation/get.md#yandex.cloud.operation.Operation) to make sure your request was successful. - gRPC API {#grpc-api} 1. [Get an IAM token for API authentication](../api-ref/authentication.md) and put it into an environment variable: ```bash export IAM_TOKEN="" ``` 1. Clone the [cloudapi](https://github.com/yandex-cloud/cloudapi) repository: ```bash cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi ``` Below, we assume that the repository contents reside in the `~/cloudapi/` directory. 1. Call the [OperationService/Get](../api-ref/grpc/Operation/get.md) method, e.g., via the following [gRPCurl](https://github.com/fullstorydev/grpcurl) request: ```bash 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.api.cloud.yandex.net:443 \ yandex.cloud.operation.OperationService.Get ``` 1. Check the [server response](../api-ref/grpc/Operation/get.md#yandex.cloud.operation.Operation) to make sure your request was successful. {% endlist %} ### See also {#see-also} * [Working with operations](../../api-design-guide/concepts/about-async.md)