Managed Service for Elasticsearch API, gRPC: ClusterService
A set of methods for managing Elasticsearch clusters.
Call | Description |
---|---|
Get | Returns the specified Elasticsearch cluster. |
List | Retrieves the list of Elasticsearch clusters that belong to the specified folder. |
Create | Creates a new Elasticsearch cluster in the specified folder. |
Update | Updates the specified Elasticsearch cluster. |
Delete | Deletes the specified Elasticsearch cluster. |
Move | Moves the specified Elasticsearch cluster to the specified folder. |
Start | Starts the specified Elasticsearch cluster. |
Stop | Stops the specified Elasticsearch cluster. |
Backup | Create a backup for the specified ElasticSearch cluster. |
ListBackups | Returns the list of available backups for the specified Elasticsearch cluster. |
Restore | Creates a new ElasticSearch cluster from the specified backup. |
ListLogs | Retrieves logs for the specified Elasticsearch cluster. |
StreamLogs | Same as ListLogs but using server-side streaming. |
ListOperations | Retrieves the list of operations for the specified Elasticsearch cluster. |
ListHosts | Retrieves a list of hosts for the specified Elasticsearch cluster. |
AddHosts | Adds new hosts to the specified Elasticsearch cluster. |
DeleteHosts | Deletes specified hosts from the specified Elasticsearch cluster. |
RescheduleMaintenance | Reschedule planned maintenance operation. |
Calls ClusterService
Get
Returns the specified Elasticsearch cluster.
To get the list of available Elasticsearch clusters, make a List request.
rpc Get (GetClusterRequest) returns (Cluster)
GetClusterRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the Elasticsearch cluster to return. To get the cluster ID, make a ClusterService.List request. The maximum string length in characters is 50. |
Cluster
Field | Description |
---|---|
id | string ID of the Elasticsearch cluster. This ID is assigned at creation time. |
folder_id | string ID of the folder that the Elasticsearch cluster belongs to. |
created_at | google.protobuf.Timestamp Creation timestamp. |
name | string Name of the Elasticsearch cluster. The name must be unique within the folder. 1-63 characters long. |
description | string Description of the Elasticsearch cluster. 0-256 characters long. |
labels | map<string,string> Custom labels for the Elasticsearch cluster as key:value pairs. A maximum of 64 labels per resource is allowed. |
environment | enum Environment Deployment environment of the Elasticsearch cluster.
|
monitoring[] | Monitoring Description of monitoring systems relevant to the Elasticsearch cluster. |
config | ClusterConfig Configuration of the Elasticsearch cluster. |
network_id | string ID of the network that the cluster belongs to. |
health | enum Health Aggregated cluster health.
|
status | enum Status Current state of the cluster.
|
security_group_ids[] | string User security groups |
service_account_id | string ID of the service account used for access to Object Storage. |
deletion_protection | bool Deletion Protection inhibits deletion of the cluster |
maintenance_window | MaintenanceWindow Window of maintenance operations. |
planned_operation | MaintenanceOperation Maintenance operation planned at nearest maintenance_window. |
Monitoring
Field | Description |
---|---|
name | string Name of the monitoring system. |
description | string Description of the monitoring system. |
link | string Link to the monitoring system charts for the Elasticsearch cluster. |
ClusterConfig
Field | Description |
---|---|
version | string Elasticsearch version. |
elasticsearch | Elasticsearch Configuration and resource allocation for Elasticsearch nodes. |
edition | string ElasticSearch edition. |
Elasticsearch
Field | Description |
---|---|
data_node | DataNode Configuration and resource allocation for Elasticsearch data nodes. |
master_node | MasterNode Configuration and resource allocation for Elasticsearch master nodes. |
plugins[] | string Cluster wide plugins |
DataNode
Field | Description |
---|---|
config | oneof: elasticsearch_config_set_7 |
elasticsearch_config_set_7 | config.ElasticsearchConfigSet7 Elasticsearch 7.x data node configuration. |
resources | Resources Resources allocated to Elasticsearch data nodes. |
MasterNode
Field | Description |
---|---|
resources | Resources Resources allocated to Elasticsearch master nodes. |
Resources
Field | Description |
---|---|
resource_preset_id | string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation. |
disk_size | int64 Volume of the storage available to a host, in bytes. |
disk_type_id | string Type of the storage environment for the host. All available types are listed in the documentation. |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime or weekly_maintenance_window |
anytime | AnytimeMaintenanceWindow |
weekly_maintenance_window | WeeklyMaintenanceWindow |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay |
hour | int64 Hour of the day in UTC. Acceptable values are 1 to 24, inclusive. |
MaintenanceOperation
Field | Description |
---|---|
info | string The maximum string length in characters is 256. |
delayed_until | google.protobuf.Timestamp |
List
Retrieves the list of Elasticsearch clusters that belong to the specified folder.
rpc List (ListClustersRequest) returns (ListClustersResponse)
ListClustersRequest
Field | Description |
---|---|
folder_id | string Required. ID of the folder to list Elasticsearch clusters in. To get the folder ID, make a yandex.cloud.resourcemanager.v1.FolderService.List request. The maximum string length in characters is 50. |
page_size | int64 The maximum number of results per page to return. If the number of available results is larger than page_size , the service returns a ListClustersResponse.next_page_token that can be used to get the next page of results in subsequent list requests. The maximum value is 1000. |
page_token | string Page token. To get the next page of results, set page_token to the ListClustersResponse.next_page_token returned by the previous list request. The maximum string length in characters is 100. |
filter | string A filter expression that filters resources listed in the response. The expression must specify:
Example of a filter: name NOT IN 'test,beta' . The maximum string length in characters is 1000. |
ListClustersResponse
Field | Description |
---|---|
clusters[] | Cluster List of Elasticsearch clusters. |
next_page_token | string Token that allows you to get the next page of results for list requests. If the number of results is larger than ListClustersRequest.page_size, use next_page_token as the value for the ListClustersRequest.page_token parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results. |
Cluster
Field | Description |
---|---|
id | string ID of the Elasticsearch cluster. This ID is assigned at creation time. |
folder_id | string ID of the folder that the Elasticsearch cluster belongs to. |
created_at | google.protobuf.Timestamp Creation timestamp. |
name | string Name of the Elasticsearch cluster. The name must be unique within the folder. 1-63 characters long. |
description | string Description of the Elasticsearch cluster. 0-256 characters long. |
labels | map<string,string> Custom labels for the Elasticsearch cluster as key:value pairs. A maximum of 64 labels per resource is allowed. |
environment | enum Environment Deployment environment of the Elasticsearch cluster.
|
monitoring[] | Monitoring Description of monitoring systems relevant to the Elasticsearch cluster. |
config | ClusterConfig Configuration of the Elasticsearch cluster. |
network_id | string ID of the network that the cluster belongs to. |
health | enum Health Aggregated cluster health.
|
status | enum Status Current state of the cluster.
|
security_group_ids[] | string User security groups |
service_account_id | string ID of the service account used for access to Object Storage. |
deletion_protection | bool Deletion Protection inhibits deletion of the cluster |
maintenance_window | MaintenanceWindow Window of maintenance operations. |
planned_operation | MaintenanceOperation Maintenance operation planned at nearest maintenance_window. |
Monitoring
Field | Description |
---|---|
name | string Name of the monitoring system. |
description | string Description of the monitoring system. |
link | string Link to the monitoring system charts for the Elasticsearch cluster. |
ClusterConfig
Field | Description |
---|---|
version | string Elasticsearch version. |
elasticsearch | Elasticsearch Configuration and resource allocation for Elasticsearch nodes. |
edition | string ElasticSearch edition. |
Elasticsearch
Field | Description |
---|---|
data_node | DataNode Configuration and resource allocation for Elasticsearch data nodes. |
master_node | MasterNode Configuration and resource allocation for Elasticsearch master nodes. |
plugins[] | string Cluster wide plugins |
DataNode
Field | Description |
---|---|
config | oneof: elasticsearch_config_set_7 |
elasticsearch_config_set_7 | config.ElasticsearchConfigSet7 Elasticsearch 7.x data node configuration. |
resources | Resources Resources allocated to Elasticsearch data nodes. |
MasterNode
Field | Description |
---|---|
resources | Resources Resources allocated to Elasticsearch master nodes. |
Resources
Field | Description |
---|---|
resource_preset_id | string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation. |
disk_size | int64 Volume of the storage available to a host, in bytes. |
disk_type_id | string Type of the storage environment for the host. All available types are listed in the documentation. |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime or weekly_maintenance_window |
anytime | AnytimeMaintenanceWindow |
weekly_maintenance_window | WeeklyMaintenanceWindow |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay |
hour | int64 Hour of the day in UTC. Acceptable values are 1 to 24, inclusive. |
MaintenanceOperation
Field | Description |
---|---|
info | string The maximum string length in characters is 256. |
delayed_until | google.protobuf.Timestamp |
Create
Creates a new Elasticsearch cluster in the specified folder.
rpc Create (CreateClusterRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:CreateClusterMetadata
Operation.response:Cluster
CreateClusterRequest
Field | Description |
---|---|
folder_id | string Required. ID of the folder to create the Elasticsearch cluster in. The maximum string length in characters is 50. |
name | string Required. Name of the Elasticsearch cluster. The name must be unique within the folder. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]* . |
description | string Description of the Elasticsearch cluster. The maximum string length in characters is 256. |
labels | map<string,string> Custom labels for the Elasticsearch cluster as key:value pairs. For example, "project": "mvp" or "source": "dictionary". No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_0-9a-z]* . The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]* . |
environment | Cluster.Environment Deployment environment of the Elasticsearch cluster. |
config_spec | ConfigSpec Required. Elasticsearch and hosts configuration for the cluster. |
user_specs[] | UserSpec One or more descriptions of users to be created in Elasticsearch cluster. |
host_specs[] | HostSpec One or more configurations of hosts to be created in the Elasticsearch cluster. The number of elements must be greater than 0. |
network_id | string Required. ID of the network to create the Elasticsearch cluster in. The maximum string length in characters is 50. |
security_group_ids[] | string User security groups |
service_account_id | string ID of the service account used for access to Object Storage. |
deletion_protection | bool Deletion Protection inhibits deletion of the cluster |
maintenance_window | MaintenanceWindow Window of maintenance operations. |
extension_specs[] | ExtensionSpec |
ConfigSpec
Field | Description |
---|---|
version | string Elasticsearch version. |
elasticsearch_spec | ElasticsearchSpec Configuration and resource allocation for Elasticsearch nodes. |
edition | string ElasticSearch edition. |
admin_password | string Required. ElasticSearch admin password. |
ElasticsearchSpec
Field | Description |
---|---|
data_node | DataNode Configuration and resource allocation for Elasticsearch data nodes. |
master_node | MasterNode Configuration and resource allocation for Elasticsearch master nodes. |
plugins[] | string Cluster wide plugins The maximum string length in characters for each value is 50. |
DataNode
Field | Description |
---|---|
config | oneof: elasticsearch_config_7 Elasticsearch data node configuration. |
elasticsearch_config_7 | config.ElasticsearchConfig7 Elasticsearch data node configuration. |
resources | Resources Resources allocated to Elasticsearch data nodes. |
MasterNode
Field | Description |
---|---|
resources | Resources Resources allocated to Elasticsearch master nodes. |
Resources
Field | Description |
---|---|
resource_preset_id | string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation. |
disk_size | int64 Volume of the storage available to a host, in bytes. |
disk_type_id | string Type of the storage environment for the host. All available types are listed in the documentation. |
UserSpec
Field | Description |
---|---|
name | string Required. Name of the Elasticsearch user. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_]* . |
password | string Required. Password of the Elasticsearch user. The string length in characters must be 8-128. |
HostSpec
Field | Description |
---|---|
zone_id | string ID of the availability zone where the host resides. The maximum string length in characters is 50. |
subnet_id | string ID of the subnet the host resides in. The maximum string length in characters is 50. |
assign_public_ip | bool The flag that defines whether a public IP address is assigned to the host. If the value is true , then this host is available on the Internet via it's public IP address. |
type | Host.Type Required. Host type. |
shard_name | string The shard name to create on the host. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]* . |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime or weekly_maintenance_window |
anytime | AnytimeMaintenanceWindow |
weekly_maintenance_window | WeeklyMaintenanceWindow |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay |
hour | int64 Hour of the day in UTC. Acceptable values are 1 to 24, inclusive. |
ExtensionSpec
Field | Description |
---|---|
name | string Required. Name of the extension. The maximum string length in characters is 50. |
uri | string URI of the zip archive to create the new extension from. Currently only supports links that are stored in Object Storage. |
disabled | bool The flag shows whether to create the extension in disabled state. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
CreateClusterMetadata
Field | Description |
---|---|
cluster_id | string ID of the Elasticsearch cluster that is being created. |
Cluster
Field | Description |
---|---|
id | string ID of the Elasticsearch cluster. This ID is assigned at creation time. |
folder_id | string ID of the folder that the Elasticsearch cluster belongs to. |
created_at | google.protobuf.Timestamp Creation timestamp. |
name | string Name of the Elasticsearch cluster. The name must be unique within the folder. 1-63 characters long. |
description | string Description of the Elasticsearch cluster. 0-256 characters long. |
labels | map<string,string> Custom labels for the Elasticsearch cluster as key:value pairs. A maximum of 64 labels per resource is allowed. |
environment | enum Environment Deployment environment of the Elasticsearch cluster.
|
monitoring[] | Monitoring Description of monitoring systems relevant to the Elasticsearch cluster. |
config | ClusterConfig Configuration of the Elasticsearch cluster. |
network_id | string ID of the network that the cluster belongs to. |
health | enum Health Aggregated cluster health.
|
status | enum Status Current state of the cluster.
|
security_group_ids[] | string User security groups |
service_account_id | string ID of the service account used for access to Object Storage. |
deletion_protection | bool Deletion Protection inhibits deletion of the cluster |
maintenance_window | MaintenanceWindow Window of maintenance operations. |
planned_operation | MaintenanceOperation Maintenance operation planned at nearest maintenance_window. |
Monitoring
Field | Description |
---|---|
name | string Name of the monitoring system. |
description | string Description of the monitoring system. |
link | string Link to the monitoring system charts for the Elasticsearch cluster. |
ClusterConfig
Field | Description |
---|---|
version | string Elasticsearch version. |
elasticsearch | Elasticsearch Configuration and resource allocation for Elasticsearch nodes. |
edition | string ElasticSearch edition. |
Elasticsearch
Field | Description |
---|---|
data_node | DataNode Configuration and resource allocation for Elasticsearch data nodes. |
master_node | MasterNode Configuration and resource allocation for Elasticsearch master nodes. |
plugins[] | string Cluster wide plugins |
DataNode
Field | Description |
---|---|
config | oneof: elasticsearch_config_set_7 |
elasticsearch_config_set_7 | config.ElasticsearchConfigSet7 Elasticsearch 7.x data node configuration. |
resources | Resources Resources allocated to Elasticsearch data nodes. |
MasterNode
Field | Description |
---|---|
resources | Resources Resources allocated to Elasticsearch master nodes. |
MaintenanceOperation
Field | Description |
---|---|
info | string The maximum string length in characters is 256. |
delayed_until | google.protobuf.Timestamp |
Update
Updates the specified Elasticsearch cluster.
rpc Update (UpdateClusterRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:UpdateClusterMetadata
Operation.response:Cluster
UpdateClusterRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the Elasticsearch cluster to update. To get the Elasticsearch cluster ID, make a ClusterService.List request. The maximum string length in characters is 50. |
update_mask | google.protobuf.FieldMask |
description | string New description of the Elasticsearch cluster. The maximum string length in characters is 256. |
labels | map<string,string> Custom labels for the Elasticsearch cluster as key:value pairs. For example, "project": "mvp" or "source": "dictionary". The new set of labels will completely replace the old ones. To add a label, request the current set with the ClusterService.Get method, then send an ClusterService.Update request with the new label added to the set. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_0-9a-z]* . The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]* . |
config_spec | ConfigSpecUpdate New configuration and resources for hosts in the Elasticsearch cluster. Use update_mask to prevent reverting all cluster settings that are not listed in config_spec to their default values. |
name | string New name for the Elasticsearch cluster. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]* . |
security_group_ids[] | string User security groups |
service_account_id | string ID of the service account used for access to Object Storage. |
deletion_protection | bool Deletion Protection inhibits deletion of the cluster |
maintenance_window | MaintenanceWindow Window of maintenance operations. |
network_id | string ID of the network to move the cluster to. The maximum string length in characters is 50. |
ConfigSpecUpdate
Field | Description |
---|---|
version | string Elasticsearch version. |
elasticsearch_spec | ElasticsearchSpec Configuration and resource allocation for Elasticsearch nodes. |
edition | string ElasticSearch edition. |
admin_password | string ElasticSearch admin password. |
ElasticsearchSpec
Field | Description |
---|---|
data_node | DataNode Configuration and resource allocation for Elasticsearch data nodes. |
master_node | MasterNode Configuration and resource allocation for Elasticsearch master nodes. |
plugins[] | string Cluster wide plugins The maximum string length in characters for each value is 50. |
DataNode
Field | Description |
---|---|
config | oneof: elasticsearch_config_7 Elasticsearch data node configuration. |
elasticsearch_config_7 | config.ElasticsearchConfig7 Elasticsearch data node configuration. |
resources | Resources Resources allocated to Elasticsearch data nodes. |
MasterNode
Field | Description |
---|---|
resources | Resources Resources allocated to Elasticsearch master nodes. |
Resources
Field | Description |
---|---|
resource_preset_id | string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation. |
disk_size | int64 Volume of the storage available to a host, in bytes. |
disk_type_id | string Type of the storage environment for the host. All available types are listed in the documentation. |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime or weekly_maintenance_window |
anytime | AnytimeMaintenanceWindow |
weekly_maintenance_window | WeeklyMaintenanceWindow |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay |
hour | int64 Hour of the day in UTC. Acceptable values are 1 to 24, inclusive. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
UpdateClusterMetadata
Field | Description |
---|---|
cluster_id | string ID of the Elasticsearch cluster that is being updated. |
Cluster
Field | Description |
---|---|
id | string ID of the Elasticsearch cluster. This ID is assigned at creation time. |
folder_id | string ID of the folder that the Elasticsearch cluster belongs to. |
created_at | google.protobuf.Timestamp Creation timestamp. |
name | string Name of the Elasticsearch cluster. The name must be unique within the folder. 1-63 characters long. |
description | string Description of the Elasticsearch cluster. 0-256 characters long. |
labels | map<string,string> Custom labels for the Elasticsearch cluster as key:value pairs. A maximum of 64 labels per resource is allowed. |
environment | enum Environment Deployment environment of the Elasticsearch cluster.
|
monitoring[] | Monitoring Description of monitoring systems relevant to the Elasticsearch cluster. |
config | ClusterConfig Configuration of the Elasticsearch cluster. |
network_id | string ID of the network that the cluster belongs to. |
health | enum Health Aggregated cluster health.
|
status | enum Status Current state of the cluster.
|
security_group_ids[] | string User security groups |
service_account_id | string ID of the service account used for access to Object Storage. |
deletion_protection | bool Deletion Protection inhibits deletion of the cluster |
maintenance_window | MaintenanceWindow Window of maintenance operations. |
planned_operation | MaintenanceOperation Maintenance operation planned at nearest maintenance_window. |
Monitoring
Field | Description |
---|---|
name | string Name of the monitoring system. |
description | string Description of the monitoring system. |
link | string Link to the monitoring system charts for the Elasticsearch cluster. |
ClusterConfig
Field | Description |
---|---|
version | string Elasticsearch version. |
elasticsearch | Elasticsearch Configuration and resource allocation for Elasticsearch nodes. |
edition | string ElasticSearch edition. |
Elasticsearch
Field | Description |
---|---|
data_node | DataNode Configuration and resource allocation for Elasticsearch data nodes. |
master_node | MasterNode Configuration and resource allocation for Elasticsearch master nodes. |
plugins[] | string Cluster wide plugins |
DataNode
Field | Description |
---|---|
config | oneof: elasticsearch_config_set_7 |
elasticsearch_config_set_7 | config.ElasticsearchConfigSet7 Elasticsearch 7.x data node configuration. |
resources | Resources Resources allocated to Elasticsearch data nodes. |
MasterNode
Field | Description |
---|---|
resources | Resources Resources allocated to Elasticsearch master nodes. |
MaintenanceOperation
Field | Description |
---|---|
info | string The maximum string length in characters is 256. |
delayed_until | google.protobuf.Timestamp |
Delete
Deletes the specified Elasticsearch cluster.
rpc Delete (DeleteClusterRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:DeleteClusterMetadata
Operation.response:google.protobuf.Empty
DeleteClusterRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the Elasticsearch cluster to delete. To get the Elasticsearch cluster ID, make a ClusterService.List request. The maximum string length in characters is 50. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
DeleteClusterMetadata
Field | Description |
---|---|
cluster_id | string ID of the Elasticsearch cluster that is being deleted. |
Move
Moves the specified Elasticsearch cluster to the specified folder.
rpc Move (MoveClusterRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:MoveClusterMetadata
Operation.response:Cluster
MoveClusterRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the Elasticsearch cluster to move. To get the Elasticsearch cluster ID, make a ClusterService.List request. The maximum string length in characters is 50. |
destination_folder_id | string Required. ID of the destination folder. The maximum string length in characters is 50. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
MoveClusterMetadata
Field | Description |
---|---|
cluster_id | string ID of the Elasticsearch cluster being moved. |
source_folder_id | string ID of the source folder. |
destination_folder_id | string ID of the destination folder. |
Cluster
Field | Description |
---|---|
id | string ID of the Elasticsearch cluster. This ID is assigned at creation time. |
folder_id | string ID of the folder that the Elasticsearch cluster belongs to. |
created_at | google.protobuf.Timestamp Creation timestamp. |
name | string Name of the Elasticsearch cluster. The name must be unique within the folder. 1-63 characters long. |
description | string Description of the Elasticsearch cluster. 0-256 characters long. |
labels | map<string,string> Custom labels for the Elasticsearch cluster as key:value pairs. A maximum of 64 labels per resource is allowed. |
environment | enum Environment Deployment environment of the Elasticsearch cluster.
|
monitoring[] | Monitoring Description of monitoring systems relevant to the Elasticsearch cluster. |
config | ClusterConfig Configuration of the Elasticsearch cluster. |
network_id | string ID of the network that the cluster belongs to. |
health | enum Health Aggregated cluster health.
|
status | enum Status Current state of the cluster.
|
security_group_ids[] | string User security groups |
service_account_id | string ID of the service account used for access to Object Storage. |
deletion_protection | bool Deletion Protection inhibits deletion of the cluster |
maintenance_window | MaintenanceWindow Window of maintenance operations. |
planned_operation | MaintenanceOperation Maintenance operation planned at nearest maintenance_window. |
Monitoring
Field | Description |
---|---|
name | string Name of the monitoring system. |
description | string Description of the monitoring system. |
link | string Link to the monitoring system charts for the Elasticsearch cluster. |
ClusterConfig
Field | Description |
---|---|
version | string Elasticsearch version. |
elasticsearch | Elasticsearch Configuration and resource allocation for Elasticsearch nodes. |
edition | string ElasticSearch edition. |
Elasticsearch
Field | Description |
---|---|
data_node | DataNode Configuration and resource allocation for Elasticsearch data nodes. |
master_node | MasterNode Configuration and resource allocation for Elasticsearch master nodes. |
plugins[] | string Cluster wide plugins |
DataNode
Field | Description |
---|---|
config | oneof: elasticsearch_config_set_7 |
elasticsearch_config_set_7 | config.ElasticsearchConfigSet7 Elasticsearch 7.x data node configuration. |
resources | Resources Resources allocated to Elasticsearch data nodes. |
MasterNode
Field | Description |
---|---|
resources | Resources Resources allocated to Elasticsearch master nodes. |
Resources
Field | Description |
---|---|
resource_preset_id | string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation. |
disk_size | int64 Volume of the storage available to a host, in bytes. |
disk_type_id | string Type of the storage environment for the host. All available types are listed in the documentation. |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime or weekly_maintenance_window |
anytime | AnytimeMaintenanceWindow |
weekly_maintenance_window | WeeklyMaintenanceWindow |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay |
hour | int64 Hour of the day in UTC. Acceptable values are 1 to 24, inclusive. |
MaintenanceOperation
Field | Description |
---|---|
info | string The maximum string length in characters is 256. |
delayed_until | google.protobuf.Timestamp |
Start
Starts the specified Elasticsearch cluster.
rpc Start (StartClusterRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:StartClusterMetadata
Operation.response:Cluster
StartClusterRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the Elasticsearch cluster to start. To get the Elasticsearch cluster ID, make a ClusterService.List request. The maximum string length in characters is 50. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
StartClusterMetadata
Field | Description |
---|---|
cluster_id | string ID of the Elasticsearch cluster. |
Cluster
Field | Description |
---|---|
id | string ID of the Elasticsearch cluster. This ID is assigned at creation time. |
folder_id | string ID of the folder that the Elasticsearch cluster belongs to. |
created_at | google.protobuf.Timestamp Creation timestamp. |
name | string Name of the Elasticsearch cluster. The name must be unique within the folder. 1-63 characters long. |
description | string Description of the Elasticsearch cluster. 0-256 characters long. |
labels | map<string,string> Custom labels for the Elasticsearch cluster as key:value pairs. A maximum of 64 labels per resource is allowed. |
environment | enum Environment Deployment environment of the Elasticsearch cluster.
|
monitoring[] | Monitoring Description of monitoring systems relevant to the Elasticsearch cluster. |
config | ClusterConfig Configuration of the Elasticsearch cluster. |
network_id | string ID of the network that the cluster belongs to. |
health | enum Health Aggregated cluster health.
|
status | enum Status Current state of the cluster.
|
security_group_ids[] | string User security groups |
service_account_id | string ID of the service account used for access to Object Storage. |
deletion_protection | bool Deletion Protection inhibits deletion of the cluster |
maintenance_window | MaintenanceWindow Window of maintenance operations. |
planned_operation | MaintenanceOperation Maintenance operation planned at nearest maintenance_window. |
Monitoring
Field | Description |
---|---|
name | string Name of the monitoring system. |
description | string Description of the monitoring system. |
link | string Link to the monitoring system charts for the Elasticsearch cluster. |
ClusterConfig
Field | Description |
---|---|
version | string Elasticsearch version. |
elasticsearch | Elasticsearch Configuration and resource allocation for Elasticsearch nodes. |
edition | string ElasticSearch edition. |
Elasticsearch
Field | Description |
---|---|
data_node | DataNode Configuration and resource allocation for Elasticsearch data nodes. |
master_node | MasterNode Configuration and resource allocation for Elasticsearch master nodes. |
plugins[] | string Cluster wide plugins |
DataNode
Field | Description |
---|---|
config | oneof: elasticsearch_config_set_7 |
elasticsearch_config_set_7 | config.ElasticsearchConfigSet7 Elasticsearch 7.x data node configuration. |
resources | Resources Resources allocated to Elasticsearch data nodes. |
MasterNode
Field | Description |
---|---|
resources | Resources Resources allocated to Elasticsearch master nodes. |
Resources
Field | Description |
---|---|
resource_preset_id | string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation. |
disk_size | int64 Volume of the storage available to a host, in bytes. |
disk_type_id | string Type of the storage environment for the host. All available types are listed in the documentation. |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime or weekly_maintenance_window |
anytime | AnytimeMaintenanceWindow |
weekly_maintenance_window | WeeklyMaintenanceWindow |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay |
hour | int64 Hour of the day in UTC. Acceptable values are 1 to 24, inclusive. |
MaintenanceOperation
Field | Description |
---|---|
info | string The maximum string length in characters is 256. |
delayed_until | google.protobuf.Timestamp |
Stop
Stops the specified Elasticsearch cluster.
rpc Stop (StopClusterRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:StopClusterMetadata
Operation.response:Cluster
StopClusterRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the Elasticsearch cluster to stop. To get the Elasticsearch cluster ID, make a ClusterService.List request. The maximum string length in characters is 50. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
StopClusterMetadata
Field | Description |
---|---|
cluster_id | string ID of the Elasticsearch cluster. |
Cluster
Field | Description |
---|---|
id | string ID of the Elasticsearch cluster. This ID is assigned at creation time. |
folder_id | string ID of the folder that the Elasticsearch cluster belongs to. |
created_at | google.protobuf.Timestamp Creation timestamp. |
name | string Name of the Elasticsearch cluster. The name must be unique within the folder. 1-63 characters long. |
description | string Description of the Elasticsearch cluster. 0-256 characters long. |
labels | map<string,string> Custom labels for the Elasticsearch cluster as key:value pairs. A maximum of 64 labels per resource is allowed. |
environment | enum Environment Deployment environment of the Elasticsearch cluster.
|
monitoring[] | Monitoring Description of monitoring systems relevant to the Elasticsearch cluster. |
config | ClusterConfig Configuration of the Elasticsearch cluster. |
network_id | string ID of the network that the cluster belongs to. |
health | enum Health Aggregated cluster health.
|
status | enum Status Current state of the cluster.
|
security_group_ids[] | string User security groups |
service_account_id | string ID of the service account used for access to Object Storage. |
deletion_protection | bool Deletion Protection inhibits deletion of the cluster |
maintenance_window | MaintenanceWindow Window of maintenance operations. |
planned_operation | MaintenanceOperation Maintenance operation planned at nearest maintenance_window. |
Monitoring
Field | Description |
---|---|
name | string Name of the monitoring system. |
description | string Description of the monitoring system. |
link | string Link to the monitoring system charts for the Elasticsearch cluster. |
ClusterConfig
Field | Description |
---|---|
version | string Elasticsearch version. |
elasticsearch | Elasticsearch Configuration and resource allocation for Elasticsearch nodes. |
edition | string ElasticSearch edition. |
Elasticsearch
Field | Description |
---|---|
data_node | DataNode Configuration and resource allocation for Elasticsearch data nodes. |
master_node | MasterNode Configuration and resource allocation for Elasticsearch master nodes. |
plugins[] | string Cluster wide plugins |
DataNode
Field | Description |
---|---|
config | oneof: elasticsearch_config_set_7 |
elasticsearch_config_set_7 | config.ElasticsearchConfigSet7 Elasticsearch 7.x data node configuration. |
resources | Resources Resources allocated to Elasticsearch data nodes. |
MasterNode
Field | Description |
---|---|
resources | Resources Resources allocated to Elasticsearch master nodes. |
Resources
Field | Description |
---|---|
resource_preset_id | string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation. |
disk_size | int64 Volume of the storage available to a host, in bytes. |
disk_type_id | string Type of the storage environment for the host. All available types are listed in the documentation. |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime or weekly_maintenance_window |
anytime | AnytimeMaintenanceWindow |
weekly_maintenance_window | WeeklyMaintenanceWindow |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay |
hour | int64 Hour of the day in UTC. Acceptable values are 1 to 24, inclusive. |
MaintenanceOperation
Field | Description |
---|---|
info | string The maximum string length in characters is 256. |
delayed_until | google.protobuf.Timestamp |
Backup
Create a backup for the specified ElasticSearch cluster.
rpc Backup (BackupClusterRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:BackupClusterMetadata
Operation.response:Cluster
BackupClusterRequest
Field | Description |
---|---|
cluster_id | string Required. Required. ID of the ElasticSearch cluster to back up. The maximum string length in characters is 50. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
BackupClusterMetadata
Field | Description |
---|---|
cluster_id | string ID of the ElasticSearch cluster. |
Cluster
Field | Description |
---|---|
id | string ID of the Elasticsearch cluster. This ID is assigned at creation time. |
folder_id | string ID of the folder that the Elasticsearch cluster belongs to. |
created_at | google.protobuf.Timestamp Creation timestamp. |
name | string Name of the Elasticsearch cluster. The name must be unique within the folder. 1-63 characters long. |
description | string Description of the Elasticsearch cluster. 0-256 characters long. |
labels | map<string,string> Custom labels for the Elasticsearch cluster as key:value pairs. A maximum of 64 labels per resource is allowed. |
environment | enum Environment Deployment environment of the Elasticsearch cluster.
|
monitoring[] | Monitoring Description of monitoring systems relevant to the Elasticsearch cluster. |
config | ClusterConfig Configuration of the Elasticsearch cluster. |
network_id | string ID of the network that the cluster belongs to. |
health | enum Health Aggregated cluster health.
|
status | enum Status Current state of the cluster.
|
security_group_ids[] | string User security groups |
service_account_id | string ID of the service account used for access to Object Storage. |
deletion_protection | bool Deletion Protection inhibits deletion of the cluster |
maintenance_window | MaintenanceWindow Window of maintenance operations. |
planned_operation | MaintenanceOperation Maintenance operation planned at nearest maintenance_window. |
Monitoring
Field | Description |
---|---|
name | string Name of the monitoring system. |
description | string Description of the monitoring system. |
link | string Link to the monitoring system charts for the Elasticsearch cluster. |
ClusterConfig
Field | Description |
---|---|
version | string Elasticsearch version. |
elasticsearch | Elasticsearch Configuration and resource allocation for Elasticsearch nodes. |
edition | string ElasticSearch edition. |
Elasticsearch
Field | Description |
---|---|
data_node | DataNode Configuration and resource allocation for Elasticsearch data nodes. |
master_node | MasterNode Configuration and resource allocation for Elasticsearch master nodes. |
plugins[] | string Cluster wide plugins |
DataNode
Field | Description |
---|---|
config | oneof: elasticsearch_config_set_7 |
elasticsearch_config_set_7 | config.ElasticsearchConfigSet7 Elasticsearch 7.x data node configuration. |
resources | Resources Resources allocated to Elasticsearch data nodes. |
MasterNode
Field | Description |
---|---|
resources | Resources Resources allocated to Elasticsearch master nodes. |
Resources
Field | Description |
---|---|
resource_preset_id | string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation. |
disk_size | int64 Volume of the storage available to a host, in bytes. |
disk_type_id | string Type of the storage environment for the host. All available types are listed in the documentation. |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime or weekly_maintenance_window |
anytime | AnytimeMaintenanceWindow |
weekly_maintenance_window | WeeklyMaintenanceWindow |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay |
hour | int64 Hour of the day in UTC. Acceptable values are 1 to 24, inclusive. |
MaintenanceOperation
Field | Description |
---|---|
info | string The maximum string length in characters is 256. |
delayed_until | google.protobuf.Timestamp |
ListBackups
Returns the list of available backups for the specified Elasticsearch cluster.
rpc ListBackups (ListClusterBackupsRequest) returns (ListClusterBackupsResponse)
ListClusterBackupsRequest
Field | Description |
---|---|
cluster_id | string Required. Required. ID of the Elasticsearch cluster. The maximum string length in characters is 50. |
page_size | int64 The maximum number of results per page that should be returned. If the number of available results is larger than page_size , the service returns a next_page_token that can be used to get the next page of results in subsequent ListClusterBackups requests. Acceptable values are 0 to 1000, inclusive. Default value: 100. Acceptable values are 0 to 1000, inclusive. |
page_token | string Page token. Set page_token to the next_page_token returned by a previous ListClusterBackups request to get the next page of results. The maximum string length in characters is 100. |
ListClusterBackupsResponse
Field | Description |
---|---|
backups[] | Backup Requested list of backups. |
next_page_token | string This token allows you to get the next page of results for ListClusterBackups requests, if the number of results is larger than page_size specified in the request. To get the next page, specify the value of next_page_token as a value for the page_token parameter in the next ListClusterBackups request. Subsequent ListClusterBackups requests will have their own next_page_token to continue paging through the results. |
Backup
Field | Description |
---|---|
id | string Required. ID of the backup. |
folder_id | string ID of the folder that the backup belongs to. |
source_cluster_id | string ID of the associated Elasticsearch cluster. |
started_at | google.protobuf.Timestamp The time when the backup operation was started. |
created_at | google.protobuf.Timestamp The time when the backup was created (i.e. when the backup operation completed). |
indices[] | string Indices names. (max 100) The maximum number of elements is 100. |
elasticsearch_version | string Elasticsearch version used to create the snapshot |
size_bytes | int64 Total size of all indices in backup. in bytes |
indices_total | int64 Total count of indices in backup |
Restore
Creates a new ElasticSearch cluster from the specified backup.
rpc Restore (RestoreClusterRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:RestoreClusterMetadata
Operation.response:Cluster
RestoreClusterRequest
Field | Description |
---|---|
backup_id | string Required. Required. ID of the backup to restore from. |
name | string Required. Name of the ElasticSearch cluster. The name must be unique within the folder. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]* . |
description | string Description of the ElasticSearch cluster. The maximum string length in characters is 256. |
labels | map<string,string> Custom labels for the ElasticSearch cluster as key:value pairs. Maximum 64 per resource. For example, "project": "mvp" or "source": "dictionary". No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_0-9a-z]* . The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]* . |
environment | Cluster.Environment Deployment environment of the ElasticSearch cluster. |
config_spec | ConfigSpec Required. Configuration and resources for hosts that should be created for the ElasticSearch cluster. |
host_specs[] | HostSpec Required. Configuration of ElasticSearch hosts. The number of elements must be greater than 0. |
network_id | string Required. ID of the network to create the cluster in. The maximum string length in characters is 50. |
security_group_ids[] | string User security groups |
service_account_id | string ID of the service account used for access to Object Storage. |
deletion_protection | bool Deletion Protection inhibits deletion of the cluster |
folder_id | string Required. ID of the folder to create the ElasticSearch cluster in. The maximum string length in characters is 50. |
extension_specs[] | ExtensionSpec |
ConfigSpec
Field | Description |
---|---|
version | string Elasticsearch version. |
elasticsearch_spec | ElasticsearchSpec Configuration and resource allocation for Elasticsearch nodes. |
edition | string ElasticSearch edition. |
admin_password | string Required. ElasticSearch admin password. |
ElasticsearchSpec
Field | Description |
---|---|
data_node | DataNode Configuration and resource allocation for Elasticsearch data nodes. |
master_node | MasterNode Configuration and resource allocation for Elasticsearch master nodes. |
plugins[] | string Cluster wide plugins The maximum string length in characters for each value is 50. |
DataNode
Field | Description |
---|---|
config | oneof: elasticsearch_config_7 Elasticsearch data node configuration. |
elasticsearch_config_7 | config.ElasticsearchConfig7 Elasticsearch data node configuration. |
resources | Resources Resources allocated to Elasticsearch data nodes. |
MasterNode
Field | Description |
---|---|
resources | Resources Resources allocated to Elasticsearch master nodes. |
Resources
Field | Description |
---|---|
resource_preset_id | string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation. |
disk_size | int64 Volume of the storage available to a host, in bytes. |
disk_type_id | string Type of the storage environment for the host. All available types are listed in the documentation. |
HostSpec
Field | Description |
---|---|
zone_id | string ID of the availability zone where the host resides. The maximum string length in characters is 50. |
subnet_id | string ID of the subnet the host resides in. The maximum string length in characters is 50. |
assign_public_ip | bool The flag that defines whether a public IP address is assigned to the host. If the value is true , then this host is available on the Internet via it's public IP address. |
type | Host.Type Required. Host type. |
shard_name | string The shard name to create on the host. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]* . |
ExtensionSpec
Field | Description |
---|---|
name | string Required. Name of the extension. The maximum string length in characters is 50. |
uri | string URI of the zip archive to create the new extension from. Currently only supports links that are stored in Object Storage. |
disabled | bool The flag shows whether to create the extension in disabled state. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
RestoreClusterMetadata
Field | Description |
---|---|
cluster_id | string Required. ID of the new ElasticSearch cluster. |
backup_id | string Required. ID of the backup used for recovery. |
Cluster
Field | Description |
---|---|
id | string ID of the Elasticsearch cluster. This ID is assigned at creation time. |
folder_id | string ID of the folder that the Elasticsearch cluster belongs to. |
created_at | google.protobuf.Timestamp Creation timestamp. |
name | string Name of the Elasticsearch cluster. The name must be unique within the folder. 1-63 characters long. |
description | string Description of the Elasticsearch cluster. 0-256 characters long. |
labels | map<string,string> Custom labels for the Elasticsearch cluster as key:value pairs. A maximum of 64 labels per resource is allowed. |
environment | enum Environment Deployment environment of the Elasticsearch cluster.
|
monitoring[] | Monitoring Description of monitoring systems relevant to the Elasticsearch cluster. |
config | ClusterConfig Configuration of the Elasticsearch cluster. |
network_id | string ID of the network that the cluster belongs to. |
health | enum Health Aggregated cluster health.
|
status | enum Status Current state of the cluster.
|
security_group_ids[] | string User security groups |
service_account_id | string ID of the service account used for access to Object Storage. |
deletion_protection | bool Deletion Protection inhibits deletion of the cluster |
maintenance_window | MaintenanceWindow Window of maintenance operations. |
planned_operation | MaintenanceOperation Maintenance operation planned at nearest maintenance_window. |
Monitoring
Field | Description |
---|---|
name | string Name of the monitoring system. |
description | string Description of the monitoring system. |
link | string Link to the monitoring system charts for the Elasticsearch cluster. |
ClusterConfig
Field | Description |
---|---|
version | string Elasticsearch version. |
elasticsearch | Elasticsearch Configuration and resource allocation for Elasticsearch nodes. |
edition | string ElasticSearch edition. |
Elasticsearch
Field | Description |
---|---|
data_node | DataNode Configuration and resource allocation for Elasticsearch data nodes. |
master_node | MasterNode Configuration and resource allocation for Elasticsearch master nodes. |
plugins[] | string Cluster wide plugins |
DataNode
Field | Description |
---|---|
config | oneof: elasticsearch_config_set_7 |
elasticsearch_config_set_7 | config.ElasticsearchConfigSet7 Elasticsearch 7.x data node configuration. |
resources | Resources Resources allocated to Elasticsearch data nodes. |
MasterNode
Field | Description |
---|---|
resources | Resources Resources allocated to Elasticsearch master nodes. |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime or weekly_maintenance_window |
anytime | AnytimeMaintenanceWindow |
weekly_maintenance_window | WeeklyMaintenanceWindow |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay |
hour | int64 Hour of the day in UTC. Acceptable values are 1 to 24, inclusive. |
MaintenanceOperation
Field | Description |
---|---|
info | string The maximum string length in characters is 256. |
delayed_until | google.protobuf.Timestamp |
ListLogs
Retrieves logs for the specified Elasticsearch cluster.
For more information about logs, see the Logs section in the documentation.
rpc ListLogs (ListClusterLogsRequest) returns (ListClusterLogsResponse)
ListClusterLogsRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the Elasticsearch cluster to request logs for. To get the Elasticsearch cluster ID, make a ClusterService.List request. The maximum string length in characters is 50. |
column_filter[] | string Columns from the logs table to request. If no columns are specified, full log records are returned. |
from_time | google.protobuf.Timestamp Start timestamp for the logs request. |
to_time | google.protobuf.Timestamp End timestamp for the logs request. |
page_size | int64 The maximum number of results per page to return. If the number of available results is larger than page_size , the service returns a ListClusterLogsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. The maximum value is 1000. |
page_token | string Page token. To get the next page of results, set page_token to the ListClusterLogsResponse.next_page_token returned by the previous list request. The maximum string length in characters is 100. |
always_next_page_token | bool The flag that defines behavior of providing the next page token. If this flag is set to true , this API method will always return ListClusterLogsResponse.next_page_token, even if current page is empty. |
filter | string A filter expression that filters resources listed in the response. The expression must specify:
Example of a filter: message.hostname='node1.db.cloud.yandex.net' The maximum string length in characters is 1000. |
service_type | enum ServiceType Type of the service to request logs about. |
ListClusterLogsResponse
Field | Description |
---|---|
logs[] | LogRecord Requested log records. |
next_page_token | string Token that allows you to get the next page of results for list requests. If the number of results is larger than ListClusterLogsRequest.page_size, use next_page_token as the value for the ListClusterLogsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results. This value is interchangeable with StreamLogRecord.next_record_token from StreamLogs method. |
LogRecord
Field | Description |
---|---|
timestamp | google.protobuf.Timestamp Log record timestamp. |
message | map<string,string> Contents of the log record. |
StreamLogs
Same as ListLogs but using server-side streaming. Also supports tail -f
semantics.
rpc StreamLogs (StreamClusterLogsRequest) returns (stream StreamLogRecord)
StreamClusterLogsRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the Elasticsearch cluster. To get the Elasticsearch cluster ID, make a ClusterService.List request. The maximum string length in characters is 50. |
column_filter[] | string Columns from logs table to get in the response. If no columns are specified, full log records are returned. |
from_time | google.protobuf.Timestamp Start timestamp for the logs request. |
to_time | google.protobuf.Timestamp End timestamp for the logs request. If this field is not set, all existing logs will be sent and then the new ones asthey appear. In essence it has tail -f semantics. |
record_token | string Record token. Set record_token to the StreamLogRecord.next_record_token returned by a previous ClusterService.StreamLogs request to start streaming from next log record. The maximum string length in characters is 100. |
filter | string A filter expression that filters resources listed in the response. The expression must specify:
Example of a filter: message.hostname='node1.db.cloud.yandex.net' The maximum string length in characters is 1000. |
service_type | enum ServiceType Type of the service to request logs about. |
StreamLogRecord
Field | Description |
---|---|
record | LogRecord One of the requested log records. |
next_record_token | string This token allows you to continue streaming logs starting from the exact same record. To continue streaming, specify value of next_record_token as value for StreamClusterLogsRequest.record_token parameter in the next StreamLogs request. This value is interchangeable with ListClusterLogsResponse.next_page_token from ListLogs method. |
LogRecord
Field | Description |
---|---|
timestamp | google.protobuf.Timestamp Log record timestamp. |
message | map<string,string> Contents of the log record. |
ListOperations
Retrieves the list of operations for the specified Elasticsearch cluster.
rpc ListOperations (ListClusterOperationsRequest) returns (ListClusterOperationsResponse)
ListClusterOperationsRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the Elasticsearch cluster to list operations for. To get the Elasticsearch cluster ID, make a ClusterService.List request. The maximum string length in characters is 50. |
page_size | int64 The maximum number of results per page to return. If the number of available results is larger than page_size , the service returns a ListClusterOperationsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. The maximum value is 1000. |
page_token | string Page token. To get the next page of results, set page_token to the ListClusterOperationsResponse.next_page_token returned by the previous list request. The maximum string length in characters is 100. |
ListClusterOperationsResponse
Field | Description |
---|---|
operations[] | operation.Operation List of operations for the specified Elasticsearch cluster. |
next_page_token | string Token that allows you to get the next page of results for list requests. If the number of results is larger than ListClusterOperationsRequest.page_size, use the next_page_token as the value for the ListClusterOperationsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty |
ListHosts
Retrieves a list of hosts for the specified Elasticsearch cluster.
rpc ListHosts (ListClusterHostsRequest) returns (ListClusterHostsResponse)
ListClusterHostsRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the Elasticsearch cluster. To get the Elasticsearch cluster ID, make a ClusterService.List request. The maximum string length in characters is 50. |
page_size | int64 The maximum number of results per page to return. If the number of available results is larger than page_size , the service returns a ListClusterHostsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. The maximum value is 1000. |
page_token | string Page token. To get the next page of results, set page_token to the ListClusterHostsResponse.next_page_token returned by the previous list request. The maximum string length in characters is 100. |
ListClusterHostsResponse
Field | Description |
---|---|
hosts[] | Host List of hosts. |
next_page_token | string Token that allows you to get the next page of results for list requests. If the number of results is larger than ListClusterHostsRequest.page_size, use the next_page_token as the value for the ListClusterHostsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results. |
Host
Field | Description |
---|---|
name | string Name of the host. |
cluster_id | string ID of the Elasticsearch cluster. |
zone_id | string ID of the availability zone where the host resides. |
type | enum Type Host type.
|
resources | Resources |
health | enum Health Aggregated host health data. If the field has default value, it is not returned in the response.
|
services[] | Service Services provided by the host. |
subnet_id | string ID of the subnet the host resides in. |
assign_public_ip | bool The flag that defines whether a public IP address is assigned to the host. If the value is true , then this host is available on the Internet via it's public IP address. |
Resources
Field | Description |
---|---|
resource_preset_id | string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation. |
disk_size | int64 Volume of the storage available to a host, in bytes. |
disk_type_id | string Type of the storage environment for the host. All available types are listed in the documentation. |
Service
Field | Description |
---|---|
type | enum Type Type of the service provided by the host.
|
health | enum Health Service health data. If the field has default value, it is not returned in the response.
|
AddHosts
Adds new hosts to the specified Elasticsearch cluster.
rpc AddHosts (AddClusterHostsRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:AddClusterHostsMetadata
Operation.response:google.protobuf.Empty
AddClusterHostsRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the Elasticsearch cluster. To get the Elasticsearch cluster ID, make a ClusterService.List request. The maximum string length in characters is 50. |
host_specs[] | HostSpec One or more configurations of hosts to be added to the Elasticsearch cluster. The number of elements must be greater than 0. |
HostSpec
Field | Description |
---|---|
zone_id | string ID of the availability zone where the host resides. The maximum string length in characters is 50. |
subnet_id | string ID of the subnet the host resides in. The maximum string length in characters is 50. |
assign_public_ip | bool The flag that defines whether a public IP address is assigned to the host. If the value is true , then this host is available on the Internet via it's public IP address. |
type | Host.Type Required. Host type. |
shard_name | string The shard name to create on the host. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]* . |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
AddClusterHostsMetadata
Field | Description |
---|---|
cluster_id | string ID of the Elasticsearch cluster. |
host_names[] | string Names of the host that are being added. |
DeleteHosts
Deletes specified hosts from the specified Elasticsearch cluster.
rpc DeleteHosts (DeleteClusterHostsRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:DeleteClusterHostsMetadata
Operation.response:google.protobuf.Empty
DeleteClusterHostsRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the Elasticsearch cluster. To get the Elasticsearch cluster ID, make a ClusterService.List request. The maximum string length in characters is 50. |
host_names[] | string Names of the hosts to delete. The number of elements must be greater than 0. The maximum string length in characters for each value is 253. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
DeleteClusterHostsMetadata
Field | Description |
---|---|
cluster_id | string ID of the Elasticsearch cluster. |
host_names[] | string Names of the hosts that are being deleted. |
RescheduleMaintenance
Reschedule planned maintenance operation.
rpc RescheduleMaintenance (RescheduleMaintenanceRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:RescheduleMaintenanceMetadata
Operation.response:Cluster
RescheduleMaintenanceRequest
Field | Description |
---|---|
cluster_id | string Required. Required. ID of the Elasticsearch cluster to maintenance reschedule. The maximum string length in characters is 50. |
reschedule_type | enum RescheduleType Required. Required. The type of reschedule request. |
delayed_until | google.protobuf.Timestamp The time for SPECIFIC_TIME reschedule. Limited by two weeks since first time scheduled. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
RescheduleMaintenanceMetadata
Field | Description |
---|---|
cluster_id | string Required. ID of the Elasticsearch cluster. |
delayed_until | google.protobuf.Timestamp Required. New time of the planned maintenance. Can be in the past for rescheduled to "IMMEDIATE". |
Cluster
Field | Description |
---|---|
id | string ID of the Elasticsearch cluster. This ID is assigned at creation time. |
folder_id | string ID of the folder that the Elasticsearch cluster belongs to. |
created_at | google.protobuf.Timestamp Creation timestamp. |
name | string Name of the Elasticsearch cluster. The name must be unique within the folder. 1-63 characters long. |
description | string Description of the Elasticsearch cluster. 0-256 characters long. |
labels | map<string,string> Custom labels for the Elasticsearch cluster as key:value pairs. A maximum of 64 labels per resource is allowed. |
environment | enum Environment Deployment environment of the Elasticsearch cluster.
|
monitoring[] | Monitoring Description of monitoring systems relevant to the Elasticsearch cluster. |
config | ClusterConfig Configuration of the Elasticsearch cluster. |
network_id | string ID of the network that the cluster belongs to. |
health | enum Health Aggregated cluster health.
|
status | enum Status Current state of the cluster.
|
security_group_ids[] | string User security groups |
service_account_id | string ID of the service account used for access to Object Storage. |
deletion_protection | bool Deletion Protection inhibits deletion of the cluster |
maintenance_window | MaintenanceWindow Window of maintenance operations. |
planned_operation | MaintenanceOperation Maintenance operation planned at nearest maintenance_window. |
Monitoring
Field | Description |
---|---|
name | string Name of the monitoring system. |
description | string Description of the monitoring system. |
link | string Link to the monitoring system charts for the Elasticsearch cluster. |
ClusterConfig
Field | Description |
---|---|
version | string Elasticsearch version. |
elasticsearch | Elasticsearch Configuration and resource allocation for Elasticsearch nodes. |
edition | string ElasticSearch edition. |
Elasticsearch
Field | Description |
---|---|
data_node | DataNode Configuration and resource allocation for Elasticsearch data nodes. |
master_node | MasterNode Configuration and resource allocation for Elasticsearch master nodes. |
plugins[] | string Cluster wide plugins |
DataNode
Field | Description |
---|---|
config | oneof: elasticsearch_config_set_7 |
elasticsearch_config_set_7 | config.ElasticsearchConfigSet7 Elasticsearch 7.x data node configuration. |
resources | Resources Resources allocated to Elasticsearch data nodes. |
MasterNode
Field | Description |
---|---|
resources | Resources Resources allocated to Elasticsearch master nodes. |
Resources
Field | Description |
---|---|
resource_preset_id | string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation. |
disk_size | int64 Volume of the storage available to a host, in bytes. |
disk_type_id | string Type of the storage environment for the host. All available types are listed in the documentation. |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime or weekly_maintenance_window |
anytime | AnytimeMaintenanceWindow |
weekly_maintenance_window | WeeklyMaintenanceWindow |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay |
hour | int64 Hour of the day in UTC. Acceptable values are 1 to 24, inclusive. |
MaintenanceOperation
Field | Description |
---|---|
info | string The maximum string length in characters is 256. |
delayed_until | google.protobuf.Timestamp |