Yandex.Cloud
  • Сервисы
  • Почему Yandex.Cloud
  • Сообщество
  • Решения
  • Тарифы
  • Документация
  • Связаться с нами
Подключиться
Yandex Managed Service for Apache Kafka®
  • Начало работы
  • Пошаговые инструкции
    • Все инструкции
    • Информация об имеющихся кластерах
    • Создание кластера
    • Подключение к кластеру
    • Остановка и запуск кластера
    • Изменение настроек кластера
    • Управление хостами Apache Kafka®
    • Работа с топиками и разделами
    • Управление учетными записями Kafka
    • Удаление кластера
  • Сценарии использования
    • Поставка данных в Managed Service for ClickHouse
  • Концепции
    • Взаимосвязь ресурсов сервиса
    • Топики и разделы
    • Брокеры
    • Производители и потребители
    • Классы хостов
    • Сеть в Managed Service for Apache Kafka®
    • Квоты и лимиты
    • Типы хранилища
  • Управление доступом
  • Правила тарификации
  • Справочник API
    • Аутентификация в API
    • gRPC
      • Обзор
      • ClusterService
      • OperationService
      • ResourcePresetService
      • TopicService
      • UserService
      • OperationService
    • REST
      • Обзор
      • Cluster
        • Обзор
        • create
        • delete
        • get
        • list
        • listHosts
        • listLogs
        • listOperations
        • move
        • start
        • stop
        • streamLogs
        • update
      • Operation
        • Обзор
        • get
      • ResourcePreset
        • Обзор
        • get
        • list
      • Topic
        • Обзор
        • create
        • delete
        • get
        • list
        • update
      • User
        • Обзор
        • create
        • delete
        • get
        • grantPermission
        • list
        • revokePermission
        • update
  • Вопросы и ответы
  1. Справочник API
  2. REST
  3. User
  4. list

Метод list

  • HTTP-запрос
  • Path-параметры
  • Query-параметры
  • Ответ

Получает список пользователей Kafka в указанном кластере.

HTTP-запрос

GET https://mdb.api.cloud.yandex.net/managed-kafka/v1/clusters/{clusterId}/users

Path-параметры

Параметр Описание
clusterId Обязательное поле. Идентификатор кластера Apache Kafka®, для которого нужно получить список пользователей. Чтобы получить идентификатор кластера Apache Kafka®, выполните запрос list. Максимальная длина строки в символах — 50.

Query-параметры

Параметр Описание
pageSize Максимальное количество результатов на одной странице в ответе. Если количество результатов больше чем pageSize, сервис вернет значение nextPageToken, которое можно использовать для получения следующей страницы. Максимальное значение — 1000.
pageToken Токен страницы. Установите значение pageToken равным значению поля nextPageToken предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100.

Ответ

HTTP Code: 200 - OK

{
  "users": [
    {
      "name": "string",
      "clusterId": "string",
      "permissions": [
        {
          "topicName": "string",
          "role": "string"
        }
      ]
    }
  ],
  "nextPageToken": "string"
}
Поле Описание
users[] object

Пользователь Kafka. Подробнее читайте в разделе Operations → Accounts документации.

users[].
name
string

Имя пользователя Kafka.

users[].
clusterId
string

Идентификатор кластера Apache Kafka®, к которому принадлежит пользователь.

Чтобы получить идентификатор кластера Apache Kafka®, выполните запрос list.

users[].
permissions[]
object

Набор разрешений, предоставленных пользователю.

users[].
permissions[].
topicName
string

Имя топика, к которому предоставляется доступ.

Чтобы получить имя топика, выполните запрос list.

users[].
permissions[].
role
string

Роль доступа, которую нужно предоставить пользователю.

  • ACCESS_ROLE_PRODUCER: роль пользователя — производитель.
  • ACCESS_ROLE_CONSUMER: роль пользователя — потребитель.
nextPageToken string

Токен для получения следующей страницы результатов в ответе.

Если количество результатов больше чем pageSize, используйте nextPageToken в качестве значения параметра pageToken в следующем запросе. Все последующие запросы будут получать свои значения nextPageToken для перебора страниц результатов.

В этой статье:
  • HTTP-запрос
  • Path-параметры
  • Query-параметры
  • Ответ
Language
Вакансии
Политика конфиденциальности
Условия использования
© 2021 ООО «Яндекс.Облако»