Yandex Cloud
Поиск
Связаться с намиПодключиться
  • Документация
  • Блог
  • Все сервисы
  • Статус работы сервисов
    • Популярные
    • Инфраструктура и сеть
    • Платформа данных
    • Контейнеры
    • Инструменты разработчика
    • Бессерверные вычисления
    • Безопасность
    • Мониторинг и управление ресурсами
    • Машинное обучение
    • Бизнес-инструменты
  • Все решения
    • По отраслям
    • По типу задач
    • Экономика платформы
    • Безопасность
    • Техническая поддержка
    • Каталог партнёров
    • Обучение и сертификация
    • Облако для стартапов
    • Облако для крупного бизнеса
    • Центр технологий для общества
    • Облако для интеграторов
    • Поддержка IT-бизнеса
    • Облако для фрилансеров
    • Обучение и сертификация
    • Блог
    • Документация
    • Контент-программа
    • Мероприятия и вебинары
    • Контакты, чаты и сообщества
    • Идеи
    • Истории успеха
    • Тарифы Yandex Cloud
    • Промоакции и free tier
    • Правила тарификации
  • Документация
  • Блог
Проект Яндекса
© 2025 ООО «Яндекс.Облако»
Yandex Managed Service for Apache Kafka®
  • Начало работы
  • Управление доступом
  • Правила тарификации
  • Справочник Terraform
    • Аутентификация в API
      • Overview
        • Overview
        • Get
        • List
        • Create
        • Update
        • Delete
        • GrantPermission
        • RevokePermission
  • Метрики Yandex Monitoring
  • Аудитные логи Audit Trails
  • Публичные материалы
  • История изменений
  • Вопросы и ответы
  • Обучающие курсы

В этой статье:

  • HTTP request
  • Path parameters
  • Response
  • Permission
  1. Справочник API
  2. REST (англ.)
  3. User
  4. Get

Managed Service for Apache Kafka® API, REST: User.Get

Статья создана
Yandex Cloud
Обновлена 18 апреля 2025 г.
  • HTTP request
  • Path parameters
  • Response
  • Permission

Returns the specified Kafka user.

To get the list of available Kafka users, make a List request.

HTTP requestHTTP request

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

Path parametersPath parameters

Field

Description

clusterId

string

Required field. ID of the Apache Kafka® cluster the user belongs to.

To get the cluster ID, make a ClusterService.List request.

userName

string

Required field. Name of the Kafka user to return.

To get the name of the user, make a UserService.List request.

ResponseResponse

HTTP Code: 200 - OK

{
  "name": "string",
  "clusterId": "string",
  "permissions": [
    {
      "topicName": "string",
      "role": "string",
      "allowHosts": [
        "string"
      ]
    }
  ]
}

A Kafka user.
For more information, see the Operations -> Accounts section of the documentation.

Field

Description

name

string

Name of the Kafka user.

clusterId

string

ID of the Apache Kafka® cluster the user belongs to.

To get the Apache Kafka® cluster ID, make a ClusterService.List request.

permissions[]

Permission

Set of permissions granted to this user.

PermissionPermission

Field

Description

topicName

string

Name or prefix-pattern with wildcard for the topic that the permission grants access to.

To get the topic name, make a TopicService.List request.

role

enum (AccessRole)

Access role type to grant to the user.

  • ACCESS_ROLE_UNSPECIFIED
  • ACCESS_ROLE_PRODUCER: Producer role for the user.
  • ACCESS_ROLE_CONSUMER: Consumer role for the user.
  • ACCESS_ROLE_ADMIN: Admin role for the user.
  • ACCESS_ROLE_TOPIC_ADMIN: Admin permissions on topics role for the user.

allowHosts[]

string

Lists hosts allowed for this permission.
Only ip-addresses allowed as value of single host.
When not defined, access from any host is allowed.

Bare in mind that the same host might appear in multiple permissions at the same time,
hence removing individual permission doesn't automatically restricts access from the allowHosts of the permission.
If the same host(s) is listed for another permission of the same principal/topic, the host(s) remains allowed.

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

Предыдущая
Overview
Следующая
List
Проект Яндекса
© 2025 ООО «Яндекс.Облако»