Информация об имеющихся кластерах в Managed Service for Apache Kafka®

Статья создана

Yandex Cloud

Обновлена 27 декабря 2024 г.

Получить список кластеров в каталоге
Получить детальную информацию о кластере
Посмотреть операции с кластерами

Вы можете запросить детальную информацию о каждом созданном вами кластере Managed Service for Apache Kafka®.

Получить список кластеров в каталоге

Консоль управления

CLI

REST API

gRPC API

В консоли управления перейдите в нужный каталог.
В списке сервисов выберите Managed Service for Kafka.

Если у вас еще нет интерфейса командной строки Yandex Cloud, установите и инициализируйте его.

По умолчанию используется каталог, указанный в профиле CLI. Вы можете указать другой каталог с помощью параметра --folder-name или --folder-id.

Чтобы запросить список кластеров Apache Kafka® в каталоге по умолчанию, выполните команду:

yc managed-kafka cluster list

Результат:

+----------------------+----------+---------------------+--------+---------+
|          ID          |   NAME   |     CREATED AT      | HEALTH | STATUS  |
+----------------------+----------+---------------------+--------+---------+
| c9qaruvk2mma******** | kafka750 | 2020-12-18 05:21:27 | ALIVE  | RUNNING |
| ...                                                                      |
+----------------------+----------+---------------------+--------+---------+

Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:
```
export IAM_TOKEN="<IAM-токен>"
```
Воспользуйтесь методом Cluster.list и выполните запрос, например, с помощью cURL:
```
curl \
  --request GET \
  --header "Authorization: Bearer $IAM_TOKEN" \
  --url 'https://mdb.api.cloud.yandex.net/managed-kafka/v1/clusters' \
  --url-query folderId=<идентификатор_каталога>
```
Идентификатор каталога можно запросить со списком каталогов в облаке.
Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:
```
export IAM_TOKEN="<IAM-токен>"
```
Клонируйте репозиторий cloudapi:
```
cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
```
Далее предполагается, что содержимое репозитория находится в директории ~/cloudapi/.

Воспользуйтесь вызовом ClusterService/List и выполните запрос, например, с помощью gRPCurl:

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

Идентификатор каталога можно запросить со списком каталогов в облаке.

Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

Получить детальную информацию о кластере

Консоль управления

CLI

REST API

gRPC API

В консоли управления перейдите в нужный каталог.
В списке сервисов выберите Managed Service for Kafka.
Нажмите на имя нужного кластера.

Если у вас еще нет интерфейса командной строки Yandex Cloud, установите и инициализируйте его.

Чтобы получить информацию о кластере Apache Kafka®, выполните команду:

yc managed-kafka cluster get <имя_или_идентификатор_кластера>

Идентификатор и имя кластера можно запросить со списком кластеров в каталоге.

Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:
```
export IAM_TOKEN="<IAM-токен>"
```
Воспользуйтесь методом Cluster.get и выполните запрос, например, с помощью cURL:
```
curl \
    --request GET \
    --header "Authorization: Bearer $IAM_TOKEN" \
    --url 'https://mdb.api.cloud.yandex.net/managed-kafka/v1/clusters/<идентификатор_кластера>'
```
Идентификатор кластера можно запросить со списком кластеров в каталоге.
Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:
```
export IAM_TOKEN="<IAM-токен>"
```
Клонируйте репозиторий cloudapi:
```
cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
```
Далее предполагается, что содержимое репозитория находится в директории ~/cloudapi/.

Воспользуйтесь вызовом ClusterService/Get и выполните запрос, например, с помощью gRPCurl:

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

Идентификатор кластера можно запросить со списком кластеров в каталоге.

Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

Посмотреть операции с кластерами

Все действия с кластерами Managed Service for Apache Kafka® сохраняются в виде списка операций. Каждой операции присваивается уникальный идентификатор.

Получить список операций

Консоль управления

CLI

REST API

gRPC API

Чтобы получить список операций для кластера:

В консоли управления откройте каталог, в котором находится кластер.
Выберите сервис Managed Service for Kafka.
На панели слева выберите Кластеры.
Выберите нужный кластер.
Перейдите на панель Операции для выбранного кластера.

В открывшемся списке отображаются операции с выбранным кластером.

Если у вас еще нет интерфейса командной строки Yandex Cloud, установите и инициализируйте его.

Чтобы получить список операций для кластера Managed Service for Apache Kafka®, воспользуйтесь командой:

yc managed-kafka cluster list-operations <имя_или_идентификатор_кластера>

Результат:

+----------------------+---------------------+----------------------+---------------------+--------+-----------------------------+
|          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 |
+----------------------+---------------------+----------------------+---------------------+--------+-----------------------------+

Идентификатор и имя кластера можно получить со списком кластеров в каталоге.

По умолчанию информация об операциях выводится в текстовом формате. Чтобы получить более подробную информацию, укажите формат yaml или json для выводимых данных с помощью флага --format:

yc managed-kafka cluster list-operations c9qk2926qqu9******** --format yaml

Результат:

- 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

Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:
```
export IAM_TOKEN="<IAM-токен>"
```
Воспользуйтесь методом Cluster.listOperations и выполните запрос, например, с помощью cURL:
```
curl \
    --request GET \
    --header "Authorization: Bearer $IAM_TOKEN" \
    --url 'https://mdb.api.cloud.yandex.net/managed-kafka/v1/clusters/<идентификатор_кластера>/operations'
```
Идентификатор кластера можно получить со списком кластеров в каталоге.
Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:
```
export IAM_TOKEN="<IAM-токен>"
```
Клонируйте репозиторий cloudapi:
```
cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
```
Далее предполагается, что содержимое репозитория находится в директории ~/cloudapi/.

Воспользуйтесь вызовом ClusterService/ListOperations и выполните запрос, например, с помощью gRPCurl:

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

Идентификатор кластера можно получить со списком кластеров в каталоге.

Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

Получить подробную информацию об операции

Получите список операций для кластера.
Скопируйте идентификатор нужной операции.
Получите подробную информацию об операции:
CLI

REST API

gRPC API
Если у вас еще нет интерфейса командной строки Yandex Cloud, установите и инициализируйте его.

По умолчанию используется каталог, указанный в профиле CLI. Вы можете указать другой каталог с помощью параметра --folder-name или --folder-id.

Выполните команду:
```
yc operation get <идентификатор_операции>
```
Результат:
```
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
...
```
1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:
  export IAM_TOKEN="<IAM-токен>"
2. Воспользуйтесь методом Operation.get и выполните запрос, например, с помощью cURL:
  curl \ --request GET \ --header "Authorization: Bearer $IAM_TOKEN" \ --url 'https://operation.api.cloud.yandex.net/operations/<идентификатор_операции>'
3. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.
1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:
  export IAM_TOKEN="<IAM-токен>"
2. Клонируйте репозиторий cloudapi:
  cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
  Далее предполагается, что содержимое репозитория находится в директории ~/cloudapi/.
3. Воспользуйтесь вызовом OperationService/Get и выполните запрос, например, с помощью gRPCurl:
  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
4. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

См. также

Работа с операциями

Информация об имеющихся кластерах в Managed Service for Apache Kafka®

Получить список кластеров в каталогеПолучить список кластеров в каталоге

Получить детальную информацию о кластереПолучить детальную информацию о кластере

Посмотреть операции с кластерамиПосмотреть операции с кластерами

Получить список операцийПолучить список операций

Получить подробную информацию об операцииПолучить подробную информацию об операции

См. такжеСм. также

Была ли статья полезна?

Получить список кластеров в каталоге

Получить детальную информацию о кластере

Посмотреть операции с кластерами

Получить список операций

Получить подробную информацию об операции

См. также