UserService
Набор методов для управления пользователями Elasticsearch.
Вызов | Описание |
---|---|
Get | Возвращает информацию об указанном пользователе Elasticsearch. |
List | Получает список пользователей Elasticsearch в указанном кластере. |
Вызовы UserService
Get
Возвращает информацию об указанном пользователе Elasticsearch.
Чтобы получить список доступных пользователей Elasticsearch, выполните запрос List.
rpc Get (GetUserRequest) returns (User)
GetUserRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера Elasticsearch, к которому принадлежит пользователь. Чтобы получить идентификатор кластера, выполните запрос ClusterService.List. Максимальная длина строки в символах — 50. |
user_name | string Обязательное поле. Имя запрашиваемого пользователя Elasticsearch. Чтобы получить имя пользователя, выполните запрос UserService.List. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_]* . |
User
Поле | Описание |
---|---|
name | string Имя пользователя Elasticsearch. |
cluster_id | string Идентификатор кластера Elasticsearch, к которому принадлежит пользователь. |
List
Получает список пользователей Elasticsearch в указанном кластере.
rpc List (ListUsersRequest) returns (ListUsersResponse)
ListUsersRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера Elasticsearch, для которого нужно получить список пользователей. Чтобы получить идентификатор кластера, используйте запрос 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 Список пользователей Elasticsearch. |
next_page_token | string Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListUsersRequest.page_size, используйте next_page_token в качестве значения параметра ListUsersRequest.page_token в следующем запросе. Все последующие запросы будут получать свои значения next_page_token для перебора страниц результатов. |
User
Поле | Описание |
---|---|
name | string Имя пользователя Elasticsearch. |
cluster_id | string Идентификатор кластера Elasticsearch, к которому принадлежит пользователь. |