Viewing OpenSearch Cluster Information

On the Elasticsearch/OpenSearch cluster list and cluster information page, you can check the cluster status, version, and node information.

Introduction to Cluster Lists

A cluster list displays all clusters of the same type under the current account. If there are a large number of clusters, the cluster list will consist of multiple pages, showing clusters of all states.

Clusters are listed in chronological order by default in the cluster list, with the most recent clusters displayed at the top.

You can click Export to download the full cluster list.

Table 1 Cluster list parameters

Parameter

Description

Name/ID

Name and ID of a cluster. You can click a cluster name to switch to the Cluster Information page. The cluster ID is automatically generated by the system and uniquely identifies a cluster.

Cluster Status

Current status of a cluster.

  • Available: The cluster is running properly.
  • Creating: The cluster is being created.
  • Processing: The cluster is being restarted, scaled out, backed up, or restored.
  • Abnormal: The cluster failed to be created or is unavailable.
NOTE:

If a cluster is unavailable, you can delete the cluster or use a snapshot created when the cluster was available to restore its data to another cluster. However, you cannot scale out this cluster, access it through Kibana, create snapshots for it, or use an existing snapshot to restore its data to itself. Do not try to import data into a cluster that is unavailable, as the data may get lost. For such a cluster, you can check its monitoring data or restart it to try to fix the problem. If the fault persists, contact technical support.

Task Status

Status of a task, such as cluster restart, scale-out, or scale-in.

Version

Cluster version and image version.

For example, if the version is 7.10.2(7.10.2_x.x.x_x.x.x), 7.10.2 is the cluster version and 7.10.2_x.x.x_x.x.x enclosed in parentheses is the image version.

NOTE:
  • For a cluster created a long time ago, its image version may not be available because it may not be recorded in the database.
  • If EOS is displayed below the version number, the current version has reached EOS and hence poses certain service availability risks. You are advised to upgrade the cluster version as soon as possible. For details, see Upgrading the Version of an Elasticsearch Cluster.

Created

Cluster creation time.

Enterprise Project

Enterprise project that a cluster belongs to.

Private Network Address

Private network address and port number of a cluster. You can use it to access the cluster. If the cluster has multiple nodes, the private network addresses and port numbers of all nodes are displayed.

Billing Mode

Billing mode of a cluster.

Operation

Operations that can be performed on a cluster, including checking metrics, restart, and deletion. If an operation is unavailable, the menu button is grayed out.

Viewing Basic Cluster Information

On the Cluster Information page, you can view the information about a cluster, including the private network address, public IP address, version, and node.

  1. Log in to the CSS management console.
  2. In the navigation pane on the left, select a cluster type under Clusters.
  3. In the cluster list, click a cluster name to go to the Cluster Information page and view basic information about the cluster.
    Table 2 Parameters for configuring basic information

    Type

    Parameter

    Description

    Cluster Information

    Name

    Cluster name. The name can be customized.

    You can click on the right to change the cluster name.

    Initial Name

    Name of the cluster when it was created for the first time, which is unique and cannot be modified.

    ID

    Unique ID of a cluster, which is automatically generated by the system.

    Each cluster in the same region has a unique ID.

    Version

    Cluster version information.

    For example, if the version is 7.10.2(7.10.2_x.x.x_x.x.x), 7.10.2 is the cluster version and 7.10.2_x.x.x_x.x.x enclosed in parentheses is the image version.

    NOTE:
    • For a cluster created a long time ago, its image version may not be available because it may not be recorded in the database.
    • If EOS is displayed below the version number, the current version has reached EOS and hence poses certain service availability risks. You are advised to upgrade the cluster version as soon as possible. For details, see Upgrading the Version of an Elasticsearch Cluster.

    Cluster Status

    Current status of a cluster

    Task Status

    Current task status of a cluster. If no task is in progress, -- is displayed.

    Created

    Time when a cluster was created

    Cluster Storage Capacity (GB)

    Storage capacity of a cluster

    Used Cluster Storage (GB)

    Used storage capacity of a cluster

    Disk Encryption

    Whether to encrypt the data disks of cluster nodes using Key Management Service (KMS). If disk encryption is enabled, Key Name and Key Status are also displayed.

    NOTE:

    Do not delete the KMS key used for disk encryption. If the key is disabled, the cluster cannot be scaled or upgraded, its node specifications or AZs cannot be changed, and its nodes cannot be replaced (by specifying the nodes that need replacement). To solve this problem, you will have to create a new cluster and migrate your data to that new cluster.

    Configuration

    Region

    Region where a cluster is located

    AZ

    AZ where a cluster is located

    VPC

    VPC to which the cluster belongs

    Subnet

    Subnet to which the cluster belongs

    Security Group

    Security group to which a cluster belongs.

    To change the security group of a cluster, click Change Security Group on the right.

    NOTICE:

    Before changing the security group, ensure that the port 9200 required for service access has been enabled. Incorrect security group configuration may cause service access failures. Exercise caution when performing this operation.

    Security Mode

    Security mode of a cluster.

    • Enabled: The current cluster is a security cluster.
    • Disabled: The current cluster is a non-security cluster.

    For details about how to change the security mode of a cluster, see Changing the Security Mode of an Elasticsearch Cluster.

    Reset Password

    This parameter is displayed only for security clusters.

    Click Reset to change the password of the administrator account admin of the security cluster.

    NOTE:

    Requirements for administrator passwords:

    • The password can contain 8 to 32 characters.
    • The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. The following special characters are allowed: ~!@#$%^&*()-_=+\|[{}];:,<.>/?
    • Do not use the administrator name, or the administrator name spelled backwards.
    • You are advised to change the password periodically.

    Enterprise Project

    Enterprise project to which a cluster belongs.

    You can click the project name to view the basic information about the enterprise project.

    Public IP Address

    Public network access information, which is displayed only for clusters in security mode.

    • For a security cluster with public network access enabled, the configured public network address is displayed. You can use this address to access the security cluster from the public network.
    • For a security cluster with public network access disabled, -- is displayed.

    When using a public IP address to access a cluster, you are advised to enable access control and configure an access whitelist to improve cluster security. For details about how to configure the public network access, see Configuring Public Network Access for an Elasticsearch Cluster.

    Access Control

    Whether to set access control for a cluster. This parameter is displayed only for clusters with public network access enabled.

    • Enabled: Only IP addresses in the whitelist can access the cluster through the public network.
    • Disabled: Any IP address can access the cluster through the public network.

    Click Set to configure the access control and the whitelist.

    Bandwidth

    The bandwidth for public network access. This parameter is displayed only for clusters with public network access enabled.

    Click Edit to change the bandwidth size.

    HTTPS Access

    Whether to enable the HTTPS access protocol for a cluster.

    • If HTTPS access is disabled, the cluster uses the HTTP protocol.
    • If it is enabled, the HTTPS protocol is used for cluster access. Only security-mode clusters can enable this function. If HTTPS Access is enabled, you can click Download Certificate to obtain the CER security certificate for accessing the security cluster. Currently, the security certificate cannot be used in the public network environment.

    For details about how to change the access mode of a cluster in security mode, see Switching the Protocol of Security Clusters.

    Private IPv4 Address

    Private IP address and port number of a cluster, which can be used to access the cluster. If the cluster has only one node, the IP address and port number of only one node are displayed, for example, 10.62.179.32:9200. If the cluster has multiple nodes, the IP addresses and port numbers of all nodes are displayed, for example, 10.62.179.32:9200,10.62.179.33:9200.

    Node

    Node Specifications

    Specifications of nodes in a cluster

    Node Storage Type

    Storage capacity and storage type of nodes in a cluster

    Nodes

    Number of nodes in a cluster
Parent topic: Managing OpenSearch Clusters