View instance information

Instances page overview

• On the Instances page, click the drop-down arrow next to an instance to view its cluster configuration. You can modify the number of QRS worker replicas, Searcher worker replicas, and Searcher worker shards.

• If you select the High-availability Edition, your instance supports multi-zone deployment. This provides dual-cluster redundancy for higher availability. If an availability zone fails, traffic is switched to another availability zone.

  • You cannot manually add or delete clusters.

  • The clusters have identical resources but can have different configurations, and you can switch traffic between them.

• The Instances page displays all instances that you have purchased. You can perform the following operations on an instance in the Actions column:

  • Manage: Opens the instance details page by default.

  • Test Query: Runs a search test on a live instance.

  • Upgrade/Downgrade: Adjusts the resources used by the instance.

Basic information

In the Retrieval Engine Edition console, navigate to the Instances page. Find the desired instance and click Manage in the Actions column to go to the instance details page.

Parameter	Description
Instance Name/Instance ID	By default, the instance name is the same as its auto-generated ID. You can assign the same name to multiple instances.
Instance Status	The current status of the instance. Valid values are Normal and Frozen. A pay-as-you-go instance is frozen if you have overdue payments.
Tags	Tags attached to the instance for organizational purposes.
Creation Time	The time the instance was created.
Service Edition	Retrieval Engine Edition.
Current Engine Version	The current engine version of the instance.
Current Offline Version	The version of the index built from offline data in the instance.
Billing Method	The billing method for the instance: pay-as-you-go or subscription.
Total QRS Workers	The number of QRS workers that you purchased for the instance.
QRS Worker Specifications	The specifications of the QRS workers that you purchased.
Total Searcher Workers	The number of Searcher workers that you purchased for the instance.
Searcher Worker Specifications	The specifications of the Searcher workers that you purchased.
Storage Space per Searcher Worker	For SSD-based Searcher workers, you are charged for storage that exceeds the free quota. For cloud disk-based or GPU-based Searcher workers, no free storage quota is provided, and all used storage is billed.
Region	The region where the instance is deployed.
Resource Group ID/Resource Group Name	Resource groups help you manage permissions, deployments, and monitoring for a collection of resources, rather than managing each resource individually.
Availability Edition	Standard Edition: Deploys the instance in a single availability zone and does not support zone-level disaster recovery. High-availability Edition: Deploys the instance across multiple availability zones. This provides dual-cluster redundancy for higher availability. If an availability zone fails, traffic is switched to another availability zone.

Network information

VPC, vSwitch ID, and Public Access: The network settings that you selected on the purchase page. These resources must be in the same region as the instance and are used to control instance access.

Public Access is disabled by default. You can enable it manually. After you enable public access, the option to configure a whitelist appears.

Click Public Access Whitelist to add, delete, or edit the whitelist content. A confirmation prompt appears if you attempt to exit the page without saving your changes. If you exit, your changes are not saved.

Add to whitelist: Manually enter IP addresses. Separate multiple IP addresses with semicolons (;), for example, 192.168.xx.xx;192.168.xx.xx. After you finish editing, click Save in the upper-right corner.

Verify the whitelist configuration: From a whitelisted IP address, ping the endpoint to verify access.

Obtain the domain name from the Endpoint section. For public access, you must add public to the domain name. For example: ha-cn-*******.public.ha.aliyuncs.com. Ping the public endpoint domain name from a whitelisted machine. If you receive a response, the IP address was successfully added to the whitelist.

C:\Users\issuser>ping ha-cn-xxx.public.ha.aliyuncs.com
Pinging ha-cn-xxx.public.ha.aliyuncs.com [47.xxx] with 32 bytes of data:
Reply from 47.xxx: bytes=32 time=32ms TTL=89
Reply from 47.xxx: bytes=32 time=28ms TTL=89
Reply from 47.xxx: bytes=32 time=27ms TTL=89
Reply from 47.xxx: bytes=32 time=27ms TTL=89
Ping statistics for 47.xxx:
    Packets: Sent = 4, Received = 4, Lost = 0 (0% loss),
Approximate round trip times in milli-seconds:
    Minimum = 27ms, Maximum = 32ms, Average = 28ms

Endpoint

The endpoint is the domain name used to connect to your instance via an API or SDK. You can connect from ECS instances that are within the same region and VPC. Each region has a unique endpoint. Before use, select the appropriate endpoint for your deployment and test its accessibility by using the ping command.

Username and Password: The credentials that you entered on the purchase page to access the instance. Click the Configured button to change the username and password for the current instance.

Credential requirements:

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

• Password: Must be at least 13 characters in length and contain uppercase letters, lowercase letters, digits, and special characters, such as !@#$%^&*()_+-=.

Deployment visualization

The deployment visualization section provides a read-only diagram of your instance's worker topology, allowing you to check the status of each worker at a glance.