Managed Service for OpenSearch API, gRPC: ClusterService.List

Статья создана

Yandex Cloud

Обновлена 17 декабря 2024 г.

gRPC request
ListClustersRequest
ListClustersResponse
Cluster
Monitoring
ClusterConfig
OpenSearch
NodeGroup
Resources
DiskSizeAutoscaling
OpenSearchConfigSet2
OpenSearchConfig2
Dashboards
NodeGroup
Access
MaintenanceWindow
AnytimeMaintenanceWindow
WeeklyMaintenanceWindow
MaintenanceOperation

Retrieves the list of OpenSearch clusters that belong to the specified folder.

gRPC request

rpc List (ListClustersRequest) returns (ListClustersResponse)

ListClustersRequest

{
  "folder_id": "string",
  "page_size": "int64",
  "page_token": "string",
  "filter": "string"
}

Field	Description
folder_id	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.
page_size	int64 The maximum number of results per page to return. If the number of available results is larger than `page_size`, the service returns a ListClustersResponse.next_page_token that can be used to get the next page of results in subsequent list requests.
page_token	string Page token. To get the next page of results, set `page_token` to the ListClustersResponse.next_page_token returned by the previous list request.
filter	string A filter expression that filters resources listed in the response. The expression must specify: The field name. Currently you can only use filtering with the Cluster.name field. An `=` operator. The value in double quotes (`"`). Must be 1-63 characters long and match the regular expression `[a-zA-Z0-9_-]+`.

ListClustersResponse

{
  "clusters": [
    {
      "id": "string",
      "folder_id": "string",
      "created_at": "google.protobuf.Timestamp",
      "name": "string",
      "description": "string",
      "labels": "map<string, string>",
      "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",
              "reindex_remote_whitelist": "string"
            },
            "user_config": {
              "max_clause_count": "google.protobuf.Int64Value",
              "fielddata_cache_size": "string",
              "reindex_remote_whitelist": "string"
            },
            "default_config": {
              "max_clause_count": "google.protobuf.Int64Value",
              "fielddata_cache_size": "string",
              "reindex_remote_whitelist": "string"
            }
          },
          // 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"
        }
      },
      "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"
      }
    }
  ],
  "next_page_token": "string"
}

Field

Description

clusters[]

Cluster

List of OpenSearch clusters.

next_page_token

string

This token allows you to get the next page of results for list requests.

If the number of results is larger than ListClustersRequest.page_size, use the next_page_token as the value
for the ListClustersRequest.page_token parameter in the next list request.

Each subsequent list request has its own next_page_token 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.
folder_id	string ID of the folder that the OpenSearch cluster belongs to.
created_at	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. `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.
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 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.
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 Cluster maintenance window. Should be defined by either one of the two options.
planned_operation	MaintenanceOperation Maintenance operation planned at nearest `maintenance_window`.

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.
node_groups[]	NodeGroup Host groups of the OpenSearch type.
opensearch_config_set_2	OpenSearchConfigSet2 Includes only one of the fields `opensearch_config_set_2`.
keystore_settings[]	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.
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. `GROUP_ROLE_UNSPECIFIED` `DATA` `MANAGER`
disk_size_autoscaling	DiskSizeAutoscaling Disk size autoscaling settings

Resources

A list of computational resources allocated to a host.

Field	Description
resource_preset_id	string ID of the preset for computational resources allocated to a host.
disk_size	int64 Volume of the storage used by the host, in bytes.
disk_type_id	string Type of the storage used by the host: `network-hdd`, `network-ssd` or `local-ssd`.

DiskSizeAutoscaling

Field	Description
planned_usage_threshold	int64 Amount of used storage for automatic disk scaling in the maintenance window, 0 means disabled, in percent.
emergency_usage_threshold	int64 Amount of used storage for immediately automatic disk scaling, 0 means disabled, in percent.
disk_size_limit	int64 Limit on how large the storage for database instances can automatically grow, in bytes.

OpenSearchConfigSet2

Field	Description
effective_config	OpenSearchConfig2 Required field.
user_config	OpenSearchConfig2
default_config	OpenSearchConfig2

OpenSearchConfig2

Field	Description
max_clause_count	google.protobuf.Int64Value the maximum number of allowed boolean clauses in a query
fielddata_cache_size	string the percentage or absolute value (10%, 512mb) of heap space that is allocated to fielddata
reindex_remote_whitelist	string

Dashboards

The Dashboards host group type configuration.

Field

Description

node_groups[]

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.
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 Disk size autoscaling settings

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.

MaintenanceWindow

An OpenSearch cluster maintenance window. Should be defined by either one of the two options.

Field

Description

anytime

AnytimeMaintenanceWindow

An any-time maintenance window.

Includes only one of the fields anytime, weekly_maintenance_window.

weekly_maintenance_window

WeeklyMaintenanceWindow

A weekly maintenance window.

Includes only one of the fields anytime, weekly_maintenance_window.

AnytimeMaintenanceWindow

An any-time maintenance window.

Field	Description
Empty

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

int64

Hour of the day in the UTC timezone.

MaintenanceOperation

Field	Description
info	string The description of the operation.
delayed_until	google.protobuf.Timestamp Delay time for the maintenance operation.
latest_maintenance_time	google.protobuf.Timestamp Time of the last maintenance window.
next_maintenance_window_time	google.protobuf.Timestamp Time of the next maintenance window.

Managed Service for OpenSearch API, gRPC: ClusterService.List

gRPC requestgRPC request

ListClustersRequestListClustersRequest

ListClustersResponseListClustersResponse

ClusterCluster

MonitoringMonitoring

ClusterConfigClusterConfig

OpenSearchOpenSearch

NodeGroupNodeGroup

ResourcesResources

DiskSizeAutoscalingDiskSizeAutoscaling

OpenSearchConfigSet2OpenSearchConfigSet2

OpenSearchConfig2OpenSearchConfig2

DashboardsDashboards

NodeGroupNodeGroup

AccessAccess

MaintenanceWindowMaintenanceWindow

AnytimeMaintenanceWindowAnytimeMaintenanceWindow

WeeklyMaintenanceWindowWeeklyMaintenanceWindow

MaintenanceOperationMaintenanceOperation

Была ли статья полезна?

gRPC request

ListClustersRequest

ListClustersResponse

Cluster

Monitoring

ClusterConfig

OpenSearch

NodeGroup

Resources

DiskSizeAutoscaling

OpenSearchConfigSet2

OpenSearchConfig2

Dashboards

NodeGroup

Access

MaintenanceWindow

AnytimeMaintenanceWindow

WeeklyMaintenanceWindow

MaintenanceOperation