[Документация Yandex Cloud](../../../../index.md) > [Yandex Managed Service for OpenSearch](../../../index.md) > Справочник API > [gRPC (англ.)](../index.md) > [Cluster](index.md) > Get # Managed Service for OpenSearch API, gRPC: ClusterService.Get Returns the specified OpenSearch cluster. To get the list of all available OpenSearch clusters, make a [List](list.md#List) request. ## gRPC request **rpc Get ([GetClusterRequest](#yandex.cloud.mdb.opensearch.v1.GetClusterRequest)) returns ([Cluster](#yandex.cloud.mdb.opensearch.v1.Cluster))** ## GetClusterRequest {#yandex.cloud.mdb.opensearch.v1.GetClusterRequest} ```json { "cluster_id": "string" } ``` #| ||Field | Description || || cluster_id | **string** Required field. ID of the OpenSearch cluster to return. To get the cluster ID, use a [ClusterService.List](list.md#List) request. The maximum string length in characters is 50. || |# ## Cluster {#yandex.cloud.mdb.opensearch.v1.Cluster} ```json { "id": "string", "folder_id": "string", "created_at": "google.protobuf.Timestamp", "name": "string", "description": "string", "labels": "map", "environment": "Environment", "monitoring": [ { "name": "string", "description": "string", "link": "string" } ], "config": { "version": "string", "opensearch": { "plugins": [ "string" ], "node_groups": [ { "name": "string", "resources": { "resource_preset_id": "string", "disk_size": "int64", "disk_type_id": "string" }, "hosts_count": "int64", "zone_ids": [ "string" ], "subnet_ids": [ "string" ], "assign_public_ip": "bool", "roles": [ "GroupRole" ], "disk_size_autoscaling": { "planned_usage_threshold": "int64", "emergency_usage_threshold": "int64", "disk_size_limit": "int64" } } ], // Includes only one of the fields `opensearch_config_set_2` "opensearch_config_set_2": { "effective_config": { "max_clause_count": "google.protobuf.Int64Value", "fielddata_cache_size": "string", "search_max_buckets": "google.protobuf.Int64Value", "reindex_remote_whitelist": "string", "http_max_initial_line_length": "google.protobuf.StringValue" }, "user_config": { "max_clause_count": "google.protobuf.Int64Value", "fielddata_cache_size": "string", "search_max_buckets": "google.protobuf.Int64Value", "reindex_remote_whitelist": "string", "http_max_initial_line_length": "google.protobuf.StringValue" }, "default_config": { "max_clause_count": "google.protobuf.Int64Value", "fielddata_cache_size": "string", "search_max_buckets": "google.protobuf.Int64Value", "reindex_remote_whitelist": "string", "http_max_initial_line_length": "google.protobuf.StringValue" } }, // end of the list of possible fields "keystore_settings": [ "string" ] }, "dashboards": { "node_groups": [ { "name": "string", "resources": { "resource_preset_id": "string", "disk_size": "int64", "disk_type_id": "string" }, "hosts_count": "int64", "zone_ids": [ "string" ], "subnet_ids": [ "string" ], "assign_public_ip": "bool", "disk_size_autoscaling": { "planned_usage_threshold": "int64", "emergency_usage_threshold": "int64", "disk_size_limit": "int64" } } ] }, "access": { "data_transfer": "bool", "serverless": "bool" }, "snapshot_management": { "snapshot_schedule": { // Includes only one of the fields `hourly_snapshot_schedule`, `daily_snapshot_schedule`, `weekly_snapshot_schedule` "hourly_snapshot_schedule": { "minute": "int64" }, "daily_snapshot_schedule": { "hour": "int64", "minute": "int64" }, "weekly_snapshot_schedule": { "day": "WeekDay", "hour": "int64", "minute": "int64" } // end of the list of possible fields }, "snapshot_max_age_days": "google.protobuf.Int64Value" }, "full_version": "string", "audit_log": { "compliance_enabled": "google.protobuf.BoolValue", "log_request_body": "google.protobuf.BoolValue", "log_search_queries": "google.protobuf.BoolValue", "log_data_modifications": "google.protobuf.BoolValue", "log_index_metadata_access": "google.protobuf.BoolValue", "log_monitoring_checks": "google.protobuf.BoolValue", "log_index_maintenance": "google.protobuf.BoolValue", "log_backup_operations": "google.protobuf.BoolValue" }, "cloud_storage": { "enabled": "google.protobuf.BoolValue" } }, "network_id": "string", "health": "Health", "status": "Status", "security_group_ids": [ "string" ], "service_account_id": "string", "deletion_protection": "bool", "maintenance_window": { // Includes only one of the fields `anytime`, `weekly_maintenance_window` "anytime": "AnytimeMaintenanceWindow", "weekly_maintenance_window": { "day": "WeekDay", "hour": "int64" } // end of the list of possible fields }, "planned_operation": { "info": "string", "delayed_until": "google.protobuf.Timestamp", "latest_maintenance_time": "google.protobuf.Timestamp", "next_maintenance_window_time": "google.protobuf.Timestamp" }, "disk_encryption_key_id": "google.protobuf.StringValue" } ``` An OpenSearch cluster resource. #| ||Field | Description || || id | **string** ID of the OpenSearch cluster. This ID is assigned by the platform at the moment of cluster creation. || || folder_id | **string** ID of the folder that the OpenSearch cluster belongs to. || || created_at | **[google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#timestamp)** Time when the cluster was created. || || 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** (map<**string**, **string**>) Custom labels for the OpenSearch cluster as `key:value` pairs. Maximum 64 labels per resource. || || environment | enum **Environment** Deployment environment of the OpenSearch cluster. - `PRODUCTION`: Stable environment with a conservative update policy: only hotfixes are applied during regular maintenance. - `PRESTABLE`: Environment with more aggressive update policy: new versions are rolled out irrespective of backward compatibility. || || monitoring[] | **[Monitoring](#yandex.cloud.mdb.opensearch.v1.Monitoring)** Description of monitoring systems relevant to the OpenSearch cluster. || || config | **[ClusterConfig](#yandex.cloud.mdb.opensearch.v1.ClusterConfig)** Configuration of the OpenSearch cluster. || || network_id | **string** ID of the cloud network that the cluster belongs to. || || health | enum **Health** Aggregated cluster health. - `HEALTH_UNKNOWN`: Health of the cluster is unknown ([Host.health](listHosts.md#yandex.cloud.mdb.opensearch.v1.Host) for every host in the cluster is UNKNOWN). - `ALIVE`: Cluster is working normally ([Host.health](listHosts.md#yandex.cloud.mdb.opensearch.v1.Host) for every host in the cluster is ALIVE). - `DEAD`: Cluster is inoperable ([Host.health](listHosts.md#yandex.cloud.mdb.opensearch.v1.Host) for every host in the cluster is DEAD). - `DEGRADED`: Cluster is working below capacity ([Host.health](listHosts.md#yandex.cloud.mdb.opensearch.v1.Host) for at least one host in the cluster is not ALIVE). || || status | enum **Status** Current state of the cluster. - `STATUS_UNKNOWN`: Cluster state is unknown. - `CREATING`: Cluster is being created. - `RUNNING`: Cluster is running normally. - `ERROR`: Cluster has encountered a problem and cannot operate. - `UPDATING`: Cluster is being updated. - `STOPPING`: Cluster is stopping. - `STOPPED`: Cluster has stopped. - `STARTING`: Cluster is starting. || || security_group_ids[] | **string** User security groups. || || service_account_id | **string** ID of the service account used to access Object Storage. || || deletion_protection | **bool** Determines whether the cluster is protected from being deleted. || || maintenance_window | **[MaintenanceWindow](#yandex.cloud.mdb.opensearch.v1.MaintenanceWindow)** Cluster maintenance window. Should be defined by either one of the two options. || || planned_operation | **[MaintenanceOperation](#yandex.cloud.mdb.opensearch.v1.MaintenanceOperation)** Maintenance operation planned at nearest `maintenance_window`. || || disk_encryption_key_id | **[google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/string-value)** ID of the key to encrypt cluster disks. || |# ## Monitoring {#yandex.cloud.mdb.opensearch.v1.Monitoring} Monitoring system metadata. #| ||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 OpenSearch cluster. || |# ## ClusterConfig {#yandex.cloud.mdb.opensearch.v1.ClusterConfig} The OpenSearch cluster configuration. #| ||Field | Description || || version | **string** Version of the OpenSearch server software. || || opensearch | **[OpenSearch](#yandex.cloud.mdb.opensearch.v1.OpenSearch)** OpenSearch configuration. || || dashboards | **[Dashboards](#yandex.cloud.mdb.opensearch.v1.Dashboards)** Dashboards configuration. || || access | **[Access](#yandex.cloud.mdb.opensearch.v1.Access)** Access policy for external services. || || snapshot_management | **[SnapshotManagement](#yandex.cloud.mdb.opensearch.v1.SnapshotManagement)** Snapshot management configuration. || || full_version | **string** Full version. || || audit_log | **[AuditLog](#yandex.cloud.mdb.opensearch.v1.config.AuditLog)** Audit log settings. || || cloud_storage | **[CloudStorage](#yandex.cloud.mdb.opensearch.v1.CloudStorage)** Cloud storage configuration. || |# ## OpenSearch {#yandex.cloud.mdb.opensearch.v1.OpenSearch} The OpenSearch host group type configuration. #| ||Field | Description || || plugins[] | **string** Names of the cluster plugins. || || node_groups[] | **[NodeGroup](#yandex.cloud.mdb.opensearch.v1.OpenSearch.NodeGroup)** Host groups of the OpenSearch type. || || opensearch_config_set_2 | **[OpenSearchConfigSet2](#yandex.cloud.mdb.opensearch.v1.config.OpenSearchConfigSet2)** OpenSearch server configuration settings. Includes only one of the fields `opensearch_config_set_2`. || || keystore_settings[] | **string** Keystore entries names. || |# ## NodeGroup {#yandex.cloud.mdb.opensearch.v1.OpenSearch.NodeGroup} Configuration of the host group. #| ||Field | Description || || name | **string** Name of the group. Must be 1-63 characters long. || || resources | **[Resources](#yandex.cloud.mdb.opensearch.v1.Resources)** Resources allocated to the hosts. || || hosts_count | **int64** Number of hosts in the group. || || zone_ids[] | **string** IDs of the availability zones the hosts belong to. || || subnet_ids[] | **string** IDs of the subnets that the hosts belong to. || || assign_public_ip | **bool** Determines whether a public IP is assigned to the hosts in the group. || || roles[] | enum **GroupRole** Roles of the host group. - `DATA`: Data nodes store indices data. - `MANAGER`: Manager nodes perform cluster coordination. - `WARM`: Warm nodes provide access to searchable snapshots and manage search cache for these snapshots. - `INGEST`: Ingest nodes provides indexed data processing. If no node groups have INGEST role explicitly set, then all DATA nodes will implicitly have INGEST role. || || disk_size_autoscaling | **[DiskSizeAutoscaling](#yandex.cloud.mdb.opensearch.v1.DiskSizeAutoscaling)** Disk size autoscaling settings. || |# ## Resources {#yandex.cloud.mdb.opensearch.v1.Resources} A list of computational resources allocated to a host. #| ||Field | Description || || resource_preset_id | **string** Required field. ID of the preset for computational resources allocated to a host. || || disk_size | **int64** Volume of the storage used by the host, in bytes. Value must be greater than 0. || || disk_type_id | **string** Required field. Type of the storage used by the host: `network-hdd`, `network-ssd` or `local-ssd`. || |# ## DiskSizeAutoscaling {#yandex.cloud.mdb.opensearch.v1.DiskSizeAutoscaling} Disk size autoscaling settings. #| ||Field | Description || || planned_usage_threshold | **int64** Amount of used storage for automatic disk scaling in the maintenance window, 0 means disabled, in percent. Acceptable values are 0 to 100, inclusive. || || emergency_usage_threshold | **int64** Amount of used storage for immediately automatic disk scaling, 0 means disabled, in percent. Acceptable values are 0 to 100, inclusive. || || disk_size_limit | **int64** Limit on how large the storage for database instances can automatically grow, in bytes. || |# ## OpenSearchConfigSet2 {#yandex.cloud.mdb.opensearch.v1.config.OpenSearchConfigSet2} #| ||Field | Description || || effective_config | **[OpenSearchConfig2](#yandex.cloud.mdb.opensearch.v1.config.OpenSearchConfig2)** Required field. Effective configuration (a combination of user-defined configuration and default configuration). || || user_config | **[OpenSearchConfig2](#yandex.cloud.mdb.opensearch.v1.config.OpenSearchConfig2)** User-defined configuration. || || default_config | **[OpenSearchConfig2](#yandex.cloud.mdb.opensearch.v1.config.OpenSearchConfig2)** Default configuration. || |# ## OpenSearchConfig2 {#yandex.cloud.mdb.opensearch.v1.config.OpenSearchConfig2} OpenSearch server configuration settings. #| ||Field | Description || || max_clause_count | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** Defines the maximum product of fields and terms that are queryable simultaneously. Default value: **1024**. Change of the setting is applied with restart. For details, see [OpenSearch documentation](https://docs.opensearch.org/latest/install-and-configure/configuring-opensearch/index-settings/#dynamic-cluster-level-index-settings). || || fielddata_cache_size | **string** The maximum size of the field data cache. May be specified as an absolute value (for example, 8GB) or a percentage of the node heap (for example, 50%). This setting is dynamic. If you don't specify this setting, the maximum size is 35%. This value should be smaller than the **indices.breaker.fielddata.limit** Change of the setting is applied with restart. For details, see [OpenSearch documentation](https://docs.opensearch.org/latest/install-and-configure/configuring-opensearch/index-settings/#dynamic-cluster-level-index-settings). || || search_max_buckets | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** The maximum number of aggregation buckets allowed in a single response. Default is 65535 Default value: **65535**. Change of the setting is applied with restart. For details, see [OpenSearch documentation](https://docs.opensearch.org/latest/install-and-configure/configuring-opensearch/search-settings). || || reindex_remote_whitelist | **string** Allowed remote hosts Change of the setting is applied with restart. For details, see [OpenSearch documentation](https://docs.opensearch.org/latest/api-reference/document-apis/reindex/#remote-cluster-allow-list). || || http_max_initial_line_length | **[google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/string-value)** Sets the maximum length allowed for HTTP URLs in the initial request line. URLs exceeding this limit will be rejected. Default is **4kb**. Default value: **4kb**. Change of the setting is applied with restart. For details, see [OpenSearch documentation](https://docs.opensearch.org/latest/install-and-configure/configuring-opensearch/network-settings/#advanced-http-settings). || |# ## Dashboards {#yandex.cloud.mdb.opensearch.v1.Dashboards} The Dashboards host group type configuration. #| ||Field | Description || || node_groups[] | **[NodeGroup](#yandex.cloud.mdb.opensearch.v1.Dashboards.NodeGroup)** Host groups of the Dashboards type. || |# ## NodeGroup {#yandex.cloud.mdb.opensearch.v1.Dashboards.NodeGroup} #| ||Field | Description || || name | **string** Name of the group. 1-63 characters long. || || resources | **[Resources](#yandex.cloud.mdb.opensearch.v1.Resources)** Resources allocated to the hosts. || || hosts_count | **int64** Number of hosts in the group. || || zone_ids[] | **string** IDs of the availability zones the hosts belong to. || || subnet_ids[] | **string** IDs of the subnets that the hosts belong to. || || assign_public_ip | **bool** Determines whether a public IP is assigned to the hosts in the group. || || disk_size_autoscaling | **[DiskSizeAutoscaling](#yandex.cloud.mdb.opensearch.v1.DiskSizeAutoscaling)** Disk size autoscaling settings || |# ## Access {#yandex.cloud.mdb.opensearch.v1.Access} Access policy for external services. #| ||Field | Description || || data_transfer | **bool** Determines whether the access to Data Transfer is allowed. || || serverless | **bool** Determines whether the access to Serverless is allowed. || |# ## SnapshotManagement {#yandex.cloud.mdb.opensearch.v1.SnapshotManagement} Snapshot management configuration #| ||Field | Description || || snapshot_schedule | **[SnapshotSchedule](#yandex.cloud.mdb.opensearch.v1.SnapshotSchedule)** Snapshot creation schedule || || snapshot_max_age_days | **[google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/int64-value)** Snapshot max age in days The minimum value is 7. || |# ## SnapshotSchedule {#yandex.cloud.mdb.opensearch.v1.SnapshotSchedule} Snapshot creation schedule #| ||Field | Description || || hourly_snapshot_schedule | **[HourlySnapshotSchedule](#yandex.cloud.mdb.opensearch.v1.HourlySnapshotSchedule)** Hourly based snapshot schedule Includes only one of the fields `hourly_snapshot_schedule`, `daily_snapshot_schedule`, `weekly_snapshot_schedule`. || || daily_snapshot_schedule | **[DailySnapshotSchedule](#yandex.cloud.mdb.opensearch.v1.DailySnapshotSchedule)** Daily based snapshot schedule Includes only one of the fields `hourly_snapshot_schedule`, `daily_snapshot_schedule`, `weekly_snapshot_schedule`. || || weekly_snapshot_schedule | **[WeeklySnapshotSchedule](#yandex.cloud.mdb.opensearch.v1.WeeklySnapshotSchedule)** Weekly based snapshot schedule Includes only one of the fields `hourly_snapshot_schedule`, `daily_snapshot_schedule`, `weekly_snapshot_schedule`. || |# ## HourlySnapshotSchedule {#yandex.cloud.mdb.opensearch.v1.HourlySnapshotSchedule} Hourly based snapshot schedule #| ||Field | Description || || minute | **int64** The minute of the hour at which the backup should be created. Acceptable values are 0 to 59, inclusive. || |# ## DailySnapshotSchedule {#yandex.cloud.mdb.opensearch.v1.DailySnapshotSchedule} Daily based snapshot schedule #| ||Field | Description || || hour | **int64** The hour of the day in UTC timezone at which the backup should be created. Acceptable values are 0 to 23, inclusive. || || minute | **int64** The minute of the hour at which the backup should be created. Acceptable values are 0 to 59, inclusive. || |# ## WeeklySnapshotSchedule {#yandex.cloud.mdb.opensearch.v1.WeeklySnapshotSchedule} Weekly based snapshot schedule #| ||Field | Description || || day | enum **WeekDay** Day of the week - `MON` - `TUE` - `WED` - `THU` - `FRI` - `SAT` - `SUN` || || hour | **int64** The hour of the day in UTC timezone at which the backup should be created. Acceptable values are 0 to 23, inclusive. || || minute | **int64** The minute of the hour at which the backup should be created. Acceptable values are 0 to 59, inclusive. || |# ## AuditLog {#yandex.cloud.mdb.opensearch.v1.config.AuditLog} OpenSearch audit logs settings. #| ||Field | Description || || compliance_enabled | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** Enables audit logging on changes to a security index, such as changes to roles mappings and role creation or deletion. For details, see [OpenSearch documentation](https://docs.opensearch.org/latest/security/audit-logs/index/#audit-user-account-manipulation). || || log_request_body | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** Includes the body of the request (if available) for both REST and the transport layer. For details, see [OpenSearch documentation](https://docs.opensearch.org/latest/security/audit-logs/index/#disable-request-body-logging). || || log_search_queries | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** Enables indices data read requests logging. || || log_data_modifications | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** Enables indices data write request logging. || || log_index_metadata_access | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** Enables indices metadata requests logging. || || log_monitoring_checks | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** Enables monitoring data requests logging. || || log_index_maintenance | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** Enables indices maintenance requests logging, such as indices refreshes, flushes and merges. || || log_backup_operations | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** Enables snapshots and repositories requests logging. || |# ## CloudStorage {#yandex.cloud.mdb.opensearch.v1.CloudStorage} Cloud storage configuration. #| ||Field | Description || || enabled | **[google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/bool-value)** Whether to use Object Storage for storing OpenSearch data. || |# ## MaintenanceWindow {#yandex.cloud.mdb.opensearch.v1.MaintenanceWindow} An OpenSearch cluster maintenance window. Should be defined by either one of the two options. #| ||Field | Description || || anytime | **[AnytimeMaintenanceWindow](#yandex.cloud.mdb.opensearch.v1.AnytimeMaintenanceWindow)** An any-time maintenance window. Includes only one of the fields `anytime`, `weekly_maintenance_window`. || || weekly_maintenance_window | **[WeeklyMaintenanceWindow](#yandex.cloud.mdb.opensearch.v1.WeeklyMaintenanceWindow)** A weekly maintenance window. Includes only one of the fields `anytime`, `weekly_maintenance_window`. || |# ## AnytimeMaintenanceWindow {#yandex.cloud.mdb.opensearch.v1.AnytimeMaintenanceWindow} An any-time maintenance window. #| ||Field | Description || || Empty | > || |# ## WeeklyMaintenanceWindow {#yandex.cloud.mdb.opensearch.v1.WeeklyMaintenanceWindow} A weekly maintenance window. #| ||Field | Description || || day | enum **WeekDay** Day of the week. - `MON`: Monday - `TUE`: Tuesday - `WED`: Wednesday - `THU`: Thursday - `FRI`: Friday - `SAT`: Saturday - `SUN`: Sunday || || hour | **int64** Hour of the day in the UTC timezone. Acceptable values are 1 to 24, inclusive. || |# ## MaintenanceOperation {#yandex.cloud.mdb.opensearch.v1.MaintenanceOperation} #| ||Field | Description || || info | **string** The description of the operation. The maximum string length in characters is 256. || || delayed_until | **[google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#timestamp)** Delay time for the maintenance operation. || || latest_maintenance_time | **[google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#timestamp)** Time of the last maintenance window. || || next_maintenance_window_time | **[google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#timestamp)** Time of the next maintenance window. || |#