Подключиться
Yandex Managed Service for Apache Kafka®

Метод grantPermission

Предоставляет разрешение указанному пользователю Kafka.

HTTP-запрос

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

Path-параметры

Параметр Описание
clusterId Обязательное поле. Идентификатор кластера Apache Kafka®, к которому принадлежит пользователь. Чтобы получить идентификатор кластера, выполните запрос list. Максимальная длина строки в символах — 50.
userName Обязательное поле. Имя пользователя, которому следует предоставить разрешение. Чтобы получить имя пользователя, выполните запрос list. Длина строки в символах должна быть от 1 до 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_]*.

Параметры в теле запроса

{
  "permission": {
    "topicName": "string",
    "role": "string"
  }
}
Поле Описание
permission object

Обязательное поле. Разрешение, которое должно быть предоставлено указанному пользователю.
permission.
topicName		 string

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

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

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

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

Ответ

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": true,
  "metadata": "object",

  //  включает только одно из полей `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": "object",
  // конец списка возможных полей

}

Ресурс Operation. Дополнительные сведения см. в разделе
Объект Operation.

Поле Описание
id string

Идентификатор операции.
description string

Описание операции. Длина описания должна быть от 0 до 256 символов.
createdAt string (date-time)

Время создания ресурса в формате в RFC3339.

Строка в формате RFC3339.
createdBy string

Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
modifiedAt string (date-time)

Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.

Строка в формате RFC3339.
done boolean (boolean)

Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
metadata object

Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
error object
Описание ошибки в случае сбоя или отмены операции.
включает только одно из полей error, response

Описание ошибки в случае сбоя или отмены операции.
error.
code		 integer (int32)

Код ошибки. Значение из списка google.rpc.Code.
error.
message		 string

Текст ошибки.
error.
details[]		 object

Список сообщений с подробными сведениями об ошибке.
response object
включает только одно из полей error, response

Результат операции в случае успешного завершения. Если исходный метод не возвращает никаких данных при успешном завершении, например метод Delete, поле содержит объект google.protobuf.Empty. Если исходный метод — это стандартный метод Create / Update, поле содержит целевой ресурс операции. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля response.
В этой статье: