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
Parameter | Description |
---|---|
folderId | Required. ID of the folder to list OpenSearch clusters in. To get the folder ID, use a list request. The maximum string length in characters is 50. |
pageSize | The maximum number of results per page to return. If the number of available results is larger than pageSize, the service returns a nextPageToken that can be used to get the next page of results in subsequent list requests. The maximum value is 1000. |
pageToken | Page token. To get the next page of results, set pageToken to the nextPageToken returned by the previous list request. The maximum string length in characters is 100. |
filter | A filter expression that filters resources listed in the response. The expression must specify:
The maximum string length in characters is 1000. |
Response
HTTP Code: 200 - OK
{
"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": true,
"roles": [
"string"
],
"diskSizeAutoscaling": {
"plannedUsageThreshold": "string",
"emergencyUsageThreshold": "string",
"diskSizeLimit": "string"
}
}
],
"keystoreSettings": [
"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,
"diskSizeAutoscaling": {
"plannedUsageThreshold": "string",
"emergencyUsageThreshold": "string",
"diskSizeLimit": "string"
}
}
]
},
"access": {
"dataTransfer": true,
"serverless": true
}
},
"networkId": "string",
"health": "string",
"status": "string",
"securityGroupIds": [
"string"
],
"serviceAccountId": "string",
"deletionProtection": true,
"maintenanceWindow": {
// `clusters[].maintenanceWindow` includes only one of the fields `anytime`, `weeklyMaintenanceWindow`
"anytime": {},
"weeklyMaintenanceWindow": {
"day": "string",
"hour": "string"
},
// end of the list of possible fields`clusters[].maintenanceWindow`
},
"plannedOperation": {
"info": "string",
"delayedUntil": "string",
"latestMaintenanceTime": "string",
"nextMaintenanceWindowTime": "string"
}
}
],
"nextPageToken": "string"
}
Field | Description |
---|---|
clusters[] | object List of OpenSearch clusters. |
clusters[]. id |
string ID of the OpenSearch cluster. This ID is assigned by the platform at the moment of cluster creation. |
clusters[]. folderId |
string ID of the folder that the OpenSearch cluster belongs to. |
clusters[]. 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). |
clusters[]. name |
string Name of the OpenSearch cluster. The name is unique within the folder. 1-63 characters long. |
clusters[]. description |
string Description of the OpenSearch cluster. 0-256 characters long. |
clusters[]. labels |
object Custom labels for the OpenSearch cluster as |
clusters[]. environment |
string Deployment environment of the OpenSearch cluster.
|
clusters[]. monitoring[] |
object Description of monitoring systems relevant to the OpenSearch cluster. |
clusters[]. monitoring[]. name |
string Name of the monitoring system. |
clusters[]. monitoring[]. description |
string Description of the monitoring system. |
clusters[]. monitoring[]. link |
string Link to the monitoring system charts for the OpenSearch cluster. |
clusters[]. config |
object Configuration of the OpenSearch cluster. The OpenSearch cluster configuration. |
clusters[]. config. version |
string Version of the OpenSearch server software. |
clusters[]. config. opensearch |
object OpenSearch configuration. The OpenSearch host group type configuration. |
clusters[]. config. opensearch. plugins[] |
string Names of the cluster plugins. |
clusters[]. config. opensearch. nodeGroups[] |
object Host groups of the OpenSearch type. |
clusters[]. config. opensearch. nodeGroups[]. name |
string Name of the group. Must be 1-63 characters long. |
clusters[]. config. opensearch. nodeGroups[]. resources |
object Resources allocated to the hosts. A list of computational resources allocated to a host. |
clusters[]. config. opensearch. nodeGroups[]. resources. resourcePresetId |
string ID of the preset for computational resources allocated to a host. |
clusters[]. config. opensearch. nodeGroups[]. resources. diskSize |
string (int64) Volume of the storage used by the host, in bytes. |
clusters[]. config. opensearch. nodeGroups[]. resources. diskTypeId |
string Type of the storage used by the host: |
clusters[]. config. opensearch. nodeGroups[]. hostsCount |
string (int64) Number of hosts in the group. |
clusters[]. config. opensearch. nodeGroups[]. zoneIds[] |
string IDs of the availability zones the hosts belong to. |
clusters[]. config. opensearch. nodeGroups[]. subnetIds[] |
string IDs of the subnets that the hosts belong to. |
clusters[]. config. opensearch. nodeGroups[]. assignPublicIp |
boolean (boolean) Determines whether a public IP is assigned to the hosts in the group. |
clusters[]. config. opensearch. nodeGroups[]. roles[] |
string Roles of the host group. |
clusters[]. config. opensearch. nodeGroups[]. diskSizeAutoscaling |
object Disk size autoscaling settings |
clusters[]. config. opensearch. nodeGroups[]. diskSizeAutoscaling. 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. |
clusters[]. config. opensearch. nodeGroups[]. diskSizeAutoscaling. emergencyUsageThreshold |
string (int64) Amount of used storage for immediately automatic disk scaling, 0 means disabled, in percent. Acceptable values are 0 to 100, inclusive. |
clusters[]. config. opensearch. nodeGroups[]. diskSizeAutoscaling. diskSizeLimit |
string (int64) Limit on how large the storage for database instances can automatically grow, in bytes. |
clusters[]. config. opensearch. keystoreSettings[] |
string Keystore entries names. |
clusters[]. config. opensearch. opensearchConfigSet_2 |
object |
clusters[]. config. opensearch. opensearchConfigSet_2. effectiveConfig |
object Required. |
clusters[]. config. opensearch. opensearchConfigSet_2. effectiveConfig. maxClauseCount |
integer (int64) the maximum number of allowed boolean clauses in a query |
clusters[]. config. opensearch. opensearchConfigSet_2. effectiveConfig. fielddataCacheSize |
string the percentage or absolute value (10%, 512mb) of heap space that is allocated to fielddata |
clusters[]. config. opensearch. opensearchConfigSet_2. effectiveConfig. reindexRemoteWhitelist |
string |
clusters[]. config. opensearch. opensearchConfigSet_2. userConfig |
object |
clusters[]. config. opensearch. opensearchConfigSet_2. userConfig. maxClauseCount |
integer (int64) the maximum number of allowed boolean clauses in a query |
clusters[]. config. opensearch. opensearchConfigSet_2. userConfig. fielddataCacheSize |
string the percentage or absolute value (10%, 512mb) of heap space that is allocated to fielddata |
clusters[]. config. opensearch. opensearchConfigSet_2. userConfig. reindexRemoteWhitelist |
string |
clusters[]. config. opensearch. opensearchConfigSet_2. defaultConfig |
object |
clusters[]. config. opensearch. opensearchConfigSet_2. defaultConfig. maxClauseCount |
integer (int64) the maximum number of allowed boolean clauses in a query |
clusters[]. config. opensearch. opensearchConfigSet_2. defaultConfig. fielddataCacheSize |
string the percentage or absolute value (10%, 512mb) of heap space that is allocated to fielddata |
clusters[]. config. opensearch. opensearchConfigSet_2. defaultConfig. reindexRemoteWhitelist |
string |
clusters[]. config. dashboards |
object Dashboards configuration. The Dashboards host group type configuration. |
clusters[]. config. dashboards. nodeGroups[] |
object Host groups of the Dashboards type. |
clusters[]. config. dashboards. nodeGroups[]. name |
string Name of the group. 1-63 characters long. |
clusters[]. config. dashboards. nodeGroups[]. resources |
object Resources allocated to the hosts. A list of computational resources allocated to a host. |
clusters[]. config. dashboards. nodeGroups[]. resources. resourcePresetId |
string ID of the preset for computational resources allocated to a host. |
clusters[]. config. dashboards. nodeGroups[]. resources. diskSize |
string (int64) Volume of the storage used by the host, in bytes. |
clusters[]. config. dashboards. nodeGroups[]. resources. diskTypeId |
string Type of the storage used by the host: |
clusters[]. config. dashboards. nodeGroups[]. hostsCount |
string (int64) Number of hosts in the group. |
clusters[]. config. dashboards. nodeGroups[]. zoneIds[] |
string IDs of the availability zones the hosts belong to. |
clusters[]. config. dashboards. nodeGroups[]. subnetIds[] |
string IDs of the subnets that the hosts belong to. |
clusters[]. config. dashboards. nodeGroups[]. assignPublicIp |
boolean (boolean) Determines whether a public IP is assigned to the hosts in the group. |
clusters[]. config. dashboards. nodeGroups[]. diskSizeAutoscaling |
object Disk size autoscaling settings |
clusters[]. config. dashboards. nodeGroups[]. diskSizeAutoscaling. 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. |
clusters[]. config. dashboards. nodeGroups[]. diskSizeAutoscaling. emergencyUsageThreshold |
string (int64) Amount of used storage for immediately automatic disk scaling, 0 means disabled, in percent. Acceptable values are 0 to 100, inclusive. |
clusters[]. config. dashboards. nodeGroups[]. diskSizeAutoscaling. diskSizeLimit |
string (int64) Limit on how large the storage for database instances can automatically grow, in bytes. |
clusters[]. config. access |
object Access policy for external services. Access policy for external services. |
clusters[]. config. access. dataTransfer |
boolean (boolean) Determines whether the access to Data Transfer is allowed. |
clusters[]. config. access. serverless |
boolean (boolean) Determines whether the access to Serverless is allowed. |
clusters[]. networkId |
string ID of the cloud network that the cluster belongs to. |
clusters[]. health |
string Aggregated cluster health.
|
clusters[]. status |
string Current state of the cluster. Current state of the cluster.
|
clusters[]. securityGroupIds[] |
string User security groups. |
clusters[]. serviceAccountId |
string ID of the service account used to access Object Storage. |
clusters[]. deletionProtection |
boolean (boolean) Determines whether the cluster is protected from being deleted. |
clusters[]. 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. |
clusters[]. maintenanceWindow. anytime |
object An any-time maintenance window. clusters[].maintenanceWindow includes only one of the fields anytime , weeklyMaintenanceWindow |
clusters[]. maintenanceWindow. weeklyMaintenanceWindow |
object A weekly maintenance window. clusters[].maintenanceWindow includes only one of the fields anytime , weeklyMaintenanceWindow |
clusters[]. maintenanceWindow. weeklyMaintenanceWindow. day |
string Day of the week.
|
clusters[]. maintenanceWindow. weeklyMaintenanceWindow. hour |
string (int64) Hour of the day in the UTC timezone. Acceptable values are 1 to 24, inclusive. |
clusters[]. plannedOperation |
object Maintenance operation planned at nearest maintenanceWindow. |
clusters[]. plannedOperation. info |
string The description of the operation. The maximum string length in characters is 256. |
clusters[]. 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). |
clusters[]. 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). |
clusters[]. 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). |
nextPageToken | string This token allows you to get the next page of results for list requests. If the number of results is larger than pageSize, use the nextPageToken as the value for the pageToken parameter in the next list request. Each subsequent list request has its own nextPageToken to continue paging through the results. |