# opensearch-instance

Part of **OPENSEARCH**

<!-- intent-backlink:auto -->

> 💡 **Path Selection**: This skill is one implementation path for [Manage data sources for ingestion](../../intent/opensearch-manage-sources/SKILL.md). If you're unsure which path to take, check the routing skill first.

# OpenSearch Instance and Resource Management Console Guide

## Operations Overview

| Operation | Console Navigation Path | Prerequisites | Description |
|-----------|------------------------|---------------|-------------|
| Create and Configure Instance | Console > Elasticsearch > Instances > Create Instance | Alibaba Cloud account with real-name verification, AccessKey, VPC environment | Set up a new OpenSearch instance with data source and index configuration |
| Manage Instance | Recall Engine Edition > Instance management | Active Elasticsearch instance in VPC | View and modify instance details including network settings and API endpoints |
| Add Cluster | Console > O&M Center > O&M Management | Available QRS and Searcher worker quota | Add a new cluster to handle increased query load or enable high availability |
| Scale Shards | Console > OpenSearch > Instance Details > O&M Center > O&M Management | Available Searcher workers | Adjust the number of shards for better performance |
| Update Configurations | Console > O&M Center > Configuration Management > Update Configurations | Retrieval Engine Legacy Edition deployed, at least one cluster configured | Modify index tables and data sources with reindexing |
| Roll Back Index Version | Console > OpenSearch Retrieval Engine Edition > Cluster Management > O&M | None | Revert to a previous index version when issues occur after reindexing |
| Access OpenSearch Over Internet | Console > OpenSearch > Instances > Instance Details | OpenSearch instance in VPC, ECS in same VPC, NAT gateway permissions | Configure internet access via NAT gateway and DNAT entry |
| View Billing Details | Expenses > Bills > Bill > Bill Details | None | Check costs for instance rental, QRS workers, and Searcher workers |
| Configure Function VPC Access | Console > Function Compute > Functions > Create Function | OpenSearch instance in VPC, Function Compute service | Enable Function Compute to access OpenSearch over private network |
| Create RAM User | Console > Identities > Users | Alibaba Cloud account with RAM management permissions | Create and authorize RAM users for OpenSearch access control |
| View Instance Metrics | Console > OpenSearch > Instances > Metrics monitoring | None | Monitor query throughput, latency, and resource utilization |
| Create Alert Group | Console > OpenSearch - Retrieval Engine Edition > Alert Management > Alert Group List | Target cluster available, alert contacts created | Set up alert groups for monitoring notifications |
| Add DingTalk Alert Contact | Console > Elasticsearch > Alert Management > Contact Management | DingTalk app installed, DingTalk group created | Configure DingTalk as an alert notification channel |

## Step-by-Step Instructions

### Create and Configure Instance

**Navigation**: Console > Elasticsearch > Instances > Create Instance

**Prerequisites**:
- Register an Alibaba Cloud account and complete identity verification
- Create an AccessKey for your Alibaba Cloud account
- Have a VPC environment ready
- Grant RAM user the required permissions (AliyunSearchEngineFullAccess and AliyunSearchEngineReadOnlyAccess)

1. Select the instance that you want to configure and click **Configure**
   - Element: **Configure** (button) — top-right corner
   - Notes: 

2. Enter a table name, select the number of shards, and specify the number of data update resources. Then, click **Next**
   - Element: **Next** (button) — bottom of the form
   - Notes: Table name can contain letters, digits, and underscores (_), up to 25 characters. Number of shards must be a positive integer no greater than 256. Number of data update resources affects real-time data concurrency.

3. Configure a data source. Use MaxCompute as an example. Enable automatic index rebuilding if required. Click **Next**
   - Element: **Next** (button) — bottom of the form
   - Notes: Supported data sources: MaxCompute + API, OSS + API, API, Data Lake Formation (DLF). Automatic index rebuilding is optional.

4. Select the primary key, property fields, and fields to display in search results. Choose compression settings and analysis methods for each field. Click **Next**
   - Element: **Next** (button) — bottom of the form
   - Notes: Property compression requires adjusting index loading policy in Cluster Management. Field analysis method only applies to TEXT-type fields. Default values are 0 for numeric types and empty string for STRING types.

5. Configure an index for each field used for index-based retrieval. Click **Next**
   - Element: **Next** (button) — bottom of the form
   - Notes: 

6. Click **Confirm** to create the cluster and wait for the new version to be built
   - Element: **Confirm** (button) — bottom of the form
   - Notes: 

7. In the navigation pane, click **Change History** to view index rebuilding progress
   - Element: **Change History** (link) — left navigation panel
   - Notes: Select a time range like 'last 3 days' to view build progress.

8. Navigate to Feature Extensions > **Query Test** to run a search test
   - Element: **Query Test** (link) — Feature Extensions section
   - Notes: Supports HA query, SQL query, and REST API query methods.

| Parameter | Type | Required | Options/Values | Description |
|-----------|------|----------|----------------|-------------|
| Table name | text | Yes | — | The name of the table. Can contain letters, digits, and underscores (_), up to 25 characters in length. |
| Number of shards | number | Yes | — | A positive integer no greater than 256. Improves full build speed and single query performance. |
| Number of data update resources | number | Yes | — | Controls concurrency for real-time data updates, improving Transactions Per Second (TPS). |
| Data source | dropdown | Yes | MaxCompute + API data source, OSS + API data source, API data source, Data Lake Formation (DLF) | Specifies the source of data to be indexed. |
| Enable automatic index rebuilding | checkbox | No | — | If enabled, the system automatically rebuilds indexes when data changes. |
| Primary key | dropdown | Yes | — | Select the field to use as the primary key for the table. |
| Property fields | dropdown | Yes | — | Select fields to include as property fields in the index. |
| Fields to display in search results | dropdown | Yes | — | Choose which fields should appear in search result previews. |
| Compress property fields | checkbox | No | — | Enables compression for property fields. If enabled, adjust index loading policy in Cluster Management. |
| Compress field content | checkbox | No | — | Enables compression for field content. Default method is uniq for multi-value/STRING fields, equal for single-value numeric fields. |
| Analysis method | dropdown | No | — | Only applicable to TEXT-type fields. Determines how text is processed during indexing. |
| Customize default value | checkbox | No | — | Allows overriding the default value for missing or empty fields. Default is 0 for numeric, empty string for STRING. |

### Manage Instance

**Navigation**: Recall Engine Edition > Instance management

**Prerequisites**:
- An Elasticsearch instance must be created and purchased
- The instance must be in a VPC with proper network configuration

1. Click the **Manage** button in the Actions column of the instance list
   - Element: **Manage** (link) — Actions column in the instance list
   - Notes: 

2. Navigate to the **Network information** tab
   - Element: **Network information** (tab) — Top navigation of the instance details page
   - Notes: 

3. Click **Public access whitelist** to configure IP addresses
   - Element: **Public access whitelist** (link) — Within the Network information tab
   - Notes: IP addresses can be entered as individual IPs or CIDR ranges; changes are lost if you leave without saving.

4. Enter IP addresses or CIDR ranges and click **Save**
   - Element: **Save** (button) — After entering IP addresses in the whitelist form
   - Notes: 

5. Go to the **API endpoints** tab and copy the API domain name
   - Element: **API endpoints** (tab) — Top navigation of the instance details page
   - Notes: 

6. Add 'public' to the domain name for internet access
   - Element: **API domain name** (code) — API endpoints tab
   - Notes: Example: ha-cn-5yd35gift03.public.ha.aliyuncs.com

| Parameter | Type | Required | Options/Values | Description |
|-----------|------|----------|----------------|-------------|
| Instance name/instance ID | text | No | — | The name of an instance. By default, the instance name is the same as its instance ID. You can use the same name for multiple instances under your account. The instance ID is automatically generated when the instance is created. |
| Instance description | text | No | — | A custom description for the instance. |
| Username | text | Yes | — | Must be 0 to 30 characters long, start with a letter, and can contain uppercase letters, lowercase letters, underscores (_), and digits. |
| Password | text | Yes | — | Must be 6 to 8 characters long and contain only lowercase letters and digits. |

### Add Cluster

**Navigation**: Console > O&M Center > O&M Management

**Prerequisites**:
- An OpenSearch instance with available Query Result Searcher (QRS) worker and Searcher worker quota
- Access to O&M Center in the console

1. Navigate to O&M Center > O&M Management and click **Add Cluster**
   - Element: **Add Cluster** (button) — main content area
   - Notes: Screenshot shows the O&M Management page with the Add Cluster button highlighted.

2. Configure resources for the new cluster, including **Mount Method** and worker counts
   - Element: **Mount Method** (dropdown) — form fields section
   - Notes: The Mount Method dropdown has two options: Auto and Manual. Auto connects the cluster automatically after deployment; Manual requires manual connection on the deployment management page.

3. Check deployment status and change history on the instance details page
   - Element: **Change History** (tab) — bottom of instance details page
   - Notes: Screenshot shows the change history section where progress can be tracked. The cluster is ready when it shows as properly running.

| Parameter | Type | Required | Options/Values | Description |
|-----------|------|----------|----------------|-------------|
| Cluster Name | text | No | — | The name of the new cluster, generated automatically by the system. |
| Mount Method | dropdown | Yes | Auto, Manual | Controls how the new cluster connects to incoming queries on the deployment management page. Use 'Auto' for immediate live traffic handling; use 'Manual' for staging or standby setups. |
| QRS workers and replicas | number | Yes | — | Number of QRS workers allocated to the cluster. All clusters share the total QRS worker quota. Exceeding the instance quota will cause an error. |

### Scale Shards

**Navigation**: Console > OpenSearch > Instance Details > O&M Center > O&M Management

**Prerequisites**:
- The total number of Searcher workers in your instance is greater than the number currently in use.
- If additional workers are needed, purchase them via instance configuration modification.

1. Log on to the OpenSearch console and go to the details page of your instance.
   - Element: **O&M Center** (menu) — left-side pane
   - Notes: 

2. Click **Quickly Scale Shards**.
   - Element: **Quickly Scale Shards** (button) — O&M Management page
   - Notes: 

3. Select a data source, full index version, shard count, and submit.
   - Element: **Submit** (button) — form area
   - Notes: If no unused Searcher workers are available, the option is disabled. Purchase more workers first.

4. Click **View Change History** to review the change record.
   - Element: **View Change History** (button) — after successful operation
   - Notes: 

5. Click **Force Switch** to enable full indexing.
   - Element: **Force Switch** (button) — change history section
   - Notes: 

6. Go to Configuration Center > Index Schema and click **Edit** for the target index table.
   - Element: **Edit** (button) — Actions column
   - Notes: 

7. Change the number of data shards and save.
   - Element: **Save** (button) — form area
   - Notes: 

8. Return to O&M Center > O&M Management and click **Update Configurations**.
   - Element: **Update Configurations** (button) — O&M Management page
   - Notes: 

9. Select the new index table version and set Trigger Reindexing to Push Configurations and Trigger Reindexing, then click **OK**.
   - Element: **OK** (button) — dialog box
   - Notes: For API data sources, only incremental data from the last three days is retained.

| Parameter | Type | Required | Options/Values | Description |
|-----------|------|----------|----------------|-------------|
| Data source | dropdown | Yes | API data source, MaxCompute data source, Object Storage Service (OSS) data source | Specifies the type of data source used by the index table. |
| Full index version | dropdown | Yes | — | Selects the version of the full index to use for scaling. |
| Number of shards | number | Yes | — | Sets the desired number of shards for the index table. |
| Trigger Reindexing | dropdown | Yes | Push Configurations and Trigger Reindexing, Only Push Configurations | Controls whether reindexing is triggered after configuration update. |

### Update Configurations

**Navigation**: Console > O&M Center > Configuration Management > Update Configurations

**Prerequisites**:
- Retrieval Engine Legacy Edition deployed
- Access to O&M Management page
- At least one cluster configured
- Data source already set up (if applicable)

1. Select parameters for configuration update
   - Element: **Index Schema Version** (dropdown) — main content area
   - Notes: 

2. Specify the Index Table Version when Index Schema Version is selected
   - Element: **Index Table Version** (dropdown) — main content area
   - Notes: 

3. Choose whether to automatically rebuild indexes
   - Element: **Whether to Automatically Rebuild Indexes** (checkbox) — main content area
   - Notes: 

4. Submit the new configurations
   - Element: **Submit** (button) — bottom of form
   - Notes: After submission, changes are pending until reindexing completes.

5. Navigate to **Change History** to monitor update progress
   - Element: **Change History** (link) — O&M Center menu
   - Notes: View status of configuration updates and reindexing tasks.

| Parameter | Type | Required | Options/Values | Description |
|-----------|------|----------|----------------|-------------|
| Index Schema Version | dropdown | Yes | v1.0, v1.1, v1.2 | Selects the schema version for the index structure. |
| Advanced Config Version | dropdown | No | default, custom_v1, custom_v2 | Specifies the version of advanced configuration settings. |
| Whether to Automatically Rebuild Indexes | checkbox | No | — | If enabled, triggers automatic reindexing after configuration update. |

### Roll Back Index Version

**Navigation**: Console > OpenSearch Retrieval Engine Edition > Cluster Management > O&M

1. Log in to the OpenSearch Retrieval Engine Edition console and navigate to the cluster management page.
   - Element: **O&M** (link) — left navigation pane
   - Notes: 

2. Select the desired previous version from the list on the O&M page.
   - Element: **version** (dropdown) — O&M page
   - Notes: Refer to the screenshot showing version selection.

3. Click **OK** to confirm the rollback operation.
   - Element: **OK** (button) — confirmation dialog
   - Notes: Refer to the screenshot showing the rollback confirmation dialog.

4. Monitor the rollback progress by navigating to **Change History**.
   - Element: **Change History** (link) — O&M Center
   - Notes: Refer to the screenshot showing rollback progress in Change History.

### Access OpenSearch Over Internet

**Navigation**: Console > OpenSearch > Instances > Instance Details

**Prerequisites**:
- An OpenSearch Retrieval Engine Edition instance deployed in a VPC
- An ECS instance in the same VPC as the OpenSearch instance
- A VPC with sufficient permissions to create a NAT gateway and DNAT entry

1. Log on to the OpenSearch console and select **OpenSearch Retrieval Engine Edition** from the drop-down list in the upper-left corner
   - Element: **OpenSearch Retrieval Engine Edition** (dropdown) — upper-left corner
   - Notes: 

2. Click the name of the instance that you want to access and view the API endpoint on the Instance Details page
   - Element: **Instance name** (link) — Instances page
   - Notes: The API endpoint is displayed on the Instance Details page.

3. Log on to the VPC console and create an Internet NAT gateway in the same VPC as the OpenSearch Retrieval Engine Edition instance
   - Element: **Create Internet NAT gateway** (button) — VPC console
   - Notes: Ensure the NAT gateway is created in the same VPC as the OpenSearch instance.

4. Create a DNAT entry for the NAT gateway and specify the IP address obtained in Step 1
   - Element: **Create DNAT entry** (button) — NAT gateway configuration page
   - Notes: Use the private IP address of the OpenSearch instance as the target IP.

5. In Postman, access the public IP address specified in Step 3 and configure request headers
   - Element: **Host** (text_input) — Headers section
   - Notes: Must include Host, X-Opensearch-Swift-PK-Field, and X-Opensearch-Swift-Request-ID headers.

6. Select **Basic Auth** for authentication and enter the username and password of the OpenSearch Retrieval Engine Edition instance
   - Element: **Basic Auth** (radio) — Authentication tab
   - Notes: Credentials are those set for the OpenSearch instance.

7. Enter the document that you want to send in the body
   - Element: **Body** (text_input) — Body section
   - Notes: Include the full JSON payload for the request.

| Parameter | Type | Required | Options/Values | Description |
|-----------|------|----------|----------------|-------------|
| Host | text | Yes | — | The host header must be set to the public IP address of the NAT gateway. |
| X-Opensearch-Swift-PK-Field | text | Yes | — | Specifies the primary key field used in the OpenSearch index. |
| X-Opensearch-Swift-Request-ID | text | Yes | — | A unique identifier for the request to enable tracing and debugging. |
| Username | text | Yes | — | The username for Basic Auth authentication. |
| Password | text | Yes | — | The password for Basic Auth authentication. |

### View Billing Details

**Navigation**: Expenses > Bills > Bill > Bill Details

1. Log on to the Alibaba Cloud Console
   - Element: **Alibaba Cloud Console** (link) — upper-right corner of the page
   - Notes: 

2. Choose **Expenses** > **Bills**
   - Element: **Expenses** (menu) — upper-right corner of the page
   - Notes: 

3. Choose **Bill** > **Bill Details**
   - Element: **Bill** (menu) — left-side navigation pane
   - Notes: 

4. Select **OpenSearch - Retrieval Engine Edition Pay-As-You-Go** in the Product Detail column
   - Element: **OpenSearch - Retrieval Engine Edition Pay-As-You-Go** (dropdown) — Product Detail column
   - Notes: 

5. Click **View Details** in the Actions column for a specific order
   - Element: **View Details** (button) — Actions column
   - Notes: 

### Configure Function VPC Access

**Navigation**: Console > Function Compute > Functions > Create Function

**Prerequisites**:
- An existing OpenSearch Retrieval Engine Edition instance in a VPC
- Function Compute service with network configuration capability

1. Enable the **Allow access to VPC** switch
   - Element: **Allow access to VPC** (checkbox) — Advanced settings section
   - Notes: 

2. Select the VPC where the OpenSearch instance is located
   - Element: **VPC** (dropdown) — Network configuration section
   - Notes: The VPC must be the same one where the OpenSearch instance resides.

3. Click **Edit** to modify the VPC access settings for an existing function
   - Element: **Edit** (button) — Function details panel
   - Notes: Used when an existing function returns a 403 error due to network access restrictions.

4. Select the correct VPC associated with the OpenSearch instance
   - Element: **VPC** (dropdown) — Network configuration section
   - Notes: Ensure the selected VPC matches the one hosting the OpenSearch instance.

| Parameter | Type | Required | Options/Values | Description |
|-----------|------|----------|----------------|-------------|
| VPC | dropdown | Yes | — | The virtual private cloud where the OpenSearch instance is deployed. Must match the OpenSearch instance's VPC. |
| Allow access to VPC | checkbox | No | — | Enables the Function Compute function to access resources within a specified VPC. |

### Create RAM User

**Navigation**: Console > Identities > Users

**Prerequisites**:
- Alibaba Cloud account with sufficient permissions to manage RAM users
- Knowledge of OpenSearch resource permissions to assign appropriate policies

1. Log on to the RAM console
   - Element: **RAM console** (link) — top navigation
   - Notes: 

2. Navigate to Users page
   - Element: **Identities > Users** (menu) — left-side navigation pane
   - Notes: 

3. Click **Create User**
   - Element: **Create User** (button) — Users page
   - Notes: 

4. Configure Logon Name and Display Name
   - Element: **Logon Name** (text_input) — form fields
   - Notes: 

5. Select Access Mode
   - Element: **Console Access** (radio) — Access Mode section
   - Notes: If selecting Console Access, configure logon security settings including password type, reset requirement, and MFA.

6. Select Access Mode
   - Element: **OpenAPI Access** (radio) — Access Mode section
   - Notes: When selected, an AccessKey pair is automatically created for the RAM user.

7. Click **OK** to complete user creation
   - Element: **OK** (button) — bottom of form
   - Notes: 

8. Obtain the logon URL from the Overview page
   - Element: **Overview** (tab) — RAM user details page
   - Notes: The logon URL allows the RAM user to sign in to the Alibaba Cloud console.

9. Find the target RAM user and click **Add Permissions**
   - Element: **Add Permissions** (button) — Actions column
   - Notes: 

10. Set Authorized Scope to Alibaba Cloud Account
    - Element: **Authorized Scope** (dropdown) — Add Permissions panel
    - Notes: 

11. Set Principal to the RAM user's logon name
    - Element: **Principal** (text_input) — Add Permissions panel
    - Notes: 

12. Click **Custom Policy** and select a policy
    - Element: **Custom Policy** (button) — Select Policy section
    - Notes: Requires prior creation of a custom policy for OpenSearch access.

13. Click **OK** to attach the policy
    - Element: **OK** (button) — bottom of panel
    - Notes: 

14. Verify attachment and click **Complete**
    - Element: **Complete** (button) — bottom of panel
    - Notes: 

| Parameter | Type | Required | Options/Values | Description |
|-----------|------|----------|----------------|-------------|
| Logon Name | text | Yes | — | The unique identifier used by the RAM user to log on to the Alibaba Cloud console. |
| Display Name | text | Yes | — | A human-readable name for the RAM user, displayed in the console. |
| Access Mode | radio | Yes | Console Access, OpenAPI Access | Determines how the RAM user accesses Alibaba Cloud resources. |
| Authorized Scope | dropdown | Yes | Alibaba Cloud Account | Specifies the scope of resources the policy applies to. |
| Principal | text | Yes | — | The logon name of the RAM user being authorized. |

### View Instance Metrics

**Navigation**: Console > OpenSearch > Instances > Metrics monitoring

1. Click on **Metrics monitoring**
   - Element: **Metrics monitoring** (button) — main content area
   - Notes: 

### Create Alert Group

**Navigation**: Console > OpenSearch - Retrieval Engine Edition > Alert Management > Alert Group List

**Prerequisites**:
- At least one target cluster (instance ID) must be available
- Alert contacts must be created before assigning them to alert rules

1. Click the **Default Alert** button on the Alert group list page
   - Element: **Default Alert** (button) — top of the Alert group list page
   - Notes: 

2. Click the **Alert Rule List** button for the newly created Default Alert group
   - Element: **Alert Rule List** (button) — within the Default Alert group row
   - Notes: 

3. Click the **Enable** button on the alert rule list page
   - Element: **Enable** (button) — on the alert rule list page
   - Notes: 

4. Log on to the OpenSearch - Retrieval Engine Edition console and navigate to Alert Management > Alert Group List
   - Element: **Alert Management** (menu) — left navigation panel
   - Notes: 

5. Click **Create Alert Group**
   - Element: **Create Alert Group** (button) — top-right corner of the Alert Group List page
   - Notes: 

6. Enter an Alert Rule Group Name and Description in the dialog box, then click **OK**
   - Element: **OK** (button) — bottom-right of the Create Alert Rule Group dialog
   - Notes: 

7. Click **Create Alert Rule** on the Alert group list page
   - Element: **Create Alert Rule** (button) — top of the Alert group list page
   - Notes: 

8. Configure parameters such as Alert Rule Name, Target Cluster, Alert Metric, Alert Threshold, Notification Interval, Alert Contact, and Notification Method
   - Element: **Create** (button) — bottom of the Create Alert Rule dialog
   - Notes: Ensure at least one contact is created before proceeding

9. Click the **Enable** button after configuring the alert rule
   - Element: **Enable** (button) — on the alert rule list page
   - Notes: 

10. Click **View Alert Rules** on the Alert group list page
    - Element: **View Alert Rules** (button) — on the Alert group list page
    - Notes: 

11. Perform operations like create, modify, copy, delete, or disable alert rules in the Alert Rule List dialog
    - Element: **Confirm** (button) — bottom of the Alert Rule List dialog
    - Notes: 

12. Click **Delete** on the Alert group list page
    - Element: **Delete** (button) — on the Alert group list page
    - Notes: All alert rules within the group will also be deleted

| Parameter | Type | Required | Options/Values | Description |
|-----------|------|----------|----------------|-------------|
| Alert Rule Group Name | text | Yes | — | The name of the new alert group. Must be unique. |
| Description | text | No | — | Optional description for the alert group. |
| Alert Rule Name | text | Yes | — | The name of the alert rule. |
| Target Cluster | dropdown | Yes | — | Select the instance ID of the target cluster to monitor. |
| Alert Metric | dropdown | Yes | opensearch.ha3suez.searcher.index.full_delay_hours, opensearch.ha3suez.searcher.index.batch_inc_delay_minutes, opensearch.ha3suez.searcher.index.rate_of_change, opensearch.ha3suez.searcher.proc_cpu, opensearch.ha3suez.qrs.basic.qrssessionlatencynormal, opensearch.ha3suez.searcher.disk_use_ratio, opensearch.ha3suez.qrs.proc_cpu, opensearch.ha3suez.searcher.proc_mem_used_ratio, opensearch.ha3suez.qrs.proc_mem_used_ratio | The monitoring metric to track for the alert. |
| Alert Threshold | text | Yes | — | Set the warning and critical thresholds. For example: WARNING:>20, CRITICAL:>20. |
| Notification Interval | text | Yes | 5 minutes | How often notifications should be sent if the alert condition persists. |
| Alert Contact | dropdown | Yes | — | Select a contact to receive alerts. |
| Notification Method | checkbox | Yes | Text message, Phone call | Choose how the alert should be delivered. |

### Add DingTalk Alert Contact

**Navigation**: Console > Elasticsearch > Alert Management > Contact Management

**Prerequisites**:
- DingTalk app installed on PC
- A DingTalk group created for alert management

1. Click the group settings icon in the upper right corner of the DingTalk group
   - Element: **group settings icon** (button) — upper right corner
   - Notes: 

2. Navigate to the group settings page and click **Bots**
   - Element: **Bots** (link) — group settings page
   - Notes: 

3. Click **Add Bot** in the bot management panel
   - Element: **Add Bot** (button) — bot management panel
   - Notes: 

4. Click **Add Bot**, select Customize bot type, and click **Add**
   - Element: **Add Bot** (button) — bot dialog box
   - Notes: Select bot type: Customize

5. Enter a name for the bot, such as Alibaba Cloud ES Monitoring
   - Element: **Enter a name for the bot** (text_input) — bot configuration form
   - Notes: 

6. In security settings, choose Customize Keywords and add the keyword Alibaba Cloud EMON
   - Element: **Customize Keywords** (radio) — security settings
   - Notes: Add keyword: Alibaba Cloud EMON

7. Choose the service protocol and click **Complete**
   - Element: **Complete** (button) — bot configuration form
   - Notes: 

8. Copy the Webhook address by clicking **Copy** on the right side
   - Element: **Copy** (button) — right side of Webhook field
   - Notes: Save this address for use in Elasticsearch console

9. Go to Alert Management > **Contact Management** in the Elasticsearch console
   - Element: **Contact Management** (link) — Alert Management section
   - Notes: 

10. Click **Create New Contact** or **Edit Contact**
    - Element: **Create New Contact** (link) — Contact Management page
    - Notes: Alternatively, use Edit Contact if updating an existing one

11. Paste the copied Webhook address into the contact information field
    - Element: **contact information field** (text_input) — form field
    - Notes: Ensure the full Webhook URL is pasted correctly

| Parameter | Type | Required | Options/Values | Description |
|-----------|------|----------|----------------|-------------|
| Bot Name | text | Yes | — | Name of the DingTalk bot, e.g., Alibaba Cloud ES Monitoring |
| Security Settings | radio | Yes | None, Customize Keywords | Choose how to secure the bot; Customize Keywords allows setting a keyword for message filtering |
| Keyword | text | No | — | The keyword to be used for message filtering (e.g., Alibaba Cloud EMON) |
| Service Protocol | dropdown | Yes | HTTP, HTTPS | Protocol used for sending messages to the bot |

## FAQ

Q: Where can I find the API endpoint for my OpenSearch instance?
A: Navigate to the instance details page in the OpenSearch console, then go to the API endpoints tab to view and copy your API domain name.

Q: What happens if I leave the public access whitelist without saving?
A: Any IP addresses or CIDR ranges you entered will be lost. Always click Save to persist your whitelist configuration.

Q: Can I modify the instance name after creation?
A: The instance name can be modified in most cases, but the instance ID (automatically generated during creation) cannot be changed.

Q: What permissions do I need to view monitoring metrics as a RAM user?
A: Your administrator must grant you access through the Third-party Application Authorization page in the OpenSearch Vector Search Edition console.

Q: How do I add more Searcher workers when scaling shards?
A: If you don't have enough unused Searcher workers, you'll need to purchase additional workers through instance configuration modification before scaling shards.

## Pricing & Billing

### Billing Model
per_instance_hour

### Price Reference

| Tier | Input Price | Output Price | Other Price |
|------|-------------|--------------|-------------|
| Standard | 0.5 / | 0.6 / | — |
| HighPerformance | 1.2 / | 1.4 / | — |
| gpu.t4.16g.x1 | 0.8 / | — | — |
| ops.basic1.gi.large | 0.2 / | — | — |
| OpenSearch Retrieval Engine Edition | 0.002 / | — | — |
| general-purpose shared application (1 GB storage, 20 LCUs) | CNY 308.99/ | — | — |

### Free Tier
- Basic applications are free but limited to 2 per account and 1,000 search requests per day
- Monthly 100 tokens free for some services
- Monthly 100 hours free usage for some services
- Monthly 10 hours free trial quota

### Billing Notes
- Billing is based on usage per hour. Pay-as-you-go instances may be frozen due to overdue payments

- Reindexing operations may incur additional charges based on compute time and data volume
- Prices vary with different instance types. Upgrading from basic to shared incurs monthly charges. Downgrading is not supported