Managed Service for OpenSearch API, REST: Cluster methods
A set of methods for managing OpenSearch 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",
"opensearch": {
"plugins": [
"string"
],
"nodeGroups": [
{
"name": "string",
"resources": {
"resourcePresetId": "string",
"diskSize": "string",
"diskTypeId": "string"
},
"hostsCount": "string",
"zoneIds": [
"string"
],
"subnetIds": [
"string"
],
"assignPublicIp": true,
"roles": [
"string"
]
}
],
"opensearchConfigSet_2": {
"effectiveConfig": {
"maxClauseCount": "integer",
"fielddataCacheSize": "string",
"reindexRemoteWhitelist": "string"
},
"userConfig": {
"maxClauseCount": "integer",
"fielddataCacheSize": "string",
"reindexRemoteWhitelist": "string"
},
"defaultConfig": {
"maxClauseCount": "integer",
"fielddataCacheSize": "string",
"reindexRemoteWhitelist": "string"
}
}
},
"dashboards": {
"nodeGroups": [
{
"name": "string",
"resources": {
"resourcePresetId": "string",
"diskSize": "string",
"diskTypeId": "string"
},
"hostsCount": "string",
"zoneIds": [
"string"
],
"subnetIds": [
"string"
],
"assignPublicIp": true
}
]
},
"access": {
"dataTransfer": true,
"serverless": true
}
},
"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",
"latestMaintenanceTime": "string",
"nextMaintenanceWindowTime": "string"
}
}
Field | Description |
---|---|
id | string ID of the OpenSearch cluster. This ID is assigned by the platform at the moment of cluster creation. |
folderId | string ID of the folder that the OpenSearch cluster belongs to. |
createdAt | string (date-time) Time when the cluster was created. 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 OpenSearch cluster. The name is unique within the folder. 1-63 characters long. |
description | string Description of the OpenSearch cluster. 0-256 characters long. |
labels | object Custom labels for the OpenSearch cluster as |
environment | string Deployment environment of the OpenSearch cluster.
|
monitoring[] | object Description of monitoring systems relevant to the OpenSearch 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 OpenSearch cluster. |
config | object Configuration of the OpenSearch cluster. The OpenSearch cluster configuration. |
config. version |
string Version of the OpenSearch server software. |
config. opensearch |
object OpenSearch configuration. The OpenSearch host group type configuration. |
config. opensearch. plugins[] |
string Names of the cluster plugins. |
config. opensearch. nodeGroups[] |
object Host groups of the OpenSearch type. |
config. opensearch. nodeGroups[]. name |
string Name of the group. Must be 1-63 characters long. |
config. opensearch. nodeGroups[]. resources |
object Resources allocated to the hosts. A list of computational resources allocated to a host. |
config. opensearch. nodeGroups[]. resources. resourcePresetId |
string ID of the preset for computational resources allocated to a host. |
config. opensearch. nodeGroups[]. resources. diskSize |
string (int64) Volume of the storage used by the host, in bytes. |
config. opensearch. nodeGroups[]. resources. diskTypeId |
string Type of the storage used by the host: |
config. opensearch. nodeGroups[]. hostsCount |
string (int64) Number of hosts in the group. |
config. opensearch. nodeGroups[]. zoneIds[] |
string IDs of the availability zones the hosts belong to. |
config. opensearch. nodeGroups[]. subnetIds[] |
string IDs of the subnets that the hosts belong to. |
config. opensearch. nodeGroups[]. assignPublicIp |
boolean (boolean) Determines whether a public IP is assigned to the hosts in the group. |
config. opensearch. nodeGroups[]. roles[] |
string Roles of the host group. |
config. opensearch. opensearchConfigSet_2 |
object |
config. opensearch. opensearchConfigSet_2. effectiveConfig |
object Required. |
config. opensearch. opensearchConfigSet_2. effectiveConfig. maxClauseCount |
integer (int64) the maximum number of allowed boolean clauses in a query |
config. opensearch. opensearchConfigSet_2. effectiveConfig. fielddataCacheSize |
string the percentage or absolute value (10%, 512mb) of heap space that is allocated to fielddata |
config. opensearch. opensearchConfigSet_2. effectiveConfig. reindexRemoteWhitelist |
string |
config. opensearch. opensearchConfigSet_2. userConfig |
object |
config. opensearch. opensearchConfigSet_2. userConfig. maxClauseCount |
integer (int64) the maximum number of allowed boolean clauses in a query |
config. opensearch. opensearchConfigSet_2. userConfig. fielddataCacheSize |
string the percentage or absolute value (10%, 512mb) of heap space that is allocated to fielddata |
config. opensearch. opensearchConfigSet_2. userConfig. reindexRemoteWhitelist |
string |
config. opensearch. opensearchConfigSet_2. defaultConfig |
object |
config. opensearch. opensearchConfigSet_2. defaultConfig. maxClauseCount |
integer (int64) the maximum number of allowed boolean clauses in a query |
config. opensearch. opensearchConfigSet_2. defaultConfig. fielddataCacheSize |
string the percentage or absolute value (10%, 512mb) of heap space that is allocated to fielddata |
config. opensearch. opensearchConfigSet_2. defaultConfig. reindexRemoteWhitelist |
string |
config. dashboards |
object Dashboards configuration. The Dashboards host group type configuration. |
config. dashboards. nodeGroups[] |
object Host groups of the Dashboards type. |
config. dashboards. nodeGroups[]. name |
string Name of the group. 1-63 characters long. |
config. dashboards. nodeGroups[]. resources |
object Resources allocated to the hosts. A list of computational resources allocated to a host. |
config. dashboards. nodeGroups[]. resources. resourcePresetId |
string ID of the preset for computational resources allocated to a host. |
config. dashboards. nodeGroups[]. resources. diskSize |
string (int64) Volume of the storage used by the host, in bytes. |
config. dashboards. nodeGroups[]. resources. diskTypeId |
string Type of the storage used by the host: |
config. dashboards. nodeGroups[]. hostsCount |
string (int64) Number of hosts in the group. |
config. dashboards. nodeGroups[]. zoneIds[] |
string IDs of the availability zones the hosts belong to. |
config. dashboards. nodeGroups[]. subnetIds[] |
string IDs of the subnets that the hosts belong to. |
config. dashboards. nodeGroups[]. assignPublicIp |
boolean (boolean) Determines whether a public IP is assigned to the hosts in the group. |
config. access |
object Access policy for external services. Access policy for external services. |
config. access. dataTransfer |
boolean (boolean) Determines whether the access to Data Transfer is allowed. |
config. access. serverless |
boolean (boolean) Determines whether the access to Serverless is allowed. |
networkId | string ID of the cloud network that the cluster belongs to. |
health | string Aggregated cluster health.
|
status | string Current state of the cluster. Current state of the cluster.
|
securityGroupIds[] | string User security groups. |
serviceAccountId | string ID of the service account used to access Object Storage. |
deletionProtection | boolean (boolean) Determines whether the cluster is protected from being deleted. |
maintenanceWindow | object Cluster maintenance window. Should be defined by either one of the two options. An OpenSearch cluster maintenance window. Should be defined by either one of the two options. |
maintenanceWindow. anytime |
object maintenanceWindow includes only one of the fields anytime , weeklyMaintenanceWindow An any-time maintenance window. |
maintenanceWindow. weeklyMaintenanceWindow |
object maintenanceWindow includes only one of the fields anytime , weeklyMaintenanceWindow A weekly maintenance window. |
maintenanceWindow. weeklyMaintenanceWindow. day |
string Day of the week.
|
maintenanceWindow. weeklyMaintenanceWindow. hour |
string (int64) Hour of the day in the UTC timezone. Acceptable values are 1 to 24, inclusive. |
plannedOperation | object Maintenance operation planned at nearest maintenanceWindow. |
plannedOperation. info |
string The description of the operation. The maximum string length in characters is 256. |
plannedOperation. delayedUntil |
string (date-time) Delay time for the maintenance operation. 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). |
plannedOperation. latestMaintenanceTime |
string (date-time) Time of the last maintenance window. 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). |
plannedOperation. nextMaintenanceWindowTime |
string (date-time) Time of the next maintenance window. 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 |
---|---|
addDashboardsNodeGroup | Creates a Dashboards type host group. |
addOpenSearchNodeGroup | Creates an OpenSearch type host group. |
backup | Creates a backup for the specified OpenSearch cluster. |
create | Creates an OpenSearch cluster in the specified folder. |
delete | Deletes the specified OpenSearch cluster. |
deleteDashboardsNodeGroup | Deletes a Dashboards type host group. |
deleteOpenSearchNodeGroup | Deletes an OpenSearch type host group. |
get | Returns the specified OpenSearch cluster. |
getAuthSettings | Retrieves auth settings for specified cluster. |
list | Retrieves the list of OpenSearch clusters that belong to the specified folder. |
listBackups | Returns a list of available backups for the specified OpenSearch cluster. |
listHosts | Retrieves a list of hosts for the specified cluster. |
listLogs | Retrieves logs for the specified OpenSearch cluster. For detailed description, see the Logs section in the developer's guide. |
listOperations | Retrieves the list of Operation resources for the specified cluster. |
move | Moves the specified OpenSearch cluster to the specified folder. |
rescheduleMaintenance | Reschedules a planned maintenance operation. |
restore | Creates a new OpenSearch cluster using the specified backup. |
start | Starts the specified OpenSearch cluster. |
stop | Stops the specified OpenSearch cluster. |
streamLogs | Same as ListLogs but using server-side streaming. Also allows for 'tail -f' semantics. |
update | Updates the specified OpenSearch cluster. |
updateAuthSettings | Updates auth settings for specified cluster. |
updateDashboardsNodeGroup | Updates a Dashboards type host group. |
updateOpenSearchNodeGroup | Updates an OpenSearch type host group. |