DocsICP FilingConsole
官方文档
首页

Getting Started

更新时间：
复制 MD 格式
产品详情
我的收藏

Prerequisites

  1. You have successfully signed up for an Alibaba Cloud account and completed real-name verification.

  2. When you activate your Alibaba Cloud account and log on to the console, you must create an access key to proceed.

  • An access key is required to create and use applications. The access key for your main account cannot be empty.

  • After creating an access key for your main account, you can also create an access key for a RAM user to access resources. Grant the RAM user the required permissions. For more information, see RAM authentication.

  1. You must have a Virtual Private Cloud (VPC) environment. For more information, see What is a Virtual Private Cloud (VPC).

Note:

If you need to use a RAM user to manage an OpenSearch Retrieval Engine Edition instance, you must use your main account to grant the AliyunSearchEngineFullAccess and AliyunSearchEngineReadOnlyAccess permissions to the RAM user.

Purchase an instance

To purchase an instance, see Purchase an OpenSearch Retrieval Engine Edition instance.

Configure a cluster

Note:

A newly purchased instance has a status of "Pending Configuration" on its details page. The system automatically deploys an empty cluster that matches the quantity and specifications of the query nodes and data nodes you purchased.

1. Select the instance you want to configure and click Configure.

2. Enter a table name, select the number of shards and data update resources, and then click Next.

Note

Name: Consists of letters, digits, or underscores (_), with a maximum length of 25 characters.

Number of shards: Enter a positive integer up to 256. Shards improve full index building speed and single-query performance.

Data update resources: The number of resources for real-time data updates. Increasing this value expands concurrency for consuming real-time data, which improves TPS.

3. Configure a data source. Supported data sources include MaxCompute + API Data Source, OSS + API Data Source, API Data Source, and Data Lake Formation (DLF). After configuring the parameters, you can optionally enable automatic index rebuilding. After the data source is validated, click Next.

When you configure a MaxCompute data source, you must specify the following parameters: AccessKey and AccessKey Secret, Project Name (Project) (3 to 28 characters; must start with a letter and contain only letters, digits, and underscores), Table Name (Table) (1 to 128 characters; must start with a letter and contain only letters, digits, and underscores), and Table Partition (Partition) (separate multi-level partitions with commas). After you enter the information, click Validate. After the data source passes validation, you can click Next.

4. Select the primary key, attribute fields, and fields to display in search results. Specify whether to compress data and select the analyzer for each corresponding field.

Attribute and field content compression:

  • Attribute fields are not compressed by default. To enable compression, select file_compressor.

  • Field content is not compressed by default. For multi-value STRING fields, the default is uniq. For single-value numeric fields, the default is equal.

Note

  • If you enable attribute compression, we recommend that you go to Cluster Management > Node Status > Table Loading Policy to edit the index loading method. This can reduce the performance impact.

  • Only TEXT fields can be configured with an analyzer.

  • Field duplication is supported. The new, duplicated field (DUP field) has the same content as the original field. If you push inconsistent content, the content of the original field overwrites it. If you want the fields to have different content, manually delete the copy from configuration in the advanced settings of the DUP field.

  • If a field is missing or empty in the data, the system automatically populates a default value: 0 for numeric types and an empty string for STRING types. You can also specify a custom default value.

5. Configure an index for each searchable field, and then click Next.

6. Configure indexes: On the index settings page, set the Index name, Index type (such as TEXT or STRING), Included fields, and Data compression method. You can click View/Modify to adjust advanced settings. Click + to add a new index row. When you are finished, click Next.

7. Click Confirm Creation and wait for the build to complete.

After you confirm the information is correct, click Confirm Creation. The system automatically builds the index based on the selected concurrent resources. After the build is complete, the index is automatically enabled in the current instance.

Check index rebuilding progress

In the left-side navigation pane, click Change History and select a time range within the last three days to view the build progress.

Test a query

You can perform a simple search test on the Feature Extensions > Query Test page. OpenSearch Retrieval Engine Edition supports three query methods: HA query, SQL query, and REST API query.

Select HA query as the query method. In the query box, enter a query statement, such as id:'1'. Use the format shown in the hint, for example, daogou:part_ids=0|2. Set the cluster (for example, general) and config (for example, start:0,hit:10,format:json) parameters. After submission, the page displays the request URL, number of matched records, latency, and returned values for each field at the bottom.

Usage notes

Important

  • Currently, only the pay-as-you-go billing method is supported.

  • The username and password set during instance purchase can be modified on the instance details page.

  • The cluster name is assigned by the system during instance purchase and cannot be changed.

  • You are billed for each index rebuild based on the resources consumed. For more information, see Retrieval Engine Edition Billing Overview.

Previous：GlossaryNext：Create and authorize a RAM user