Instance details

List page overview

The top of the page provides a Create instance button and a search box that filters 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.

This page lists all instances you have purchased. The Actions column supports the following operations:

• Manage: Opens the instance details page.

• Search Test: Runs a simple search test on an instance that is currently serving traffic.

• Scale: Adjusts the resources allocated to 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 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 Storage space per data node, Resource group ID, and Resource group name.

Parameter	Description
Instance name/instance ID	By default, the instance name matches its instance ID. You can reuse the same name across multiple instances under your account. The instance ID is automatically generated when the instance is created.
Instance status	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: Displays the VPC, vSwitch, and public access settings selected during instance purchase.

Public access whitelist: Public access is disabled by default.

After 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 specify individual IP addresses (for example, 192.168.0.1) or CIDR ranges (for example, 192.168.0.0/24). After entering the addresses, click Save.

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

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

Append public to the domain name for internet access, for example, ha-cn-5yd35gift03.public.ha.aliyuncs.com.

Ping the API domain name from your local machine. A successful response confirms the whitelist is configured correctly:

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 lets you access OpenSearch by using an API or SDK from ECS instances within the same region and VPC. Each region has a unique endpoint, so use the one that corresponds to your instance's region. Ping the endpoint's domain name to verify connectivity before you start.

Username and Password: The credentials you set during instance purchase. Click Set to change them.

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, see the Network information section.

• Document Search Demo

• Data Push Demo

Cluster information

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

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. Fields include Index, Data status, Index version, Full switchover time, and Incremental update time.

Cluster data 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 index name in the cluster.

• Data status: Can be Normal, Data Updating (with progress displayed), or Data Anomaly (with error details displayed).

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

• Index version: The version of the index currently in use.

• Full switchover time: When the last full switchover was performed for the index.

• Incremental update time: When the last incremental update was performed for the index.

O&M Management: Recall Engine Edition provides self-service cluster O&M features, including one-click configuration pushes for 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: View the cluster topology of your instance and modify some online configurations.