Метод 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.

Параметр

Описание

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 для перебора страниц результатов.