ClusterService
Набор методов для управления кластерами Elasticsearch.
Вызов | Описание |
---|---|
Get | Возвращает указанный кластер Elasticsearch. |
List | Получает список кластеров Elasticsearch, принадлежащих указанному каталогу. |
Create | Создает новый кластер Elasticsearch в указанном каталоге. |
Update | Изменяет указанный кластер Elasticsearch. |
Delete | Удаляет указанный кластер Elasticsearch. |
Move | Перемещает кластер Elasticsearch в указанный каталог. |
Start | Запускает указанный кластер Elasticsearch. |
Stop | Останавливает указанный кластер Elasticsearch. |
ListLogs | Получает логи для указанного кластера Elasticsearch. |
StreamLogs | То же самое, что ListLogs, с той разницей, что со стороны сервера передается поток логов. |
ListOperations | Получает список операций для указанного кластера Elasticsearch. |
ListHosts | Получает список хостов для указанного кластера Elasticsearch. |
AddHosts | Добавляет новые хосты в указанный кластер Elasticsearch. |
DeleteHosts | Удаляет хосты из указанного кластера Elasticsearch. |
Вызовы ClusterService
Get
Возвращает указанный кластер Elasticsearch.
Чтобы получить список доступных кластеров Elasticsearch, выполните запрос List.
rpc Get (GetClusterRequest) returns (Cluster)
GetClusterRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера Elasticsearch. Чтобы получить идентификатор кластера, выполните запрос ClusterService.List. Максимальная длина строки в символах — 50. |
Cluster
Поле | Описание |
---|---|
id | string Идентификатор кластера Elasticsearch. Этот идентификатор генерируется при создании кластера. |
folder_id | string Идентификатор каталога, которому принадлежит кластер Elasticsearch. |
created_at | google.protobuf.Timestamp Время создания. |
name | string Имя кластера Elasticsearch. Имя должно быть уникальным в рамках каталога. Длина 1-63 символов. |
description | string Описание кластера Elasticsearch. Длина описания должна быть от 0 до 256 символов. |
labels | map<string,string> Пользовательские метки для кластера Elasticsearch в виде пар key:value . Максимум 64 на ресурс. |
environment | enum Environment Среда развертывания кластера Elasticsearch.
|
monitoring[] | Monitoring Описание систем мониторинга, относящихся к кластеру Elasticsearch. |
config | ClusterConfig Конфигурация кластера Elasticsearch. |
network_id | string Идентификатор сети, к которой принадлежит кластер. |
health | enum Health Здоровье кластера.
|
status | enum Status Текущее состояние кластера.
|
Monitoring
Поле | Описание |
---|---|
name | string Название системы мониторинга. |
description | string Описание системы мониторинга. |
link | string Ссылка на графики системы мониторинга для кластера Elasticsearch. |
ClusterConfig
Поле | Описание |
---|---|
version | string Версия Elasticsearch. |
elasticsearch | Elasticsearch Конфигурация и распределение ресурсов для узлов Elasticsearch. |
Elasticsearch
Поле | Описание |
---|---|
data_node | DataNode Конфигурация и распределение ресурсов для узлов Elasticsearch с ролью Data node. |
master_node | MasterNode Конфигурация и распределение ресурсов для узлов Elasticsearch с ролью Master node. |
DataNode
Поле | Описание |
---|---|
config | oneof: elasticsearch_config_set_7_6 |
elasticsearch_config_set_7_6 | config.ElasticsearchConfigSet7_6 Конфигурация Elasticsearch 7.6 для узла с ролью Data node. |
resources | Resources Ресурсы, выделенные узлам Elasticsearch с ролью Data node. |
MasterNode
Поле | Описание |
---|---|
resources | Resources Ресурсы, выделенные узлам Elasticsearch с ролью Master node. |
List
Получает список кластеров Elasticsearch, принадлежащих указанному каталогу.
rpc List (ListClustersRequest) returns (ListClustersResponse)
ListClustersRequest
Поле | Описание |
---|---|
folder_id | string Обязательное поле. Идентификатор каталога, для которого нужно получить список кластеров Elasticsearch. Чтобы получить идентификатор каталога, выполните запрос yandex.cloud.resourcemanager.v1.FolderService.List. Максимальная длина строки в символах — 50. |
page_size | int64 Максимальное количество результатов на одной странице в ответе. Если количество результатов больше чем page_size , сервис вернет значение ListClustersResponse.next_page_token, которое можно использовать для получения следующей страницы. Максимальное значение — 1000. |
page_token | string Токен страницы. Установите значение page_token равным значению поля ListClustersResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100. |
filter | string
|
ListClustersResponse
Поле | Описание |
---|---|
clusters[] | Cluster Список кластеров Elasticsearch. |
next_page_token | string Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListClustersRequest.page_size, используйте next_page_token в качестве значения параметра ListClustersRequest.page_token в следующем запросе. Все последующие запросы будут получать свои значения next_page_token для перебора страниц результатов. |
Cluster
Поле | Описание |
---|---|
id | string Идентификатор кластера Elasticsearch. Этот идентификатор генерируется при создании кластера. |
folder_id | string Идентификатор каталога, которому принадлежит кластер Elasticsearch. |
created_at | google.protobuf.Timestamp Время создания. |
name | string Имя кластера Elasticsearch. Имя должно быть уникальным в рамках каталога. Длина 1-63 символов. |
description | string Описание кластера Elasticsearch. Длина описания должна быть от 0 до 256 символов. |
labels | map<string,string> Пользовательские метки для кластера Elasticsearch в виде пар key:value . Максимум 64 на ресурс. |
environment | enum Environment Среда развертывания кластера Elasticsearch.
|
monitoring[] | Monitoring Описание систем мониторинга, относящихся к кластеру Elasticsearch. |
config | ClusterConfig Конфигурация кластера Elasticsearch. |
network_id | string Идентификатор сети, к которой принадлежит кластер. |
health | enum Health Здоровье кластера.
|
status | enum Status Текущее состояние кластера.
|
Monitoring
Поле | Описание |
---|---|
name | string Название системы мониторинга. |
description | string Описание системы мониторинга. |
link | string Ссылка на графики системы мониторинга для кластера Elasticsearch. |
ClusterConfig
Поле | Описание |
---|---|
version | string Версия Elasticsearch. |
elasticsearch | Elasticsearch Конфигурация и распределение ресурсов для узлов Elasticsearch. |
Elasticsearch
Поле | Описание |
---|---|
data_node | DataNode Конфигурация и распределение ресурсов для узлов Elasticsearch с ролью Data node. |
master_node | MasterNode Конфигурация и распределение ресурсов для узлов Elasticsearch с ролью Master node. |
DataNode
Поле | Описание |
---|---|
config | oneof: elasticsearch_config_set_7_6 |
elasticsearch_config_set_7_6 | config.ElasticsearchConfigSet7_6 Конфигурация Elasticsearch 7.6 для узла с ролью Data node. |
resources | Resources Ресурсы, выделенные узлам Elasticsearch с ролью Data node. |
MasterNode
Поле | Описание |
---|---|
resources | Resources Ресурсы, выделенные узлам Elasticsearch с ролью Master node. |
Create
Создает новый кластер Elasticsearch в указанном каталоге.
rpc Create (CreateClusterRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:CreateClusterMetadata
Operation.response:Cluster
CreateClusterRequest
Поле | Описание |
---|---|
folder_id | string Обязательное поле. Идентификатор каталога, в котором будет создан кластер Elasticsearch. Максимальная длина строки в символах — 50. |
name | string Обязательное поле. Имя кластера Elasticsearch. Имя должно быть уникальным в рамках каталога. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]* . |
description | string Описание кластера Elasticsearch. Максимальная длина строки в символах — 256. |
labels | map<string,string> Пользовательские метки для кластера Elasticsearch в виде пар key:value . Например, "project": "mvp" или "source": "dictionary". Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]* . Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
environment | Cluster.Environment Среда развертывания кластера Elasticsearch. |
config_spec | ConfigSpec Обязательное поле. Конфигурация Elasticsearch и хостов для кластера. |
user_specs[] | UserSpec Одно или несколько описаний пользователей, которых нужно создать в кластере Elasticsearch. Количество элементов должно быть больше 0. |
host_specs[] | HostSpec Одна или несколько конфигураций хостов, создаваемых в кластере Elasticsearch. Количество элементов должно быть больше 0. |
network_id | string Обязательное поле. Идентификатор сети, в которой будет создан кластер Elasticsearch. Максимальная длина строки в символах — 50. |
ConfigSpec
Поле | Описание |
---|---|
version | string Версия Elasticsearch. |
elasticsearch_spec | ElasticsearchSpec Конфигурация и распределение ресурсов для узлов Elasticsearch. |
ElasticsearchSpec
Поле | Описание |
---|---|
data_node | DataNode Конфигурация и распределение ресурсов для узлов Elasticsearch с ролью Data node. |
master_node | MasterNode Конфигурация и распределение ресурсов для узлов Elasticsearch с ролью Master node. |
DataNode
Поле | Описание |
---|---|
config | oneof: elasticsearch_config_7_6 Конфигурация Elasticsearch для узла с ролью Data node. |
elasticsearch_config_7_6 | config.ElasticsearchConfig7_6 Конфигурация Elasticsearch для узла с ролью Data node. |
resources | Resources Ресурсы, выделенные узлам Elasticsearch с ролью Data node. |
MasterNode
Поле | Описание |
---|---|
resources | Resources Ресурсы, выделенные узлам Elasticsearch с ролью Master node. |
UserSpec
Поле | Описание |
---|---|
name | string Обязательное поле. Имя пользователя Elasticsearch. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_]* . |
password | string Обязательное поле. Пароль пользователя Elasticsearch. Длина строки в символах должна быть от 8 до 128. |
HostSpec
Поле | Описание |
---|---|
zone_id | string Идентификатор зоны доступности, в которой находится хост. Максимальная длина строки в символах — 50. |
subnet_id | string Идентификатор подсети, в которой находится хост. Максимальная длина строки в символах — 50. |
assign_public_ip | bool Флаг, определяющий, назначен ли хосту публичный IP-адрес. Если значение равно true , то этот хост доступен в Интернете через его публичный IP-адрес. |
type | Host.Type Обязательное поле. Тип хоста. |
shard_name | string Имя шарда, который нужно создать на хосте. Максимальная длина строки в символах — 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<CreateClusterMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс 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<Cluster> в случае успешного выполнения операции. |
CreateClusterMetadata
Поле | Описание |
---|---|
cluster_id | string Идентификатор создаваемого кластера Elasticsearch. |
Cluster
Поле | Описание |
---|---|
id | string Идентификатор кластера Elasticsearch. Этот идентификатор генерируется при создании кластера. |
folder_id | string Идентификатор каталога, которому принадлежит кластер Elasticsearch. |
created_at | google.protobuf.Timestamp Время создания. |
name | string Имя кластера Elasticsearch. Имя должно быть уникальным в рамках каталога. Длина 1-63 символов. |
description | string Описание кластера Elasticsearch. Длина описания должна быть от 0 до 256 символов. |
labels | map<string,string> Пользовательские метки для кластера Elasticsearch в виде пар key:value . Максимум 64 на ресурс. |
environment | enum Environment Среда развертывания кластера Elasticsearch.
|
monitoring[] | Monitoring Описание систем мониторинга, относящихся к кластеру Elasticsearch. |
config | ClusterConfig Конфигурация кластера Elasticsearch. |
network_id | string Идентификатор сети, к которой принадлежит кластер. |
health | enum Health Здоровье кластера.
|
status | enum Status Текущее состояние кластера.
|
Monitoring
Поле | Описание |
---|---|
name | string Название системы мониторинга. |
description | string Описание системы мониторинга. |
link | string Ссылка на графики системы мониторинга для кластера Elasticsearch. |
ClusterConfig
Поле | Описание |
---|---|
version | string Версия Elasticsearch. |
elasticsearch | Elasticsearch Конфигурация и распределение ресурсов для узлов Elasticsearch. |
Elasticsearch
Поле | Описание |
---|---|
data_node | DataNode Конфигурация и распределение ресурсов для узлов Elasticsearch с ролью Data node. |
master_node | MasterNode Конфигурация и распределение ресурсов для узлов Elasticsearch с ролью Master node. |
DataNode
Поле | Описание |
---|---|
config | oneof: elasticsearch_config_set_7_6 |
elasticsearch_config_set_7_6 | config.ElasticsearchConfigSet7_6 Конфигурация Elasticsearch 7.6 для узла с ролью Data node. |
resources | Resources Ресурсы, выделенные узлам Elasticsearch с ролью Data node. |
MasterNode
Поле | Описание |
---|---|
resources | Resources Ресурсы, выделенные узлам Elasticsearch с ролью Master node. |
Update
Изменяет указанный кластер Elasticsearch.
rpc Update (UpdateClusterRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:UpdateClusterMetadata
Operation.response:Cluster
UpdateClusterRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера Elasticsearch, который нужно изменить. Чтобы получить идентификатор кластера Elasticsearch, выполните запрос ClusterService.List. Максимальная длина строки в символах — 50. |
update_mask | google.protobuf.FieldMask |
description | string Новое описание кластера Elasticsearch. Максимальная длина строки в символах — 256. |
labels | map<string,string> Пользовательские метки для кластера Elasticsearch в виде пар key:value . Например, "project": "mvp" или "source": "dictionary". Новый набор меток полностью заменит старый. Чтобы добавить метку, запросите текущий набор меток с помощью метода ClusterService.Get, затем отправьте запрос ClusterService.Update, добавив новую метку в этот набор. Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]* . Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
config_spec | ConfigSpec Новая конфигурация и ресурсы для хостов кластера Elasticsearch. Используйте параметр update_mask чтобы предотвратить сброс настроек кластера, не перечисленных в config_spec , на значения по умолчанию. |
name | string Новое имя кластера Elasticsearch. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]* . |
ConfigSpec
Поле | Описание |
---|---|
version | string Версия Elasticsearch. |
elasticsearch_spec | ElasticsearchSpec Конфигурация и распределение ресурсов для узлов Elasticsearch. |
ElasticsearchSpec
Поле | Описание |
---|---|
data_node | DataNode Конфигурация и распределение ресурсов для узлов Elasticsearch с ролью Data node. |
master_node | MasterNode Конфигурация и распределение ресурсов для узлов Elasticsearch с ролью Master node. |
DataNode
Поле | Описание |
---|---|
config | oneof: elasticsearch_config_7_6 Конфигурация Elasticsearch для узла с ролью Data node. |
elasticsearch_config_7_6 | config.ElasticsearchConfig7_6 Конфигурация Elasticsearch для узла с ролью Data node. |
resources | Resources Ресурсы, выделенные узлам Elasticsearch с ролью Data node. |
MasterNode
Поле | Описание |
---|---|
resources | Resources Ресурсы, выделенные узлам Elasticsearch с ролью Master node. |
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<UpdateClusterMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс 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<Cluster> в случае успешного выполнения операции. |
UpdateClusterMetadata
Поле | Описание |
---|---|
cluster_id | string Идентификатор изменяемого кластера Elasticsearch. |
Cluster
Поле | Описание |
---|---|
id | string Идентификатор кластера Elasticsearch. Этот идентификатор генерируется при создании кластера. |
folder_id | string Идентификатор каталога, которому принадлежит кластер Elasticsearch. |
created_at | google.protobuf.Timestamp Время создания. |
name | string Имя кластера Elasticsearch. Имя должно быть уникальным в рамках каталога. Длина 1-63 символов. |
description | string Описание кластера Elasticsearch. Длина описания должна быть от 0 до 256 символов. |
labels | map<string,string> Пользовательские метки для кластера Elasticsearch в виде пар key:value . Максимум 64 на ресурс. |
environment | enum Environment Среда развертывания кластера Elasticsearch.
|
monitoring[] | Monitoring Описание систем мониторинга, относящихся к кластеру Elasticsearch. |
config | ClusterConfig Конфигурация кластера Elasticsearch. |
network_id | string Идентификатор сети, к которой принадлежит кластер. |
health | enum Health Здоровье кластера.
|
status | enum Status Текущее состояние кластера.
|
Monitoring
Поле | Описание |
---|---|
name | string Название системы мониторинга. |
description | string Описание системы мониторинга. |
link | string Ссылка на графики системы мониторинга для кластера Elasticsearch. |
ClusterConfig
Поле | Описание |
---|---|
version | string Версия Elasticsearch. |
elasticsearch | Elasticsearch Конфигурация и распределение ресурсов для узлов Elasticsearch. |
Elasticsearch
Поле | Описание |
---|---|
data_node | DataNode Конфигурация и распределение ресурсов для узлов Elasticsearch с ролью Data node. |
master_node | MasterNode Конфигурация и распределение ресурсов для узлов Elasticsearch с ролью Master node. |
DataNode
Поле | Описание |
---|---|
config | oneof: elasticsearch_config_set_7_6 |
elasticsearch_config_set_7_6 | config.ElasticsearchConfigSet7_6 Конфигурация Elasticsearch 7.6 для узла с ролью Data node. |
resources | Resources Ресурсы, выделенные узлам Elasticsearch с ролью Data node. |
MasterNode
Поле | Описание |
---|---|
resources | Resources Ресурсы, выделенные узлам Elasticsearch с ролью Master node. |
Delete
Удаляет указанный кластер Elasticsearch.
rpc Delete (DeleteClusterRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:DeleteClusterMetadata
Operation.response:google.protobuf.Empty
DeleteClusterRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор удаляемого кластера Elasticsearch. Чтобы получить идентификатор кластера Elasticsearch, выполните запрос ClusterService.List. Максимальная длина строки в символах — 50. |
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<DeleteClusterMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс 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> в случае успешного выполнения операции. |
DeleteClusterMetadata
Поле | Описание |
---|---|
cluster_id | string Идентификатор удаляемого кластера Elasticsearch. |
Move
Перемещает кластер Elasticsearch в указанный каталог.
rpc Move (MoveClusterRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:MoveClusterMetadata
Operation.response:Cluster
MoveClusterRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера Elasticsearch, который нужно переместить. Чтобы получить идентификатор кластера Elasticsearch, выполните запрос ClusterService.List. Максимальная длина строки в символах — 50. |
destination_folder_id | string Обязательное поле. Идентификатор каталога, в который следует переместить кластер. Максимальная длина строки в символах — 50. |
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<MoveClusterMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс 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<Cluster> в случае успешного выполнения операции. |
MoveClusterMetadata
Поле | Описание |
---|---|
cluster_id | string Идентификатор перемещаемого кластера Elasticsearch. |
source_folder_id | string Идентификатор исходного каталога. |
destination_folder_id | string Идентификатор каталога, в который следует переместить кластер. |
Cluster
Поле | Описание |
---|---|
id | string Идентификатор кластера Elasticsearch. Этот идентификатор генерируется при создании кластера. |
folder_id | string Идентификатор каталога, которому принадлежит кластер Elasticsearch. |
created_at | google.protobuf.Timestamp Время создания. |
name | string Имя кластера Elasticsearch. Имя должно быть уникальным в рамках каталога. Длина 1-63 символов. |
description | string Описание кластера Elasticsearch. Длина описания должна быть от 0 до 256 символов. |
labels | map<string,string> Пользовательские метки для кластера Elasticsearch в виде пар key:value . Максимум 64 на ресурс. |
environment | enum Environment Среда развертывания кластера Elasticsearch.
|
monitoring[] | Monitoring Описание систем мониторинга, относящихся к кластеру Elasticsearch. |
config | ClusterConfig Конфигурация кластера Elasticsearch. |
network_id | string Идентификатор сети, к которой принадлежит кластер. |
health | enum Health Здоровье кластера.
|
status | enum Status Текущее состояние кластера.
|
Monitoring
Поле | Описание |
---|---|
name | string Название системы мониторинга. |
description | string Описание системы мониторинга. |
link | string Ссылка на графики системы мониторинга для кластера Elasticsearch. |
ClusterConfig
Поле | Описание |
---|---|
version | string Версия Elasticsearch. |
elasticsearch | Elasticsearch Конфигурация и распределение ресурсов для узлов Elasticsearch. |
Elasticsearch
Поле | Описание |
---|---|
data_node | DataNode Конфигурация и распределение ресурсов для узлов Elasticsearch с ролью Data node. |
master_node | MasterNode Конфигурация и распределение ресурсов для узлов Elasticsearch с ролью Master node. |
DataNode
Поле | Описание |
---|---|
config | oneof: elasticsearch_config_set_7_6 |
elasticsearch_config_set_7_6 | config.ElasticsearchConfigSet7_6 Конфигурация Elasticsearch 7.6 для узла с ролью Data node. |
resources | Resources Ресурсы, выделенные узлам Elasticsearch с ролью Data node. |
MasterNode
Поле | Описание |
---|---|
resources | Resources Ресурсы, выделенные узлам Elasticsearch с ролью Master node. |
Start
Запускает указанный кластер Elasticsearch.
rpc Start (StartClusterRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:StartClusterMetadata
Operation.response:Cluster
StartClusterRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера Elasticsearch, который нужно запустить. Чтобы получить идентификатор кластера Elasticsearch, выполните запрос ClusterService.List. Максимальная длина строки в символах — 50. |
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<StartClusterMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс 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<Cluster> в случае успешного выполнения операции. |
StartClusterMetadata
Поле | Описание |
---|---|
cluster_id | string Идентификатор кластера Elasticsearch. |
Cluster
Поле | Описание |
---|---|
id | string Идентификатор кластера Elasticsearch. Этот идентификатор генерируется при создании кластера. |
folder_id | string Идентификатор каталога, которому принадлежит кластер Elasticsearch. |
created_at | google.protobuf.Timestamp Время создания. |
name | string Имя кластера Elasticsearch. Имя должно быть уникальным в рамках каталога. Длина 1-63 символов. |
description | string Описание кластера Elasticsearch. Длина описания должна быть от 0 до 256 символов. |
labels | map<string,string> Пользовательские метки для кластера Elasticsearch в виде пар key:value . Максимум 64 на ресурс. |
environment | enum Environment Среда развертывания кластера Elasticsearch.
|
monitoring[] | Monitoring Описание систем мониторинга, относящихся к кластеру Elasticsearch. |
config | ClusterConfig Конфигурация кластера Elasticsearch. |
network_id | string Идентификатор сети, к которой принадлежит кластер. |
health | enum Health Здоровье кластера.
|
status | enum Status Текущее состояние кластера.
|
Monitoring
Поле | Описание |
---|---|
name | string Название системы мониторинга. |
description | string Описание системы мониторинга. |
link | string Ссылка на графики системы мониторинга для кластера Elasticsearch. |
ClusterConfig
Поле | Описание |
---|---|
version | string Версия Elasticsearch. |
elasticsearch | Elasticsearch Конфигурация и распределение ресурсов для узлов Elasticsearch. |
Elasticsearch
Поле | Описание |
---|---|
data_node | DataNode Конфигурация и распределение ресурсов для узлов Elasticsearch с ролью Data node. |
master_node | MasterNode Конфигурация и распределение ресурсов для узлов Elasticsearch с ролью Master node. |
DataNode
Поле | Описание |
---|---|
config | oneof: elasticsearch_config_set_7_6 |
elasticsearch_config_set_7_6 | config.ElasticsearchConfigSet7_6 Конфигурация Elasticsearch 7.6 для узла с ролью Data node. |
resources | Resources Ресурсы, выделенные узлам Elasticsearch с ролью Data node. |
MasterNode
Поле | Описание |
---|---|
resources | Resources Ресурсы, выделенные узлам Elasticsearch с ролью Master node. |
Stop
Останавливает указанный кластер Elasticsearch.
rpc Stop (StopClusterRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:StopClusterMetadata
Operation.response:Cluster
StopClusterRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера Elasticsearch, который нужно остановить. Чтобы получить идентификатор кластера Elasticsearch, выполните запрос ClusterService.List. Максимальная длина строки в символах — 50. |
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<StopClusterMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс 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<Cluster> в случае успешного выполнения операции. |
StopClusterMetadata
Поле | Описание |
---|---|
cluster_id | string Идентификатор кластера Elasticsearch. |
Cluster
Поле | Описание |
---|---|
id | string Идентификатор кластера Elasticsearch. Этот идентификатор генерируется при создании кластера. |
folder_id | string Идентификатор каталога, которому принадлежит кластер Elasticsearch. |
created_at | google.protobuf.Timestamp Время создания. |
name | string Имя кластера Elasticsearch. Имя должно быть уникальным в рамках каталога. Длина 1-63 символов. |
description | string Описание кластера Elasticsearch. Длина описания должна быть от 0 до 256 символов. |
labels | map<string,string> Пользовательские метки для кластера Elasticsearch в виде пар key:value . Максимум 64 на ресурс. |
environment | enum Environment Среда развертывания кластера Elasticsearch.
|
monitoring[] | Monitoring Описание систем мониторинга, относящихся к кластеру Elasticsearch. |
config | ClusterConfig Конфигурация кластера Elasticsearch. |
network_id | string Идентификатор сети, к которой принадлежит кластер. |
health | enum Health Здоровье кластера.
|
status | enum Status Текущее состояние кластера.
|
Monitoring
Поле | Описание |
---|---|
name | string Название системы мониторинга. |
description | string Описание системы мониторинга. |
link | string Ссылка на графики системы мониторинга для кластера Elasticsearch. |
ClusterConfig
Поле | Описание |
---|---|
version | string Версия Elasticsearch. |
elasticsearch | Elasticsearch Конфигурация и распределение ресурсов для узлов Elasticsearch. |
Elasticsearch
Поле | Описание |
---|---|
data_node | DataNode Конфигурация и распределение ресурсов для узлов Elasticsearch с ролью Data node. |
master_node | MasterNode Конфигурация и распределение ресурсов для узлов Elasticsearch с ролью Master node. |
DataNode
Поле | Описание |
---|---|
config | oneof: elasticsearch_config_set_7_6 |
elasticsearch_config_set_7_6 | config.ElasticsearchConfigSet7_6 Конфигурация Elasticsearch 7.6 для узла с ролью Data node. |
resources | Resources Ресурсы, выделенные узлам Elasticsearch с ролью Data node. |
MasterNode
Поле | Описание |
---|---|
resources | Resources Ресурсы, выделенные узлам Elasticsearch с ролью Master node. |
ListLogs
Получает логи для указанного кластера Elasticsearch.
Дополнительные сведения о логах см. в разделе документации Logs.
rpc ListLogs (ListClusterLogsRequest) returns (ListClusterLogsResponse)
ListClusterLogsRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера Elasticsearch, для которого нужно получить логи. Чтобы получить идентификатор кластера Elasticsearch, выполните запрос ClusterService.List. Максимальная длина строки в символах — 50. |
column_filter[] | string Столбцы, которые нужно запросить из лога. Если столбцы не указаны, записи логов возвращаются целиком. |
from_time | google.protobuf.Timestamp Временная метка, начиная с которой следует запросить логи. |
to_time | google.protobuf.Timestamp Временная метка, до которой следует запросить логи. |
page_size | int64 Максимальное количество результатов на одной странице в ответе. Если количество результатов больше чем page_size , сервис вернет значение ListClusterLogsResponse.next_page_token, которое можно использовать для получения следующей страницы. Максимальное значение — 1000. |
page_token | string Токен страницы. Установите значение page_token равным значению поля ListClusterLogsResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100. |
always_next_page_token | bool Флаг, определяющий поведение при предоставлении маркера следующей страницы. Если этот флаг установлен в true , этот метод API всегда будет возвращать ListClusterLogsResponse.next_page_token, даже если текущая страница пуста. |
filter | string
|
ListClusterLogsResponse
Поле | Описание |
---|---|
logs[] | LogRecord Запрошенные записи в логе. |
next_page_token | string Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListClusterLogsRequest.page_size, используйте next_page_token в качестве значения параметра ListClusterLogsRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения next_page_token для перебора страниц результатов. Это значение взаимозаменяемо с StreamLogRecord.next_record_token из метода StreamLogs. |
LogRecord
Поле | Описание |
---|---|
timestamp | google.protobuf.Timestamp Временная метка для записи в логе. |
message | map<string,string> Содержимое записи в логе. |
StreamLogs
То же самое, что ListLogs, с той разницей, что со стороны сервера передается поток логов. Допускается использовать семантику tail -f
при работе с потоком логов.
rpc StreamLogs (StreamClusterLogsRequest) returns (stream StreamLogRecord)
StreamClusterLogsRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера Elasticsearch. Чтобы получить идентификатор кластера Elasticsearch, выполните запрос ClusterService.List. Максимальная длина строки в символах — 50. |
column_filter[] | string Столбцы, которые нужно запросить из лога. Если столбцы не указаны, записи логов возвращаются целиком. |
from_time | google.protobuf.Timestamp Временная метка, начиная с которой следует запросить логи. |
to_time | google.protobuf.Timestamp Временная метка, до которой следует запросить логи. Если значение этого поля не задано, то будут отправлены все существующие записи в логе, а затем и новые по мере их появления. В сущности, это эквивалентно семантике tail -f . |
record_token | string Токен записи. Задайте значение record_token равным значению StreamLogRecord.next_record_token, возвращенному предыдущим запросом ClusterService.StreamLogs чтобы продолжить стриминг со следующей записи в логе. Максимальная длина строки в символах — 100. |
filter | string
|
StreamLogRecord
Поле | Описание |
---|---|
record | LogRecord Одна из запрошенных записей в логе. |
next_record_token | string Этот токен позволяет продолжить работу с потоком логов, начиная с этой записи. Чтобы продолжить работу с потоком, укажите значение next_record_token в качестве значения параметра StreamClusterLogsRequest.record_token в следующем запросе StreamLogs. Это значение взаимозаменяемо с ListClusterLogsResponse.next_page_token из метода ListLogs. |
LogRecord
Поле | Описание |
---|---|
timestamp | google.protobuf.Timestamp Временная метка для записи в логе. |
message | map<string,string> Содержимое записи в логе. |
ListOperations
Получает список операций для указанного кластера Elasticsearch.
rpc ListOperations (ListClusterOperationsRequest) returns (ListClusterOperationsResponse)
ListClusterOperationsRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера Elasticsearch, для которого нужно получить список операций. Чтобы получить идентификатор кластера Elasticsearch, выполните запрос ClusterService.List. Максимальная длина строки в символах — 50. |
page_size | int64 Максимальное количество результатов на одной странице в ответе. Если количество результатов больше чем page_size , сервис вернет значение ListClusterOperationsResponse.next_page_token, которое можно использовать для получения следующей страницы. Максимальное значение — 1000. |
page_token | string Токен страницы. Установите значение page_token равным значению поля ListClusterOperationsResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100. |
ListClusterOperationsResponse
Поле | Описание |
---|---|
operations[] | operation.Operation Список операций для указанного кластера Elasticsearch. |
next_page_token | string Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListClusterOperationsRequest.page_size, используйте next_page_token в качестве значения параметра ListClusterOperationsRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения next_page_token для перебора страниц результатов. |
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 Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс 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 Результат операции в случае успешного завершения. Если исходный метод не возвращает никаких данных при успешном завершении, например метод Delete, поле содержит объект google.protobuf.Empty. Если исходный метод — это стандартный метод Create / Update, поле содержит целевой ресурс операции. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля response . |
ListHosts
Получает список хостов для указанного кластера Elasticsearch.
rpc ListHosts (ListClusterHostsRequest) returns (ListClusterHostsResponse)
ListClusterHostsRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера Elasticsearch. Чтобы получить идентификатор кластера Elasticsearch, выполните запрос ClusterService.List. Максимальная длина строки в символах — 50. |
page_size | int64 Максимальное количество результатов на одной странице в ответе. Если количество результатов больше чем page_size , сервис вернет значение ListClusterHostsResponse.next_page_token, которое можно использовать для получения следующей страницы. Максимальное значение — 1000. |
page_token | string Токен страницы. Установите значение page_token равным значению поля ListClusterHostsResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100. |
ListClusterHostsResponse
Поле | Описание |
---|---|
hosts[] | Host Список хостов. |
next_page_token | string Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListClusterHostsRequest.page_size, используйте next_page_token в качестве значения параметра ListClusterHostsRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения next_page_token для перебора страниц результатов. |
Host
Поле | Описание |
---|---|
name | string Имя хоста. |
cluster_id | string Идентификатор кластера Elasticsearch. |
zone_id | string Идентификатор зоны доступности, в которой находится хост. |
type | enum Type Тип хоста.
|
resources | Resources |
health | enum Health Агрегированные данные о работоспособности хоста.
|
services[] | Service Сервисы, предоставляемые хостом. |
subnet_id | string Идентификатор подсети, в которой находится хост. |
assign_public_ip | bool Флаг, определяющий, назначен ли хосту публичный IP-адрес. Если значение равно true , то этот хост доступен в Интернете через его публичный IP-адрес. |
Resources
Поле | Описание |
---|---|
resource_preset_id | string Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т.д.). Все доступные наборы ресурсов перечислены в документации. |
disk_size | int64 Объем хранилища, доступного хосту, в байтах. |
disk_type_id | string Тип хранилища для хоста. Все доступные типы перечислены в документации. |
Service
Поле | Описание |
---|---|
type | enum Type Тип сервиса, предоставляемого хостом.
|
health | enum Health Данные о работоспособности сервиса.
|
AddHosts
Добавляет новые хосты в указанный кластер Elasticsearch.
rpc AddHosts (AddClusterHostsRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:AddClusterHostsMetadata
Operation.response:google.protobuf.Empty
AddClusterHostsRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера Elasticsearch. Чтобы получить идентификатор кластера Elasticsearch, выполните запрос ClusterService.List. Максимальная длина строки в символах — 50. |
host_specs[] | HostSpec Одна или несколько конфигураций хостов, добавляемых в кластер Elasticsearch. Количество элементов должно быть больше 0. |
HostSpec
Поле | Описание |
---|---|
zone_id | string Идентификатор зоны доступности, в которой находится хост. Максимальная длина строки в символах — 50. |
subnet_id | string Идентификатор подсети, в которой находится хост. Максимальная длина строки в символах — 50. |
assign_public_ip | bool Флаг, определяющий, назначен ли хосту публичный IP-адрес. Если значение равно true , то этот хост доступен в Интернете через его публичный IP-адрес. |
type | Host.Type Обязательное поле. Тип хоста. |
shard_name | string Имя шарда, который нужно создать на хосте. Максимальная длина строки в символах — 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<AddClusterHostsMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс 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> в случае успешного выполнения операции. |
AddClusterHostsMetadata
Поле | Описание |
---|---|
cluster_id | string Идентификатор кластера Elasticsearch. |
host_names[] | string Имена хостов, которые добавляются. |
DeleteHosts
Удаляет хосты из указанного кластера Elasticsearch.
rpc DeleteHosts (DeleteClusterHostsRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:DeleteClusterHostsMetadata
Operation.response:google.protobuf.Empty
DeleteClusterHostsRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера Elasticsearch. Чтобы получить идентификатор кластера Elasticsearch, выполните запрос ClusterService.List. Максимальная длина строки в символах — 50. |
host_names[] | string Имена хостов, которые следует удалить. Количество элементов должно быть больше 0. Максимальная длина строки в символах для каждого значения — 253. |
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<DeleteClusterHostsMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс 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> в случае успешного выполнения операции. |
DeleteClusterHostsMetadata
Поле | Описание |
---|---|
cluster_id | string Идентификатор кластера Elasticsearch. |
host_names[] | string Имена хостов, которые удаляются. |