Managed Service for Elasticsearch API, REST: Cluster methods
A set of methods for managing Elasticsearch clusters.
JSON Representation
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "object",
"environment": "string",
"monitoring": [
{
"name": "string",
"description": "string",
"link": "string"
}
],
"config": {
"version": "string",
"elasticsearch": {
"dataNode": {
"resources": {
"resourcePresetId": "string",
"diskSize": "string",
"diskTypeId": "string"
},
"elasticsearchConfigSet_7": {
"effectiveConfig": {
"maxClauseCount": "integer",
"fielddataCacheSize": "string",
"reindexRemoteWhitelist": "string",
"reindexSslCaPath": "string"
},
"userConfig": {
"maxClauseCount": "integer",
"fielddataCacheSize": "string",
"reindexRemoteWhitelist": "string",
"reindexSslCaPath": "string"
},
"defaultConfig": {
"maxClauseCount": "integer",
"fielddataCacheSize": "string",
"reindexRemoteWhitelist": "string",
"reindexSslCaPath": "string"
}
}
},
"masterNode": {
"resources": {
"resourcePresetId": "string",
"diskSize": "string",
"diskTypeId": "string"
}
},
"plugins": [
"string"
]
},
"edition": "string"
},
"networkId": "string",
"health": "string",
"status": "string",
"securityGroupIds": [
"string"
],
"serviceAccountId": "string",
"deletionProtection": true,
"maintenanceWindow": {
// `maintenanceWindow` includes only one of the fields `anytime`, `weeklyMaintenanceWindow`
"anytime": {},
"weeklyMaintenanceWindow": {
"day": "string",
"hour": "string"
},
// end of the list of possible fields`maintenanceWindow`
},
"plannedOperation": {
"info": "string",
"delayedUntil": "string"
}
}
Field | Description |
---|---|
id | string ID of the Elasticsearch cluster. This ID is assigned at creation time. |
folderId | string ID of the folder that the Elasticsearch cluster belongs to. |
createdAt | string (date-time) Creation timestamp. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
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 | object Custom labels for the Elasticsearch cluster as |
environment | string Deployment environment of the Elasticsearch cluster.
|
monitoring[] | object Description of monitoring systems relevant to the Elasticsearch cluster. |
monitoring[]. name |
string Name of the monitoring system. |
monitoring[]. description |
string Description of the monitoring system. |
monitoring[]. link |
string Link to the monitoring system charts for the Elasticsearch cluster. |
config | object Configuration of the Elasticsearch cluster. |
config. version |
string Elasticsearch version. |
config. elasticsearch |
object Configuration and resource allocation for Elasticsearch nodes. |
config. elasticsearch. dataNode |
object Configuration and resource allocation for Elasticsearch data nodes. |
config. elasticsearch. dataNode. resources |
object Resources allocated to Elasticsearch data nodes. |
config. elasticsearch. dataNode. resources. resourcePresetId |
string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation. |
config. elasticsearch. dataNode. resources. diskSize |
string (int64) Volume of the storage available to a host, in bytes. |
config. elasticsearch. dataNode. resources. diskTypeId |
string Type of the storage environment for the host. All available types are listed in the documentation. |
config. elasticsearch. dataNode. elasticsearchConfigSet_7 |
object Elasticsearch 7.x data node configuration. |
config. elasticsearch. dataNode. elasticsearchConfigSet_7. effectiveConfig |
object Required. Effective settings for an Elasticsearch cluster (a combination of settings defined in Elasticsearch 7.x supported configuration options are listed here. Detailed description for each set of options is available in Elasticsearch documentation. Any options that are not listed here are not supported. |
config. elasticsearch. dataNode. elasticsearchConfigSet_7. effectiveConfig. maxClauseCount |
integer (int64) The maximum number of clauses a boolean query can contain. The limit is in place to prevent searches from becoming too large and taking up too much CPU and memory. It affects not only Elasticsearch's Default value: See in-depth description in Elasticsearch documentation. |
config. elasticsearch. dataNode. elasticsearchConfigSet_7. effectiveConfig. fielddataCacheSize |
string The maximum percentage or absolute value (10%, 512mb) of heap space that is allocated to field data cache. All the field values that are placed in this cache, get loaded to memory in order to provide fast document based access to those values. Building the field data cache for a field can be an expensive operations, so its recommended to have enough memory for this cache, and to keep it loaded. Default value: unbounded. See in-depth description in Elasticsearch documentation. |
config. elasticsearch. dataNode. elasticsearchConfigSet_7. effectiveConfig. reindexRemoteWhitelist |
string Remote hosts for reindex have to be explicitly allowed in elasticsearch.yml using the reindex.remote.whitelist property. It can be set to a comma delimited list of allowed remote host and port combinations. Scheme is ignored, only the host and port are used. |
config. elasticsearch. dataNode. elasticsearchConfigSet_7. effectiveConfig. reindexSslCaPath |
string List of paths to PEM encoded certificate files that should be trusted. See in-depth description in Elasticsearch documentation |
config. elasticsearch. dataNode. elasticsearchConfigSet_7. userConfig |
object User-defined settings for an Elasticsearch cluster. Elasticsearch 7.x supported configuration options are listed here. Detailed description for each set of options is available in Elasticsearch documentation. Any options that are not listed here are not supported. |
config. elasticsearch. dataNode. elasticsearchConfigSet_7. userConfig. maxClauseCount |
integer (int64) The maximum number of clauses a boolean query can contain. The limit is in place to prevent searches from becoming too large and taking up too much CPU and memory. It affects not only Elasticsearch's Default value: See in-depth description in Elasticsearch documentation. |
config. elasticsearch. dataNode. elasticsearchConfigSet_7. userConfig. fielddataCacheSize |
string The maximum percentage or absolute value (10%, 512mb) of heap space that is allocated to field data cache. All the field values that are placed in this cache, get loaded to memory in order to provide fast document based access to those values. Building the field data cache for a field can be an expensive operations, so its recommended to have enough memory for this cache, and to keep it loaded. Default value: unbounded. See in-depth description in Elasticsearch documentation. |
config. elasticsearch. dataNode. elasticsearchConfigSet_7. userConfig. reindexRemoteWhitelist |
string Remote hosts for reindex have to be explicitly allowed in elasticsearch.yml using the reindex.remote.whitelist property. It can be set to a comma delimited list of allowed remote host and port combinations. Scheme is ignored, only the host and port are used. |
config. elasticsearch. dataNode. elasticsearchConfigSet_7. userConfig. reindexSslCaPath |
string List of paths to PEM encoded certificate files that should be trusted. See in-depth description in Elasticsearch documentation |
config. elasticsearch. dataNode. elasticsearchConfigSet_7. defaultConfig |
object Default settings for an Elasticsearch cluster. Elasticsearch 7.x supported configuration options are listed here. Detailed description for each set of options is available in Elasticsearch documentation. Any options that are not listed here are not supported. |
config. elasticsearch. dataNode. elasticsearchConfigSet_7. defaultConfig. maxClauseCount |
integer (int64) The maximum number of clauses a boolean query can contain. The limit is in place to prevent searches from becoming too large and taking up too much CPU and memory. It affects not only Elasticsearch's Default value: See in-depth description in Elasticsearch documentation. |
config. elasticsearch. dataNode. elasticsearchConfigSet_7. defaultConfig. fielddataCacheSize |
string The maximum percentage or absolute value (10%, 512mb) of heap space that is allocated to field data cache. All the field values that are placed in this cache, get loaded to memory in order to provide fast document based access to those values. Building the field data cache for a field can be an expensive operations, so its recommended to have enough memory for this cache, and to keep it loaded. Default value: unbounded. See in-depth description in Elasticsearch documentation. |
config. elasticsearch. dataNode. elasticsearchConfigSet_7. defaultConfig. reindexRemoteWhitelist |
string Remote hosts for reindex have to be explicitly allowed in elasticsearch.yml using the reindex.remote.whitelist property. It can be set to a comma delimited list of allowed remote host and port combinations. Scheme is ignored, only the host and port are used. |
config. elasticsearch. dataNode. elasticsearchConfigSet_7. defaultConfig. reindexSslCaPath |
string List of paths to PEM encoded certificate files that should be trusted. See in-depth description in Elasticsearch documentation |
config. elasticsearch. masterNode |
object Configuration and resource allocation for Elasticsearch master nodes. |
config. elasticsearch. masterNode. resources |
object Resources allocated to Elasticsearch master nodes. Computational resources. |
config. elasticsearch. masterNode. resources. resourcePresetId |
string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation. |
config. elasticsearch. masterNode. resources. diskSize |
string (int64) Volume of the storage available to a host, in bytes. |
config. elasticsearch. masterNode. resources. diskTypeId |
string Type of the storage environment for the host. All available types are listed in the documentation. |
config. elasticsearch. plugins[] |
string Cluster wide plugins |
config. edition |
string ElasticSearch edition. |
networkId | string ID of the network that the cluster belongs to. |
health | string Aggregated cluster health.
|
status | string Current state of the cluster.
|
securityGroupIds[] | string User security groups |
serviceAccountId | string ID of the service account used for access to Object Storage. |
deletionProtection | boolean (boolean) Deletion Protection inhibits deletion of the cluster |
maintenanceWindow | object Window of maintenance operations. |
maintenanceWindow. anytime |
object maintenanceWindow includes only one of the fields anytime , weeklyMaintenanceWindow |
maintenanceWindow. weeklyMaintenanceWindow |
object maintenanceWindow includes only one of the fields anytime , weeklyMaintenanceWindow |
maintenanceWindow. weeklyMaintenanceWindow. day |
string |
maintenanceWindow. weeklyMaintenanceWindow. hour |
string (int64) Hour of the day in UTC. Acceptable values are 1 to 24, inclusive. |
plannedOperation | object Maintenance operation planned at nearest maintenance_window. |
plannedOperation. info |
string The maximum string length in characters is 256. |
plannedOperation. delayedUntil |
string (date-time) String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
Methods
Method | Description |
---|---|
addHosts | Adds new hosts to the specified Elasticsearch cluster. |
backup | Create a backup for the specified ElasticSearch cluster. |
create | Creates a new Elasticsearch cluster in the specified folder. |
delete | Deletes the specified Elasticsearch cluster. |
deleteHosts | Deletes specified hosts from the specified Elasticsearch cluster. |
get | Returns the specified Elasticsearch cluster. |
list | Retrieves the list of Elasticsearch clusters that belong to the specified folder. |
listBackups | Returns the list of available backups for the specified Elasticsearch cluster. |
listHosts | Retrieves a list of hosts for the specified Elasticsearch cluster. |
listLogs | Retrieves logs for the specified Elasticsearch cluster. |
listOperations | Retrieves the list of operations for the specified Elasticsearch cluster. |
move | Moves the specified Elasticsearch cluster to the specified folder. |
rescheduleMaintenance | Reschedule planned maintenance operation. |
restore | Creates a new ElasticSearch cluster from the specified backup. |
start | Starts the specified Elasticsearch cluster. |
stop | Stops the specified Elasticsearch cluster. |
streamLogs | Same as listLogs but using server-side streaming. Also supports tail -f semantics. |
update | Updates the specified Elasticsearch cluster. |