UserService
Набор методов для управления пользователями Kafka.
Вызов | Описание |
---|---|
Get | Возвращает информацию об указанном пользователе Kafka. |
List | Получает список пользователей Kafka в указанном кластере. |
Create | Создает пользователя Kafka в указанном кластере. |
Update | Изменяет указанного пользователя Kafka. |
Delete | Удаляет указанного пользователя Kafka. |
GrantPermission | Предоставляет разрешение указанному пользователю Kafka. |
RevokePermission | Отзывает разрешение у указанного пользователя Kafka. |
Вызовы UserService
Get
Возвращает информацию об указанном пользователе Kafka.
Чтобы получить список доступных пользователей Kafka, выполните запрос List.
rpc Get (GetUserRequest) returns (User)
GetUserRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера Apache Kafka®, к которому принадлежит пользователь. Чтобы получить идентификатор кластера, выполните запрос ClusterService.List. Максимальная длина строки в символах — 50. |
user_name | string Обязательное поле. Имя запрашиваемого пользователя Kafka. Чтобы получить имя пользователя, выполните запрос UserService.List. Длина строки в символах должна быть от 1 до 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_]* . |
User
Поле | Описание |
---|---|
name | string Имя пользователя Kafka. |
cluster_id | string Идентификатор кластера Apache Kafka®, к которому принадлежит пользователь. Чтобы получить идентификатор кластера Apache Kafka®, выполните запрос ClusterService.List. |
permissions[] | Permission Набор разрешений, предоставленных пользователю. |
Permission
Поле | Описание |
---|---|
topic_name | string Имя топика, к которому предоставляется доступ. Чтобы получить имя топика, выполните запрос TopicService.List. |
role | enum AccessRole Роль доступа, которую нужно предоставить пользователю.
|
List
Получает список пользователей Kafka в указанном кластере.
rpc List (ListUsersRequest) returns (ListUsersResponse)
ListUsersRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера Apache Kafka®, для которого нужно получить список пользователей. Чтобы получить идентификатор кластера Apache Kafka®, выполните запрос ClusterService.List. Максимальная длина строки в символах — 50. |
page_size | int64 Максимальное количество результатов на одной странице в ответе. Если количество результатов больше чем page_size , сервис вернет значение ListUsersResponse.next_page_token, которое можно использовать для получения следующей страницы. Максимальное значение — 1000. |
page_token | string Токен страницы. Установите значение page_token равным значению поля ListUsersResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100. |
ListUsersResponse
Поле | Описание |
---|---|
users[] | User Список пользователей Kafka. |
next_page_token | string Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListUsersRequest.page_size, используйте next_page_token в качестве значения параметра ListUsersRequest.page_token в следующем запросе. Все последующие запросы будут получать свои значения next_page_token для перебора страниц результатов. |
User
Поле | Описание |
---|---|
name | string Имя пользователя Kafka. |
cluster_id | string Идентификатор кластера Apache Kafka®, к которому принадлежит пользователь. Чтобы получить идентификатор кластера Apache Kafka®, выполните запрос ClusterService.List. |
permissions[] | Permission Набор разрешений, предоставленных пользователю. |
Permission
Поле | Описание |
---|---|
topic_name | string Имя топика, к которому предоставляется доступ. Чтобы получить имя топика, выполните запрос TopicService.List. |
role | enum AccessRole Роль доступа, которую нужно предоставить пользователю.
|
Create
Создает пользователя Kafka в указанном кластере.
rpc Create (CreateUserRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:CreateUserMetadata
Operation.response:User
CreateUserRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера Apache Kafka®, в котором следует создать пользователя. Чтобы получить идентификатор кластера, выполните запрос ClusterService.List. Максимальная длина строки в символах — 50. |
user_spec | UserSpec Обязательное поле. Свойства создаваемого пользователя. |
UserSpec
Поле | Описание |
---|---|
name | string Обязательное поле. Имя пользователя Kafka. Длина строки в символах должна быть от 1 до 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_]* . |
password | string Обязательное поле. Пароль пользователя Kafka. Длина строки в символах должна быть от 8 до 128. |
permissions[] | Permission Набор разрешений, предоставленных пользователю. |
Permission
Поле | Описание |
---|---|
topic_name | string Имя топика, к которому предоставляется доступ. Чтобы получить имя топика, выполните запрос TopicService.List. |
role | enum AccessRole Роль доступа, которую нужно предоставить пользователю.
|
Operation
Поле | Описание |
---|---|
id | string Идентификатор операции. |
description | string Описание операции. Длина описания должна быть от 0 до 256 символов. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате в RFC3339. |
created_by | string Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию. |
modified_at | google.protobuf.Timestamp Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339. |
done | bool Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response . |
metadata | google.protobuf.Any<CreateUserMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata . |
result | oneof: error или response Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error . Если done == true — задано значение ровно одного из полей error или response . |
error | google.rpc.Status Описание ошибки в случае сбоя или отмены операции. |
response | google.protobuf.Any<User> в случае успешного выполнения операции. |
CreateUserMetadata
Поле | Описание |
---|---|
cluster_id | string Идентификатор кластера Apache Kafka®, в котором создается пользователь. |
user_name | string Имя создаваемого пользователя. |
User
Поле | Описание |
---|---|
name | string Имя пользователя Kafka. |
cluster_id | string Идентификатор кластера Apache Kafka®, к которому принадлежит пользователь. Чтобы получить идентификатор кластера Apache Kafka®, выполните запрос ClusterService.List. |
permissions[] | Permission Набор разрешений, предоставленных пользователю. |
Permission
Поле | Описание |
---|---|
topic_name | string Имя топика, к которому предоставляется доступ. Чтобы получить имя топика, выполните запрос TopicService.List. |
role | enum AccessRole Роль доступа, которую нужно предоставить пользователю.
|
Update
Изменяет указанного пользователя Kafka.
rpc Update (UpdateUserRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:UpdateUserMetadata
Operation.response:User
UpdateUserRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера Apache Kafka®, к которому принадлежит пользователь. Чтобы получить идентификатор кластера, выполните запрос ClusterService.List. Максимальная длина строки в символах — 50. |
user_name | string Обязательное поле. Имя пользователя, которого следует изменить. Чтобы получить имя пользователя, выполните запрос UserService.List. Длина строки в символах должна быть от 1 до 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_]* . |
update_mask | google.protobuf.FieldMask |
password | string Новый пароль для пользователя. Длина строки в символах должна быть от 8 до 128. |
permissions[] | Permission Новый набор разрешений для пользователя. |
Permission
Поле | Описание |
---|---|
topic_name | string Имя топика, к которому предоставляется доступ. Чтобы получить имя топика, выполните запрос TopicService.List. |
role | enum AccessRole Роль доступа, которую нужно предоставить пользователю.
|
Operation
Поле | Описание |
---|---|
id | string Идентификатор операции. |
description | string Описание операции. Длина описания должна быть от 0 до 256 символов. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате в RFC3339. |
created_by | string Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию. |
modified_at | google.protobuf.Timestamp Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339. |
done | bool Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response . |
metadata | google.protobuf.Any<UpdateUserMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata . |
result | oneof: error или response Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error . Если done == true — задано значение ровно одного из полей error или response . |
error | google.rpc.Status Описание ошибки в случае сбоя или отмены операции. |
response | google.protobuf.Any<User> в случае успешного выполнения операции. |
UpdateUserMetadata
Поле | Описание |
---|---|
cluster_id | string Идентификатор кластера Apache Kafka®, к которому принадлежит пользователь. |
user_name | string Имя изменяемого пользователя. |
User
Поле | Описание |
---|---|
name | string Имя пользователя Kafka. |
cluster_id | string Идентификатор кластера Apache Kafka®, к которому принадлежит пользователь. Чтобы получить идентификатор кластера Apache Kafka®, выполните запрос ClusterService.List. |
permissions[] | Permission Набор разрешений, предоставленных пользователю. |
Permission
Поле | Описание |
---|---|
topic_name | string Имя топика, к которому предоставляется доступ. Чтобы получить имя топика, выполните запрос TopicService.List. |
role | enum AccessRole Роль доступа, которую нужно предоставить пользователю.
|
Delete
Удаляет указанного пользователя Kafka.
rpc Delete (DeleteUserRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:DeleteUserMetadata
Operation.response:google.protobuf.Empty
DeleteUserRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера Apache Kafka®, к которому принадлежит пользователь. Чтобы получить идентификатор кластера, выполните запрос ClusterService.List. Максимальная длина строки в символах — 50. |
user_name | string Обязательное поле. Имя пользователя, которого нужно удалить. Чтобы получить имя пользователя, выполните запрос UserService.List. Длина строки в символах должна быть от 1 до 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_]* . |
Operation
Поле | Описание |
---|---|
id | string Идентификатор операции. |
description | string Описание операции. Длина описания должна быть от 0 до 256 символов. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате в RFC3339. |
created_by | string Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию. |
modified_at | google.protobuf.Timestamp Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339. |
done | bool Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response . |
metadata | google.protobuf.Any<DeleteUserMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata . |
result | oneof: error или response Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error . Если done == true — задано значение ровно одного из полей error или response . |
error | google.rpc.Status Описание ошибки в случае сбоя или отмены операции. |
response | google.protobuf.Any<google.protobuf.Empty> в случае успешного выполнения операции. |
DeleteUserMetadata
Поле | Описание |
---|---|
cluster_id | string Идентификатор кластера Apache Kafka®, к которому принадлежит пользователь. |
user_name | string Имя удаляемого пользователя. |
GrantPermission
Предоставляет разрешение указанному пользователю Kafka.
rpc GrantPermission (GrantUserPermissionRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:GrantUserPermissionMetadata
Operation.response:User
GrantUserPermissionRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера Apache Kafka®, к которому принадлежит пользователь. Чтобы получить идентификатор кластера, выполните запрос ClusterService.List. Максимальная длина строки в символах — 50. |
user_name | string Обязательное поле. Имя пользователя, которому следует предоставить разрешение. Чтобы получить имя пользователя, выполните запрос UserService.List. Длина строки в символах должна быть от 1 до 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_]* . |
permission | Permission Обязательное поле. Разрешение, которое должно быть предоставлено указанному пользователю. |
Permission
Поле | Описание |
---|---|
topic_name | string Имя топика, к которому предоставляется доступ. Чтобы получить имя топика, выполните запрос TopicService.List. |
role | enum AccessRole Роль доступа, которую нужно предоставить пользователю.
|
Operation
Поле | Описание |
---|---|
id | string Идентификатор операции. |
description | string Описание операции. Длина описания должна быть от 0 до 256 символов. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате в RFC3339. |
created_by | string Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию. |
modified_at | google.protobuf.Timestamp Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339. |
done | bool Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response . |
metadata | google.protobuf.Any<GrantUserPermissionMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata . |
result | oneof: error или response Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error . Если done == true — задано значение ровно одного из полей error или response . |
error | google.rpc.Status Описание ошибки в случае сбоя или отмены операции. |
response | google.protobuf.Any<User> в случае успешного выполнения операции. |
GrantUserPermissionMetadata
Поле | Описание |
---|---|
cluster_id | string Идентификатор кластера Apache Kafka®, к которому принадлежит пользователь. Чтобы получить идентификатор кластера, выполните запрос ClusterService.List. |
user_name | string Имя пользователя, которому предоставляется разрешение. |
User
Поле | Описание |
---|---|
name | string Имя пользователя Kafka. |
cluster_id | string Идентификатор кластера Apache Kafka®, к которому принадлежит пользователь. Чтобы получить идентификатор кластера Apache Kafka®, выполните запрос ClusterService.List. |
permissions[] | Permission Набор разрешений, предоставленных пользователю. |
Permission
Поле | Описание |
---|---|
topic_name | string Имя топика, к которому предоставляется доступ. Чтобы получить имя топика, выполните запрос TopicService.List. |
role | enum AccessRole Роль доступа, которую нужно предоставить пользователю.
|
RevokePermission
Отзывает разрешение у указанного пользователя Kafka.
rpc RevokePermission (RevokeUserPermissionRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:RevokeUserPermissionMetadata
Operation.response:User
RevokeUserPermissionRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера Apache Kafka®, к которому принадлежит пользователь. Чтобы получить идентификатор кластера, выполните запрос ClusterService.List. Максимальная длина строки в символах — 50. |
user_name | string Обязательное поле. Имя пользователя, у которого следует отозвать разрешение. Чтобы получить имя пользователя, выполните запрос UserService.List. Длина строки в символах должна быть от 1 до 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_]* . |
permission | Permission Обязательное поле. Разрешение, которое должно быть отозвано у указанного пользователя. |
Permission
Поле | Описание |
---|---|
topic_name | string Имя топика, к которому предоставляется доступ. Чтобы получить имя топика, выполните запрос TopicService.List. |
role | enum AccessRole Роль доступа, которую нужно предоставить пользователю.
|
Operation
Поле | Описание |
---|---|
id | string Идентификатор операции. |
description | string Описание операции. Длина описания должна быть от 0 до 256 символов. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате в RFC3339. |
created_by | string Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию. |
modified_at | google.protobuf.Timestamp Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339. |
done | bool Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response . |
metadata | google.protobuf.Any<RevokeUserPermissionMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata . |
result | oneof: error или response Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error . Если done == true — задано значение ровно одного из полей error или response . |
error | google.rpc.Status Описание ошибки в случае сбоя или отмены операции. |
response | google.protobuf.Any<User> в случае успешного выполнения операции. |
RevokeUserPermissionMetadata
Поле | Описание |
---|---|
cluster_id | string Идентификатор кластера Apache Kafka®, к которому принадлежит пользователь. |
user_name | string Имя пользователя, для которого отзывается разрешение. |
User
Поле | Описание |
---|---|
name | string Имя пользователя Kafka. |
cluster_id | string Идентификатор кластера Apache Kafka®, к которому принадлежит пользователь. Чтобы получить идентификатор кластера Apache Kafka®, выполните запрос ClusterService.List. |
permissions[] | Permission Набор разрешений, предоставленных пользователю. |
Permission
Поле | Описание |
---|---|
topic_name | string Имя топика, к которому предоставляется доступ. Чтобы получить имя топика, выполните запрос TopicService.List. |
role | enum AccessRole Роль доступа, которую нужно предоставить пользователю.
|