Managed Service for OpenSearch API, gRPC: ClusterService.List
Retrieves the list of OpenSearch clusters that belong to the specified folder.
gRPC request
rpc List (ListClustersRequest) returns (ListClustersResponse)
ListClustersRequest
{
"folderId": "string",
"pageSize": "int64",
"pageToken": "string",
"filter": "string"
}
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 |
int64 The maximum number of results per page to return. If the number of available results is larger than |
pageToken |
string Page token. To get the next page of results, set |
filter |
string A filter expression that filters resources listed in the response. The expression must specify:
|
ListClustersResponse
{
"clusters": [
{
"id": "string",
"folderId": "string",
"createdAt": "google.protobuf.Timestamp",
"name": "string",
"description": "string",
"labels": "string",
"environment": "Environment",
"monitoring": [
{
"name": "string",
"description": "string",
"link": "string"
}
],
"config": {
"version": "string",
"opensearch": {
"plugins": [
"string"
],
"nodeGroups": [
{
"name": "string",
"resources": {
"resourcePresetId": "string",
"diskSize": "int64",
"diskTypeId": "string"
},
"hostsCount": "int64",
"zoneIds": [
"string"
],
"subnetIds": [
"string"
],
"assignPublicIp": "bool",
"roles": [
"GroupRole"
],
"diskSizeAutoscaling": {
"plannedUsageThreshold": "int64",
"emergencyUsageThreshold": "int64",
"diskSizeLimit": "int64"
}
}
],
// Includes only one of the fields `opensearchConfigSet_2`
"opensearchConfigSet_2": {
"effectiveConfig": {
"maxClauseCount": "google.protobuf.Int64Value",
"fielddataCacheSize": "string",
"reindexRemoteWhitelist": "string"
},
"userConfig": {
"maxClauseCount": "google.protobuf.Int64Value",
"fielddataCacheSize": "string",
"reindexRemoteWhitelist": "string"
},
"defaultConfig": {
"maxClauseCount": "google.protobuf.Int64Value",
"fielddataCacheSize": "string",
"reindexRemoteWhitelist": "string"
}
},
// end of the list of possible fields
"keystoreSettings": [
"string"
]
},
"dashboards": {
"nodeGroups": [
{
"name": "string",
"resources": {
"resourcePresetId": "string",
"diskSize": "int64",
"diskTypeId": "string"
},
"hostsCount": "int64",
"zoneIds": [
"string"
],
"subnetIds": [
"string"
],
"assignPublicIp": "bool",
"diskSizeAutoscaling": {
"plannedUsageThreshold": "int64",
"emergencyUsageThreshold": "int64",
"diskSizeLimit": "int64"
}
}
]
},
"access": {
"dataTransfer": "bool",
"serverless": "bool"
}
},
"networkId": "string",
"health": "Health",
"status": "Status",
"securityGroupIds": [
"string"
],
"serviceAccountId": "string",
"deletionProtection": "bool",
"maintenanceWindow": {
// Includes only one of the fields `anytime`, `weeklyMaintenanceWindow`
"anytime": "AnytimeMaintenanceWindow",
"weeklyMaintenanceWindow": {
"day": "WeekDay",
"hour": "int64"
}
// end of the list of possible fields
},
"plannedOperation": {
"info": "string",
"delayedUntil": "google.protobuf.Timestamp",
"latestMaintenanceTime": "google.protobuf.Timestamp",
"nextMaintenanceWindowTime": "google.protobuf.Timestamp"
}
}
],
"nextPageToken": "string"
}
Field |
Description |
clusters[] |
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 Each subsequent list request has its own |
Cluster
An OpenSearch cluster resource.
Field |
Description |
id |
string ID of the OpenSearch cluster. |
folderId |
string ID of the folder that the OpenSearch cluster belongs to. |
createdAt |
Time when the cluster was created. |
name |
string Name of the OpenSearch cluster. |
description |
string Description of the OpenSearch cluster. 0-256 characters long. |
labels |
string Custom labels for the OpenSearch cluster as |
environment |
enum Environment Deployment environment of the OpenSearch cluster.
|
monitoring[] |
Description of monitoring systems relevant to the OpenSearch cluster. |
config |
Configuration of the OpenSearch cluster. |
networkId |
string ID of the cloud network that the cluster belongs to. |
health |
enum Health Aggregated cluster health.
|
status |
enum Status Current state of the cluster.
|
securityGroupIds[] |
string User security groups. |
serviceAccountId |
string ID of the service account used to access Object Storage. |
deletionProtection |
bool Determines whether the cluster is protected from being deleted. |
maintenanceWindow |
Cluster maintenance window. Should be defined by either one of the two options. |
plannedOperation |
Maintenance operation planned at nearest |
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 configuration. |
dashboards |
Dashboards configuration. |
access |
Access policy for external services. |
OpenSearch
The OpenSearch host group type configuration.
Field |
Description |
plugins[] |
string Names of the cluster plugins. |
nodeGroups[] |
Host groups of the OpenSearch type. |
opensearchConfigSet_2 |
Includes only one of the fields |
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 allocated to the hosts. |
hostsCount |
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 |
bool Determines whether a public IP is assigned to the hosts in the group. |
roles[] |
enum GroupRole Roles of the host group.
|
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 |
int64 Volume of the storage used by the host, in bytes. |
diskTypeId |
string Type of the storage used by the host: |
DiskSizeAutoscaling
Field |
Description |
plannedUsageThreshold |
int64 Amount of used storage for automatic disk scaling in the maintenance window, 0 means disabled, in percent. |
emergencyUsageThreshold |
int64 Amount of used storage for immediately automatic disk scaling, 0 means disabled, in percent. |
diskSizeLimit |
int64 Limit on how large the storage for database instances can automatically grow, in bytes. |
OpenSearchConfigSet2
Field |
Description |
effectiveConfig |
Required field. |
userConfig |
|
defaultConfig |
OpenSearchConfig2
Field |
Description |
maxClauseCount |
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[] |
Host groups of the Dashboards type. |
NodeGroup
Field |
Description |
name |
string Name of the group. 1-63 characters long. |
resources |
Resources allocated to the hosts. |
hostsCount |
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 |
bool Determines whether a public IP is assigned to the hosts in the group. |
diskSizeAutoscaling |
Disk size autoscaling settings |
Access
Access policy for external services.
Field |
Description |
dataTransfer |
bool Determines whether the access to Data Transfer is allowed. |
serverless |
bool 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 |
An any-time maintenance window. Includes only one of the fields |
weeklyMaintenanceWindow |
A weekly maintenance window. Includes only one of the fields |
AnytimeMaintenanceWindow
An any-time maintenance window.
Field |
Description |
Empty |
WeeklyMaintenanceWindow
A weekly maintenance window.
Field |
Description |
day |
enum WeekDay Day of the week.
|
hour |
int64 Hour of the day in the UTC timezone. |
MaintenanceOperation
Field |
Description |
info |
string The description of the operation. |
delayedUntil |
Delay time for the maintenance operation. |
latestMaintenanceTime |
Time of the last maintenance window. |
nextMaintenanceWindowTime |
Time of the next maintenance window. |