[Yandex Cloud documentation](../../../index.md) > [Yandex Managed Service for OpenSearch](../../index.md) > API reference > [REST](../index.md) > [Cluster](index.md) > List # Managed Service for OpenSearch API, REST: Cluster.List Retrieves the list of OpenSearch clusters that belong to the specified folder. ## HTTP request ``` GET https://mdb.api.cloud.yandex.net/managed-opensearch/v1/clusters ``` ## Query parameters {#yandex.cloud.mdb.opensearch.v1.ListClustersRequest} #| ||Field | Description || || folderId | **string** Required field. ID of the folder to list OpenSearch clusters in. To get the folder ID, use a [yandex.cloud.resourcemanager.v1.FolderService.List](../../../resource-manager/api-ref/Folder/list.md#List) request. The maximum string length in characters is 50. || || pageSize | **string** (int64) The maximum number of results per page to return. If the number of available results is larger than `pageSize`, the service returns a [ListClustersResponse.nextPageToken](#yandex.cloud.mdb.opensearch.v1.ListClustersResponse) that can be used to get the next page of results in subsequent list requests. The maximum value is 1000. || || pageToken | **string** Page token. To get the next page of results, set `pageToken` to the [ListClustersResponse.nextPageToken](#yandex.cloud.mdb.opensearch.v1.ListClustersResponse) 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: 1. The field name. Currently you can only use filtering with the [Cluster.name](#yandex.cloud.mdb.opensearch.v1.Cluster) field. 2. An `=` operator. 3. The value in double quotes (`"`). Must be 1-63 characters long and match the regular expression `[a-zA-Z0-9_-]+`. The maximum string length in characters is 1000. || |# ## Response {#yandex.cloud.mdb.opensearch.v1.ListClustersResponse} **HTTP Code: 200 - OK** ```json { "clusters": [ { "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": "boolean", "roles": [ "string" ], "diskSizeAutoscaling": { "plannedUsageThreshold": "string", "emergencyUsageThreshold": "string", "diskSizeLimit": "string" } } ], // Includes only one of the fields `opensearchConfigSet_2` "opensearchConfigSet_2": { "effectiveConfig": { "maxClauseCount": "string", "fielddataCacheSize": "string", "searchMaxBuckets": "string", "reindexRemoteWhitelist": "string", "httpMaxInitialLineLength": "string" }, "userConfig": { "maxClauseCount": "string", "fielddataCacheSize": "string", "searchMaxBuckets": "string", "reindexRemoteWhitelist": "string", "httpMaxInitialLineLength": "string" }, "defaultConfig": { "maxClauseCount": "string", "fielddataCacheSize": "string", "searchMaxBuckets": "string", "reindexRemoteWhitelist": "string", "httpMaxInitialLineLength": "string" } }, // end of the list of possible fields "keystoreSettings": [ "string" ] }, "dashboards": { "nodeGroups": [ { "name": "string", "resources": { "resourcePresetId": "string", "diskSize": "string", "diskTypeId": "string" }, "hostsCount": "string", "zoneIds": [ "string" ], "subnetIds": [ "string" ], "assignPublicIp": "boolean", "diskSizeAutoscaling": { "plannedUsageThreshold": "string", "emergencyUsageThreshold": "string", "diskSizeLimit": "string" } } ] }, "access": { "dataTransfer": "boolean", "serverless": "boolean" }, "snapshotManagement": { "snapshotSchedule": { // Includes only one of the fields `hourlySnapshotSchedule`, `dailySnapshotSchedule`, `weeklySnapshotSchedule` "hourlySnapshotSchedule": { "minute": "string" }, "dailySnapshotSchedule": { "hour": "string", "minute": "string" }, "weeklySnapshotSchedule": { "day": "string", "hour": "string", "minute": "string" } // end of the list of possible fields }, "snapshotMaxAgeDays": "string" }, "fullVersion": "string", "auditLog": { "complianceEnabled": "boolean", "logRequestBody": "boolean", "logSearchQueries": "boolean", "logDataModifications": "boolean", "logIndexMetadataAccess": "boolean", "logMonitoringChecks": "boolean", "logIndexMaintenance": "boolean", "logBackupOperations": "boolean" }, "cloudStorage": { "enabled": "boolean" } }, "networkId": "string", "health": "string", "status": "string", "securityGroupIds": [ "string" ], "serviceAccountId": "string", "deletionProtection": "boolean", "maintenanceWindow": { // Includes only one of the fields `anytime`, `weeklyMaintenanceWindow` "anytime": "object", "weeklyMaintenanceWindow": { "day": "string", "hour": "string" } // end of the list of possible fields }, "plannedOperation": { "info": "string", "delayedUntil": "string", "latestMaintenanceTime": "string", "nextMaintenanceWindowTime": "string" }, "diskEncryptionKeyId": "string" } ], "nextPageToken": "string" } ``` #| ||Field | Description || || clusters[] | **[Cluster](#yandex.cloud.mdb.opensearch.v1.Cluster)** List of OpenSearch clusters. || || nextPageToken | **string** This token allows you to get the next page of results for list requests. If the number of results is larger than [ListClustersRequest.pageSize](#yandex.cloud.mdb.opensearch.v1.ListClustersRequest), use the `nextPageToken` as the value for the [ListClustersRequest.pageToken](#yandex.cloud.mdb.opensearch.v1.ListClustersRequest) parameter in the next list request. Each subsequent list request has its own `nextPageToken` to continue paging through the results. || |# ## Cluster {#yandex.cloud.mdb.opensearch.v1.Cluster} 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. || || 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](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the [Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). 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** (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. || || networkId | **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. || || securityGroupIds[] | **string** User security groups. || || serviceAccountId | **string** ID of the service account used to access Object Storage. || || deletionProtection | **boolean** Determines whether the cluster is protected from being deleted. || || maintenanceWindow | **[MaintenanceWindow](#yandex.cloud.mdb.opensearch.v1.MaintenanceWindow)** Cluster maintenance window. Should be defined by either one of the two options. || || plannedOperation | **[MaintenanceOperation](#yandex.cloud.mdb.opensearch.v1.MaintenanceOperation)** Maintenance operation planned at nearest `maintenanceWindow`. || || diskEncryptionKeyId | **string** 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. || || snapshotManagement | **[SnapshotManagement](#yandex.cloud.mdb.opensearch.v1.SnapshotManagement)** Snapshot management configuration. || || fullVersion | **string** Full version. || || auditLog | **[AuditLog](#yandex.cloud.mdb.opensearch.v1.config.AuditLog)** Audit log settings. || || cloudStorage | **[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. || || nodeGroups[] | **[NodeGroup](#yandex.cloud.mdb.opensearch.v1.OpenSearch.NodeGroup)** Host groups of the OpenSearch type. || || opensearchConfigSet_2 | **[OpenSearchConfigSet2](#yandex.cloud.mdb.opensearch.v1.config.OpenSearchConfigSet2)** OpenSearch server configuration settings. Includes only one of the fields `opensearchConfigSet_2`. || || keystoreSettings[] | **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. || || hostsCount | **string** (int64) Number of hosts in the group. || || zoneIds[] | **string** IDs of the availability zones the hosts belong to. || || subnetIds[] | **string** IDs of the subnets that the hosts belong to. || || assignPublicIp | **boolean** 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. || || diskSizeAutoscaling | **[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 || || resourcePresetId | **string** Required field. ID of the preset for computational resources allocated to a host. || || diskSize | **string** (int64) Volume of the storage used by the host, in bytes. Value must be greater than 0. || || diskTypeId | **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 || || plannedUsageThreshold | **string** (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. || || emergencyUsageThreshold | **string** (int64) Amount of used storage for immediately automatic disk scaling, 0 means disabled, in percent. Acceptable values are 0 to 100, inclusive. || || diskSizeLimit | **string** (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 || || effectiveConfig | **[OpenSearchConfig2](#yandex.cloud.mdb.opensearch.v1.config.OpenSearchConfig2)** Required field. Effective configuration (a combination of user-defined configuration and default configuration). || || userConfig | **[OpenSearchConfig2](#yandex.cloud.mdb.opensearch.v1.config.OpenSearchConfig2)** User-defined configuration. || || defaultConfig | **[OpenSearchConfig2](#yandex.cloud.mdb.opensearch.v1.config.OpenSearchConfig2)** Default configuration. || |# ## OpenSearchConfig2 {#yandex.cloud.mdb.opensearch.v1.config.OpenSearchConfig2} OpenSearch server configuration settings. #| ||Field | Description || || maxClauseCount | **string** (int64) 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). || || fielddataCacheSize | **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). || || searchMaxBuckets | **string** (int64) 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). || || reindexRemoteWhitelist | **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). || || httpMaxInitialLineLength | **string** 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 || || nodeGroups[] | **[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. || || hostsCount | **string** (int64) Number of hosts in the group. || || zoneIds[] | **string** IDs of the availability zones the hosts belong to. || || subnetIds[] | **string** IDs of the subnets that the hosts belong to. || || assignPublicIp | **boolean** Determines whether a public IP is assigned to the hosts in the group. || || diskSizeAutoscaling | **[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 || || dataTransfer | **boolean** Determines whether the access to Data Transfer is allowed. || || serverless | **boolean** Determines whether the access to Serverless is allowed. || |# ## SnapshotManagement {#yandex.cloud.mdb.opensearch.v1.SnapshotManagement} Snapshot management configuration #| ||Field | Description || || snapshotSchedule | **[SnapshotSchedule](#yandex.cloud.mdb.opensearch.v1.SnapshotSchedule)** Snapshot creation schedule || || snapshotMaxAgeDays | **string** (int64) Snapshot max age in days The minimum value is 7. || |# ## SnapshotSchedule {#yandex.cloud.mdb.opensearch.v1.SnapshotSchedule} Snapshot creation schedule #| ||Field | Description || || hourlySnapshotSchedule | **[HourlySnapshotSchedule](#yandex.cloud.mdb.opensearch.v1.HourlySnapshotSchedule)** Hourly based snapshot schedule Includes only one of the fields `hourlySnapshotSchedule`, `dailySnapshotSchedule`, `weeklySnapshotSchedule`. || || dailySnapshotSchedule | **[DailySnapshotSchedule](#yandex.cloud.mdb.opensearch.v1.DailySnapshotSchedule)** Daily based snapshot schedule Includes only one of the fields `hourlySnapshotSchedule`, `dailySnapshotSchedule`, `weeklySnapshotSchedule`. || || weeklySnapshotSchedule | **[WeeklySnapshotSchedule](#yandex.cloud.mdb.opensearch.v1.WeeklySnapshotSchedule)** Weekly based snapshot schedule Includes only one of the fields `hourlySnapshotSchedule`, `dailySnapshotSchedule`, `weeklySnapshotSchedule`. || |# ## HourlySnapshotSchedule {#yandex.cloud.mdb.opensearch.v1.HourlySnapshotSchedule} Hourly based snapshot schedule #| ||Field | Description || || minute | **string** (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 | **string** (int64) The hour of the day in UTC timezone at which the backup should be created. Acceptable values are 0 to 23, inclusive. || || minute | **string** (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 | **string** (int64) The hour of the day in UTC timezone at which the backup should be created. Acceptable values are 0 to 23, inclusive. || || minute | **string** (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 || || complianceEnabled | **boolean** 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). || || logRequestBody | **boolean** 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). || || logSearchQueries | **boolean** Enables indices data read requests logging. || || logDataModifications | **boolean** Enables indices data write request logging. || || logIndexMetadataAccess | **boolean** Enables indices metadata requests logging. || || logMonitoringChecks | **boolean** Enables monitoring data requests logging. || || logIndexMaintenance | **boolean** Enables indices maintenance requests logging, such as indices refreshes, flushes and merges. || || logBackupOperations | **boolean** Enables snapshots and repositories requests logging. || |# ## CloudStorage {#yandex.cloud.mdb.opensearch.v1.CloudStorage} Cloud storage configuration. #| ||Field | Description || || enabled | **boolean** 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 | **object** An any-time maintenance window. Includes only one of the fields `anytime`, `weeklyMaintenanceWindow`. || || weeklyMaintenanceWindow | **[WeeklyMaintenanceWindow](#yandex.cloud.mdb.opensearch.v1.WeeklyMaintenanceWindow)** A weekly maintenance window. Includes only one of the fields `anytime`, `weeklyMaintenanceWindow`. || |# ## 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 | **string** (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. || || delayedUntil | **string** (date-time) Delay time for the maintenance operation. String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the [Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || || latestMaintenanceTime | **string** (date-time) Time of the last maintenance window. String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the [Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || || nextMaintenanceWindowTime | **string** (date-time) Time of the next maintenance window. String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the [Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || |#