Viewing OpenSearch Cluster Information

On the CSS management console, you can check an OpenSearch cluster's status, version, nodes, configurations and settings, and resource allocation on the cluster list and the cluster information page.

Introduction to the Cluster List

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. WARNING: If a cluster is unavailable, you can delete it or use a snapshot created when it was available to restore its data to another cluster. However, you cannot scale out this cluster, access it through OpenSearch Dashboards, 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 1.3.6(1.3.6_x.x.x_x.x.x), 1.3.6 is the cluster version and 1.3.6_x.x.x_x.x.x enclosed in parentheses is the image version. CAUTION: For a cluster created a long time ago, its image version may not be available because it is likely not 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 OpenSearch Cluster.
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.
VPC Endpoint Address	IP address or private domain name of the VPC endpoint associated with the cluster.
Security Mode	Whether the security mode is enabled for the cluster. Only authorized users can access a security-mode cluster.
Enterprise Project	Enterprise project that a cluster belongs to.
Cluster Description	Provides supplementary information about the cluster.
Created	Cluster creation time.
Billing Mode	Billing mode of a cluster. It can be Pay-per-use or Yearly/Monthly.
Operation	Operations that can be performed on a cluster, such as checking metrics, restart, and deletion. If an operation is unavailable, the menu button is grayed out.

Viewing Basic Cluster Information

Log in to the CSS management console.
In the navigation pane on the left, choose Clusters > OpenSearch.
In the cluster list, click the name of the target cluster. The cluster information page is displayed.

On the Overview tab, check the cluster's basic information, configuration, and node information.

**Table 2** Cluster 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 changed.
	ID	Unique ID of a cluster, which is automatically generated by the system. Each cluster in the same region has a unique ID.
	Cluster Description	Provides supplementary information about the cluster. You can click on the right to modify the description.
	Version	Cluster version. For example, if the version is 1.3.6(1.3.6_x.x.x_x.x.x), 1.3.6 is the cluster version and 1.3.6_x.x.x_x.x.x enclosed in parentheses is the image version. CAUTION: For a cluster created a long time ago, its image version may not be available because it is likely not 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 OpenSearch Cluster.
	Cluster Status	Current status of a cluster
	Task Status	Current task status of a cluster. If there is no ongoing task, -- 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
Configuration	Region	Region where a cluster is located
	AZ	AZ where a cluster is located
	VPC	VPC to which a cluster belongs
	Current Subnet	Subnet to which a cluster belongs. If the current subnet cannot meet your service requirements, click Switch Subnet. In the displayed dialog box, select another subnet. If no existing subnets meet your requirements, click Create Subnet to create a new subnet. CAUTION: After switching the subnet, the new subnet is used for adding nodes, including scaling, adding dedicated master/client nodes, and enabling VPC Endpoint. IP addresses will be allocated to newly added nodes from the new subnet. A cluster can be associated with a maximum of two subnets. Subnet switching does not affect the network settings of existing nodes.
	Used Subnet	Subnet once used by the cluster.
	Security Group	Security group to which a cluster belongs. To modify the security group of a cluster, click Change Security Group on the right. WARNING: The selected security group must allow port 9200 in the inbound direction. Otherwise, the cluster may be inaccessible to external services. Furthermore, to enable OpenSearch Dashboards private network access, port 5601 must also be allowed.
	Security Mode	Security mode of a cluster. Enabled: The security mode is enabled for the current cluster. Disabled: The security mode is disabled for the current cluster. For details about how to change the security mode of a cluster, see Changing the Security Mode of an OpenSearch Cluster.
	Reset Password	This parameter is available only for security-mode clusters. Click Reset to change the admin password for a security-mode cluster. Requirements for admin 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, as the password. Change the password periodically.
	Cluster Routing	Cluster route information. You can view, add, or modify routes for a cluster. For details, see Configuring Routes for an OpenSearch Cluster.
	Enterprise Project	Enterprise project that a cluster belongs to. You can click a project name to check the basic project information.
	Public IP Address	Public IP address that enables public network access. It is displayed only for security-mode clusters. For a security-mode cluster with public network access enabled, the configured public IP address is displayed. For a security-mode cluster with public network access disabled, -- is displayed. When public network access is enabled for a cluster, you are advised to use a whitelist for access control. For details about how to configure public network access, see Configuring Public Network Access for an OpenSearch Cluster.
	Public Network Access Control	You can configure public network access control for a security-mode cluster by IP addresses or IP address ranges. This parameter is displayed only for clusters with public network access enabled. Click Modify to modify the access control whitelist. If a whitelist is configured, only IP addresses that are on this whitelist can access the cluster over the public network. Click +Add. In the displayed text box, enter IP addresses or CIDR blocks that are allowed to access the cluster from the public network. Separate them using commas (,). Each value must be unique. An example of valid values: 192.168.1.1,10.0.0.0/24. Examples of invalid values: 0.0.0.0, xx.xx.xx.x0, 172.16.0.0-172.16.255.255, non-standard formats (e.g., 192.168.1), and duplicate values. If no whitelist is configured, all public IP addresses can access the cluster. However, this can be a security risk and should be avoided.
	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 HTTPS for a cluster. If HTTPS is disabled, the cluster uses HTTP instead. For a cluster with the security mode disabled, HTTPS access is disabled by default. If it is enabled, HTTPS is used for cluster access. Only security-mode clusters support HTTPS. If HTTPS Access is enabled, you can click Download Certificate to obtain the certificate used for access control. Currently, the security certificate cannot be used in a public network environment. For details about how to switch the network protocol for a security-mode cluster, see Switching between HTTP and HTTPS in Security Mode.
	Private IPv4 Address	Private IPv4 address and port number of a cluster. If the cluster has only one node, the IP address and port number of the only 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.
	Private IPv6 Address	Private IPv6 address and port number of the cluster. They are displayed only when the VPC selected for the cluster supports IPv6 addresses and that an IPv6 address has been assigned automatically.
Node Information	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