Instance management

Instances page

At the top of the page are the Create Instance button and a search bar to search by instance ID. The instance list includes the following columns: Instance name/Instance ID, Instance status, Number of QRS workers, QRS worker specifications, Number of Searcher workers, Searcher worker specifications, Billing method, and Actions.

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

• Manage: Opens the instance details page.

• Test Query: Lets you perform a simple search test on an active instance.

• modify configuration: Lets you modify the resources of the instance.

Basic information

In the OpenSearch Vector Search Edition console, navigate to the instance management page. Find your target instance and click Manage in the Actions column to open the instance details page.

The instance details page contains three tabs: Basic information, Network information, and API endpoint. In addition to the fields listed in the table below, the Basic information tab also displays the resource group ID, resource group name, and storage space per Searcher worker. The Cluster information section is at the bottom of the page.

Network information

The VPC, vSwitch ID, and Public access fields display the network settings you selected when you created the instance. The instance uses these settings for network access.

Add to public access whitelist: By default, Public access is disabled.

You can enable it manually. When enabled, the whitelist configuration options appear.

Click Public access whitelist to add, delete, or modify entries. If you attempt to close the panel without saving your changes, a confirmation message appears. These changes are discarded if you exit without saving.

Add to whitelist: Manually enter IP addresses. Separate multiple IP addresses with commas. You can configure individual IP addresses or CIDR blocks, such as 192.168.0.1 or 192.168.0.0/24. After you finish, click Save.

Verify the whitelist configuration: You can log on to a machine whose IP address is in the whitelist and ping the API endpoint domain. For example, to test an IP address from your local machine, add its IP address, such as 30.197.xxx.xxx, to the whitelist.

Obtain the domain name from the API endpoint tab. Click API domain to copy it.

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 endpoint domain from your local machine. A successful ping response indicates that 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 endpoint

Use this API endpoint for access from services like Elastic Compute Service (ECS) within the same region and VPC. Because the API domain name varies by region, you must use the endpoint provided here when accessing OpenSearch Vector Search Edition with an API or SDK. Select the appropriate domain name for your deployment and run the ping command to verify its accessibility before use.

Username and password: These are the credentials you configured when you created the instance. To change them, click the Configured button.

In the Modify password dialog box, enter the new Username, Password, and Confirm Password, and then click OK.

Credential requirements:

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

• Password: Must be 6 to 8 characters long and contain lowercase letters and digits.

Note: This API endpoint is for private access within the VPC specified in the Network information tab. If you require a public API endpoint, contact us.

• Document search demo.

• Sample code for data push.

Cluster information

The Cluster information section displays the status of the QRS workers and Searcher workers for each cluster. Click a cluster name to view its specific status information.

The status information for QRS workers includes:

Service status: Running or Updating.

Configuration status: Completed or Updating.

The status information for Searcher workers includes:

Service status: Running or Updating.

Configuration status: Completed or Updating.

Data status: Displays the data status for each index table. This includes fields such as Index table, Data status, Index version, Full switch time, and Incremental update time.

Cluster data status: If any index table has a data anomaly, the status is Data Exception, and details of the exception are displayed. If any index table is being updated, the status is Data Updating, and the progress shown is the average of all updating tables. If all index tables are normal, the status is Normal.

The details of the index table are as follows:

Index table terminology:

• Index table: The name of an index table within the cluster.

• Data status: The status of the data. Valid values are Normal, Data Updating (with progress displayed), and Data Exception (with exception details displayed).

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

• Index version: The index version currently in use by the index table.

• Full switch time: The timestamp of the last full switch for the index table.

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

O&M management: OpenSearch Vector Search Edition provides self-service cluster O&M capabilities, including one-click configuration push for operations that require it (such as deploying a new cluster, updating online resources, and modifying offline index configurations), manual index rebuilding, and rolling back to a historical version.

The deployment management page lets you view the cluster topology of your instance and modify online configurations.