Open Search instance-OpenSearch(Open Search)-阿里云帮助中心

List page overview

At the top of the page, you can use the Create instance button and search for an instance by instance ID. The list includes columns such as Instance name/ID, Instance status, Number of query nodes, Query node specifications, Number of data nodes, Data node specifications, and Billing method.

The instance management page displays all instances that you have purchased. You can perform the following actions in the Actions column of the list:

Manage: Redirects you to the instance details page.
Search Test: Perform a simple search test on an online instance that is currently serving traffic.
Scale: Adjust the resources used by the instance.

Basic information

Go to Recall Engine Edition > Instance management. Find your instance and click Manage in the Actions column to open its details page.

The instance details page has three tabs: Basic information, Network information, and API endpoints. In addition to the fields in the following table, the Basic information tab also displays information such as Storage space per data node, Resource group ID, and Resource group name.

Parameter	Description
Instance name/instance ID	The name of an instance. By default, the instance name is the same as its instance ID. You can use the same name for multiple instances under your account. The instance ID is automatically generated when the instance is created.
Instance status	The current status of the instance, such as `Normal` or `Frozen` (due to overdue payments for a pay-as-you-go instance).
Creation time	The time when the instance was created.
Billing method	pay-as-you-go
Number of query nodes	The number of query nodes that you purchased.
Query node specifications	The specifications of the query nodes that you purchased.
Number of data nodes	The number of data nodes that you purchased.
Data node specifications	The specifications of the data nodes that you purchased.
Region	The region where the instance is located.
Instance description	A custom description for the instance.

Network information

VPC, VSwitch ID, and public access: These fields display the VPC, VSwitch, and public access settings you selected for the instance during purchase.

Public access whitelist: Public access is disabled by default.

When you enable public access, the whitelist configuration option appears.

Click Public access whitelist to add, delete, or edit entries. If you try to leave the page with unsaved changes, a confirmation prompt appears. Your changes are lost if you exit.

Add to whitelist: Enter IP addresses, separated by commas. You can enter individual IP addresses (for example, 192.168.0.1) or IP address ranges in CIDR notation (for example, 192.168.0.0/24). After entering the addresses, click Save.

Verify the whitelist: To confirm that the whitelist is configured correctly, log on to a machine whose IP address is on the whitelist. Then, ping the API domain name listed on the API endpoints tab. For example, add your local IP address30.197.xxx.xxx.

On the API endpoints tab, click API domain name to copy the domain name.

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

Ping the API domain name from your local machine. A successful ping response indicates that the whitelist is configured correctly, as shown in the following example:

C:\Users\PCSetupAccount>ping ha-cn-5yd35gift03.public.ha.aliyuncs.com

Pinging ha-cn-5yd35gift03.public.ha.aliyuncs.com [47.107.4.95] with 32 bytes of data:
Reply from 47.107.4.95: bytes=32 time=28ms TTL=89
Reply from 47.107.4.95: bytes=32 time=30ms TTL=89
Reply from 47.107.4.95: bytes=32 time=29ms TTL=89
Reply from 47.107.4.95: bytes=32 time=30ms TTL=89

Ping statistics for 47.107.4.95:
    Packets: Sent = 4, Received = 4, Lost = 0 (0% loss),
Approximate round trip times in milli-seconds:
    Minimum = 28ms, Maximum = 30ms, Average = 29ms

API endpoints

An API endpoint allows you to access Open Search by using an API or SDK from ECS instances within the same region and VPC. Each region has a unique API endpoint, so you must use the one corresponding to your instance's region. Before you start, ping the endpoint's domain name to verify connectivity.

Username and Password: These are the credentials you set for the instance during purchase. Click the Set button to change the username and password for the instance.

Username and password requirements:

Username: Must be 0 to 30 characters long, start with a letter, and can contain uppercase letters, lowercase letters, underscores (_), and digits.
Password: Must be 6 to 8 characters long and contain only lowercase letters and digits.

Note: This endpoint is for access from within the VPC specified on the Network information tab. To use a public API domain name, follow the instructions in the Network information section.

Cluster information

The Cluster information section displays the status of the query nodes and data nodes for each cluster. Click a cluster name to view its specific status information.

Query node status information includes:

Service status: Serving or Updating.

Configuration status: Completed or Updating.

Data node status information includes:

Service status: Serving or Updating.

Configuration status: Completed or Updating.

Data status: Shows the data status for each index. The displayed fields include Index, Data status, Index version, Full switchover time, and Incremental update time.

Cluster data status: This status can be one of the following: Data Anomaly if an index has an issue (details are provided); Data Updating if an index is being updated (progress reflects the average of all updating indexes); or Normal if all indexes are healthy.

Index details:

Index-related terms:

Index: The name of an index in the cluster.
Data status: Can be Normal, Data Updating (with progress displayed), or Data Anomaly (with error details displayed).
Index size: The amount of storage space that the index occupies.
Index version: The version of the index that is currently in use.
Full switchover time: The last time a full switchover was performed for the index.
Incremental update time: The last time an incremental update was performed for the index.

O&M Management: Recall Engine Edition offers self-service cluster O&M features. These include one-click configuration pushes for tasks like deploying new clusters, updating online resources, and modifying offline index configurations. You can also manually rebuild indexes and roll back to previous versions.

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