OpenSearch:Instance details

Instance list page

The Instance Management page displays all instances that you have purchased. You can perform the following operations in the Actions column of the list:

• Manage: takes you to the instance details page by default.

• Query test: lets you run simple search tests on an instance that is currently serving online traffic.

• Scale in or scale out: lets you adjust the resources used by the instance.

Basic information

In OpenSearch Retrieval Engine Edition ---> Instance Management page, find the instance and click Manage in the Actions column on the right to go to the instance details page:

Network information

VPC, vSwitch ID, and Internet access: the virtual private cloud (VPC) and vSwitch in the same region, and the Internet access settings, that you selected on the buy page for accessing the instance.

Add an Internet access whitelist: Internet access is disabled by default.

You can manually enable it. After it is enabled, the whitelist configuration entry is displayed.

Click [Internet Access Whitelist] to add, delete, or edit whitelist entries. If you exit the page in editing mode without saving, a secondary confirmation is required, and your edits are not saved after you exit.

Add a whitelist: Manually enter IP addresses. Separate multiple IP addresses with commas. In the whitelist editing panel, you can enter either a single IP address or an IP range, for example 192.168.0.1 or 192.168.0.0/24, and separate multiple entries with commas. Click Save to apply the whitelist, or Close to exit the panel.

Verify that the whitelist is added: Log on to a machine that has been added to the whitelist and ping the API domain name shown in the API endpoint section. The following example adds the IP address of the local machine: Add the local IP address 30.197.xxx.xxx. The whitelist input accepts either a single IP address or an IP range in CIDR notation, for example 192.168.0.1 or 192.168.0.0/24, with multiple entries separated by commas. Click Edit above the whitelist text box to modify the entries.

Obtain the domain name from the API endpoint section by clicking API domain name to copy it.

You must add public to the domain name to access it, for example, ha-cn-5yd35gift03.public.ha.aliyuncs.com.

Ping the API domain name from the local machine. If the ping succeeds, the whitelist is added successfully.

Example command: ping ha-cn-5yd35gift03.public.ha.aliyuncs.com. A successful result shows the domain name resolving to a public IP address and four replies received with 0% packet loss.

API endpoint

Also known as the endpoint (available to ECS instances in the same region, including in VPC environments). The API domain name differs by region. When you access OpenSearch by using the API or an SDK, use the API endpoint provided here. Select an appropriate domain name based on your actual deployment, and ping it before use to make sure that it is accessible.

Username and password: the username and password that you entered on the buy page for accessing the instance. Click the Configured button to modify the username and password of the current instance.

The Modify Password panel requires the username, the new password, and a confirmation of the password that must match, then confirm to apply. A notice states that the username and password set when you create the cluster are used to access the cluster and should be stored securely.

Limits on modifying the password:

• Username: 0 to 30 characters in length. It can contain uppercase and lowercase letters, underscores, and digits, and must start with a letter.

• Password: 6 to 8 characters in length, consisting of lowercase letters and digits.

Note: This can be used only in "Network Information - VPC". If you need a public API domain name, contact us.

• Document search demo;

• Data push demo;

Cluster information

Cluster information displays the status of the query nodes and data nodes of each cluster. Click a cluster name to display the status of that cluster.

The status information of query nodes includes:

Service status: In service or Service updating.

Configuration status: Configuration completed or Configuration updating.

The status information of data nodes includes:

Service status: In service or Service updating.

Configuration status: Configuration completed or Configuration updating.

Data status: the data status of each index table, including the following fields: index table, data status, index version, full switchover time, and incremental update time.

Cluster data status: If any index table has a data exception, the status is Data exception (specific exception details are displayed). If any index table is updating data, the status is Data updating, and the progress is the average progress of all index tables. If all index tables are normal, the status is Normal.

The index table details are as follows:

Index table terms:

• Index table: the name of an index table in the cluster.

• Data status: Normal, Data updating (progress is displayed), or Data exception (specific exception details are displayed).

• Index table size: the storage space occupied by the index table.

• Index version: the index version currently used by the index table.

• Full switchover time: the time of the last full switchover of the index table.

• Incremental update time: the time of the last incremental update of the index table.

O&M management: OpenSearch Retrieval Engine Edition allows you to perform O&M on your clusters by yourself. Features include one-click configuration push for operations that require pushing configurations, such as deploying new clusters, updating online resources, and modifying offline index configurations, as well as manual index rebuilding and rollback to historical versions.

Deployment management: On the deployment management page, you can view the cluster topology of your current instance and make changes to online configurations.