The Instance Details page gives you a complete picture of your OpenSearch Vector Search Edition instance — its status, node configuration, network settings, and API access credentials. This page is your primary reference when connecting your application or troubleshooting instance behavior.
Instances page
The Instances page lists all OpenSearch Vector Search Edition instances in your account. From the Actions column, you can:
-
Manage: Open the Instance Details page for the selected instance.
-
Test Query: Run a quick query test against an instance that is serving traffic.
-
Upgrade/Downgrade: Add or remove Query Result Searcher (QRS) workers and Searcher workers.
Basic information
To open the Instance Details page, find the instance on the Instances page and click Manage in the Actions column.
| Parameter | Description |
|---|---|
| Instance ID and instance name | The ID and name of the instance. The name defaults to the instance ID. The names of the instances of the same user can be duplicated. The ID is generated automatically when the instance is purchased. |
| Instance status | The current state of the instance. Valid values: Normal and Frozen. A pay-as-you-go instance is frozen when your account has overdue payments. |
| Created at | The time when the instance was created. |
| Service edition | The product edition. The value is Vector Search Edition. |
| Current engine version | The version of the search engine. Latest version: vector_service_1.0.0. Earlier version: ha3_3.10.0. |
| Billing method | The billing method for the instance. The value is Pay-as-you-go. |
| Region | The region where the instance resides. |
Node information
The Node information section shows the specifications and counts of the QRS workers and Searcher workers you purchased. Use this section to confirm that your current configuration meets your traffic and data volume requirements.
| Section | Parameter | Description |
|---|---|---|
| QRS workers | QRS workers | The number of QRS workers purchased. |
| QRS worker specifications | The specifications of the QRS workers. | |
| Service status of QRS workers | The state of the QRS workers after the engine is built. | |
| Searcher workers | Searcher workers | The number of Searcher workers purchased. |
| Searcher worker specifications | The specifications of the Searcher workers. | |
| Storage space of single Searcher worker | The storage capacity of one Searcher worker. | |
| Replicas | The number of replicas. Default: 1. You can increase the number of replicas based on your business requirements. | |
| Shards | The number of shards. You can configure the number of shards to increase the memory space of the instance. | |
| Service status of Searcher workers | The state of the Searcher workers after the engine is built. |
Network information
The Network information section shows the virtual private cloud (VPC) and vSwitch that you selected when purchasing the instance. The VPC and vSwitch are in the same region as the instance.
Enable public access
By default, Public Access is turned off.
To allow connections from the internet, turn on Public Access, then configure the whitelist.
Configure the IP whitelist
Click Public Access Whitelist next to the Public Access switch. Enter the IP addresses or CIDR blocks of the devices that need internet access to the instance. Separate multiple entries with commas (,).
If you close the Modify Public Access Whitelist panel without clicking Save, a confirmation message appears and your changes are not saved.
Verify whitelist access
After adding an IP address to the whitelist, confirm that the device can reach the instance:
-
In the API endpoint section, click API Endpoint to copy the endpoint.
-
Append
publicto the endpoint hostname. For example:ha-cn-5yd35gift03.public.ha.aliyuncs.com. -
From the device, ping the modified endpoint. If the ping succeeds, the device's IP address is in the whitelist and the instance is reachable.
API endpoint
The API endpoint section shows the endpoint for accessing the instance from Elastic Compute Service (ECS) instances in the same region or VPC. Endpoints vary by region — always use the endpoint shown here when making API or SDK calls.
The API endpoint is accessible only within the VPC you specified when you purchased the instance.
Username and password
The Username and password section shows the credentials used to authenticate API requests to the instance.
To update the credentials, click the pencil icon next to Configured.
Credential requirements:
| Field | Requirement |
|---|---|
| Username | 0–30 characters. Allowed characters: letters, underscores (_), and digits. Must start with a letter. |
| Password | 6–8 characters. Lowercase letters and digits only. |