Contact UsGet started

Managed Service for OpenSearch API, REST: Cluster.List

Written by
Updated at October 17, 2024

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

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 request.

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 that can be used to get the next page of results in subsequent list requests.

pageToken

string

Page token. To get the next page of results, set pageToken to the ListClustersResponse.nextPageToken
returned by the previous list request.

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 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_-]+.

Response

HTTP Code: 200 - OK

{
  "clusters": [
    {
      "id": "string",
      "folderId": "string",
      "createdAt": "string",
      "name": "string",
      "description": "string",
      "labels": "string",
      "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",
              "reindexRemoteWhitelist": "string"
            },
            "userConfig": {
              "maxClauseCount": "string",
              "fielddataCacheSize": "string",
              "reindexRemoteWhitelist": "string"
            },
            "defaultConfig": {
              "maxClauseCount": "string",
              "fielddataCacheSize": "string",
              "reindexRemoteWhitelist": "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"
        }
      },
      "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"
      }
    }
  ],
  "nextPageToken": "string"
}

Field

Description

clusters[]

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, use the nextPageToken as the value
for the ListClustersRequest.pageToken parameter in the next list request.

Each subsequent list request has its own nextPageToken to continue paging through the results.

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 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.
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

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.

  • ENVIRONMENT_UNSPECIFIED
  • 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

Description of monitoring systems relevant to the OpenSearch cluster.

config

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 for every host in the cluster is UNKNOWN).
  • ALIVE: Cluster is working normally (Host.health for every host in the cluster is ALIVE).
  • DEAD: Cluster is inoperable (Host.health for every host in the cluster is DEAD).
  • DEGRADED: Cluster is working below capacity (Host.health 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

Cluster maintenance window. Should be defined by either one of the two options.

plannedOperation

MaintenanceOperation

Maintenance operation planned at nearest maintenanceWindow.

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

The OpenSearch cluster configuration.

Field

Description

version

string

Version of the OpenSearch server software.

opensearch

OpenSearch

OpenSearch configuration.

dashboards

Dashboards

Dashboards configuration.

access

Access

Access policy for external services.

OpenSearch

The OpenSearch host group type configuration.

Field

Description

plugins[]

string

Names of the cluster plugins.

nodeGroups[]

NodeGroup

Host groups of the OpenSearch type.

opensearchConfigSet_2

OpenSearchConfigSet2

Includes only one of the fields opensearchConfigSet_2.

keystoreSettings[]

string

Keystore entries names.

NodeGroup

Configuration of the host group.

Field

Description

name

string

Name of the group. Must be 1-63 characters long.

resources

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.

  • GROUP_ROLE_UNSPECIFIED
  • DATA
  • MANAGER

diskSizeAutoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

Resources

A list of computational resources allocated to a host.

Field

Description

resourcePresetId

string

ID of the preset for computational resources allocated to a host.

diskSize

string (int64)

Volume of the storage used by the host, in bytes.

diskTypeId

string

Type of the storage used by the host: network-hdd, network-ssd or local-ssd.

DiskSizeAutoscaling

Field

Description

plannedUsageThreshold

string (int64)

Amount of used storage for automatic disk scaling in the maintenance window, 0 means disabled, in percent.

emergencyUsageThreshold

string (int64)

Amount of used storage for immediately automatic disk scaling, 0 means disabled, in percent.

diskSizeLimit

string (int64)

Limit on how large the storage for database instances can automatically grow, in bytes.

OpenSearchConfigSet2

Field

Description

effectiveConfig

OpenSearchConfig2

Required field.

userConfig

OpenSearchConfig2

defaultConfig

OpenSearchConfig2

OpenSearchConfig2

Field

Description

maxClauseCount

string (int64)

the maximum number of allowed boolean clauses in a query

fielddataCacheSize

string

the percentage or absolute value (10%, 512mb) of heap space that is allocated to fielddata

reindexRemoteWhitelist

string

Dashboards

The Dashboards host group type configuration.

Field

Description

nodeGroups[]

NodeGroup

Host groups of the Dashboards type.

NodeGroup

Field

Description

name

string

Name of the group. 1-63 characters long.

resources

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

Disk size autoscaling settings

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.

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

A weekly maintenance window.

Includes only one of the fields anytime, weeklyMaintenanceWindow.

WeeklyMaintenanceWindow

A weekly maintenance window.

Field

Description

day

enum (WeekDay)

Day of the week.

  • WEEK_DAY_UNSPECIFIED
  • 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.

MaintenanceOperation

Field

Description

info

string

The description of the operation.

delayedUntil

string (date-time)

Delay time for the maintenance operation.

String in RFC3339 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.
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 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.
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 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.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
Previous
Get
Next
Create