# Alibaba Cloud Open Search API

> Alibaba Cloud Open Search API on Apizie: 137 endpoints (Associates a custom analyzer with an Elasticsearch instance, Binds an Elasticsearch instance as a dependency, Compiles a sort script, Creates an experiment, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-opensearch`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/opensearch
- Page: https://zieapi.vercel.app/api/cloud/aliyun-opensearch
- OpenAPI: https://zieapi.vercel.app/api/cloud/aliyun-opensearch/openapi.json

Alibaba Cloud OpenAPI for Open Search (opensearch, version 2017-12-25). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Associates a custom analyzer with an Elasticsearch instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/bind-esuser-analyzer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The application name |
| esInstanceId | string | yes | The instance ID |
| body | object | no | The request body |

### Binds an Elasticsearch instance as a dependency
`POST https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/bind-es-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The name of the application |
| body | object | no | The request body |

### Compiles a sort script
`POST https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/compile-sort-script` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The name or ID of the application |
| scriptName | string | yes | The name of the script |
| appVersionId | string | yes | The version ID of the application |

### Creates an experiment
`POST https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/create-abtest-experiment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The name of the application |
| sceneId | string | yes | The scenario ID |
| groupId | string | yes | The group ID |
| dryRun | string | no | Specifies whether to verify the validity of the input parameters. Default value: false. Valid values: true: Verifies only the validity of… |
| name | string | no | The experiment alias |
| online | string | no | The experiment status. Valid values: true: Active. false: Inactive |
| params | object | no | The experiment parameters |
| serialNumber | integer | no | The experiment serial number automatically generated by Hyperspace |
| traffic | integer | no | The experiment bucketing percentage. Valid values: 0 to 100 |

### Creates an experiment group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/create-abtest-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The name of the application |
| sceneId | string | yes | The scenario ID |
| name | string | no | The alias of the experiment group |
| status | integer | no | The status of the experiment group. 0: Inactive. 1: Active |
| dryRun | string | no | Specifies whether to check the validity of the input parameters. The default value is false. Valid values: true: checks only the validity… |

### Creates an ABTest experiment scene
`POST https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/create-abtest-scene` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The application name |
| created | integer | no | The creation time |
| name | string | no | The scenario alias |
| status | integer | no | The scenario status. 0: Stops the experiment. 1: Starts the experiment |
| updated | integer | no | The last modification time |
| values | array | no | The scenario identifier |
| dryRun | string | no | Specifies whether to only validate the request parameters. Default value: false. Valid values: true: Only validates the request… |

### Creates an OpenSearch application version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/create-app` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The application name |
| dryRun | string | no | Specifies whether to perform a dry run for the creation. A dry run only checks whether the data source is valid. Valid values: true: Yes.… |
| autoSwitch | string | no | Specifies whether to automatically switch the new version online after it is created. Valid values: true: Yes. false: No |
| cluster | object | no | The capability exposure configuration |
| configItems | array | no | The list of configuration items in the request body |
| dataSources | array | no | The data source configuration |
| description | string | no | The version description |
| domain | object | no | The industry model |
| fetchFields | array | no | The default display field |
| firstRanks | array | no | The rough sort configuration |
| interpretations | array | no | The LLM table field description |
| networkType | string | no | The zone identifier. Valid values: vpc oxs |
| prompts | array | no | The prompt configuration |
| queryProcessors | array | no | The query intention recognition configuration |
| realtimeShared | string | no | Specifies whether to share the real-time stream |
| schema | object | no | The single-table application schema |
| schemas | array | no | The multi-table application schema |
| secondRanks | array | no | The fine sort configuration |
| summaries | array | no | The search result summary configuration |

### Creates an OpenSearch application
`POST https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/create-app-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| chargeType | string | no | The billing method. Valid values: POSTPAY: pay-as-you-go. PREPAY: subscription |
| name | string | no | The name of the application |
| order | object | no | The subscription period information |
| quota | object | no | The quota |
| resourceGroupId | string | no | The ID of the resource group to which the instance belongs |
| tags | array | no | The list of tags |
| type | string | no | The application type. Valid values: standard: Standard Edition. enhanced: Advanced Edition |
| dryRun | string | no | Specifies whether to only validate the application creation request without actually placing an order or creating the application. Default… |

### Creates an access credential for a specified application group on demand and supports the dry run mode to…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/create-app-group-credentials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| dryRun | string | no | Specifies whether this operation is a dry run. A dry run only checks the parameters and does not actually perform the operation |
| type | string | no | The credential type, such as api-key, account, invoke-key, or api-token. To create an api-key, set this parameter to api-token |
| appGroupIdentity | string | yes | The application group identifier |

### Creates an elastic plan
`POST https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/create-elastic-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The application name, application ID, or instance ID |
| dryRun | string | no | Specifies whether to perform a pre-creation validation. Valid values: true: Performs validation only. false: Does not perform validation |
| customDates | array | no | The list of days of the week |
| description | string | no | The description |
| elasticLcu | integer | no | The elastic incremental LCU. The value must be greater than 0 and less than or equal to min(baseLcu × 0.5, 50000) |
| endHour | integer | no | The end time of the elastic plan |
| name | string | no | The plan name |
| scheduleType | string | no | The task scheduling type |
| startHour | integer | no | The start time of the elastic plan |

### Creates a rough sort expression configuration for an OpenSearch application version. When dryRun is set to…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/create-first-rank` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| dryRun | string | no | Specifies whether the request is a dry run |
| appGroupIdentity | string | yes | The name of the application |
| appId | string | yes | The version number |
| active | string | no | Specifies whether the expression is the default expression |
| description | string | no | The description |
| meta | string | no | The expression information |
| name | string | no | The name |
| type | string | no | The expression type (STRUCT, STRING) |

### Creates an algorithm instance for a specified feature
`POST https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/create-function-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| createParameters | array | no | The creation parameters |
| cron | string | no | The periodic training |
| description | string | no | The instance description |
| functionType | string | no | The feature type |
| instanceName | string | yes | The instance name |
| modelType | string | yes | The model type |
| usageParameters | array | no | The usage parameters |
| appGroupIdentity | string | yes | The application name |
| functionName | string | yes | The feature name. Supported models: CTR model: ctr Popularity model: pop Category model: category Hot word model: hot Hint model: hint… |

### Creates an algorithm resource under a specified feature
`POST https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/create-function-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The application ID |
| functionName | string | yes | The feature name |
| data | object | no | The resource data. The data structure varies based on the resource type |
| description | string | no | The resource description |
| resourceName | string | no | The resource name |
| resourceType | string | no | The resource type |

### Starts a training task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/create-function-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The application name |
| functionName | string | yes | The feature name |
| instanceName | string | yes | The instance name |

### Creates an intervention dictionary
`POST https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/create-intervention-dictionary` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| dryRun | string | no | Specifies whether to validate the input data. Default value: false. Valid values: true: Validates only the parameters. false: Validates… |
| analyzerType | string | no | The analyzer type. Valid values: MODEL: model-customized analyzer. SYSTEM: system analyzer. USER: custom analyzer |
| name | string | no | The name of the intervention dictionary |
| type | string | no | The type of the intervention dictionary. Valid values: stopword: stop words. synonym: synonyms. correction: spelling correction.… |

### Creates a query analysis rule. If dryRun is set to true, the system validates the query analysis rule. The…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/create-query-processor` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The application name |
| appId | string | yes | The version number |
| dryRun | string | no | Specifies whether the request is a dry run |
| body | string | no | The request body |

### Creates a scheduled task for an OpenSearch application
`POST https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/create-scheduled-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The application name |
| appStrategy | string | no | The policy used when creating a new application version. Valid values: delete-idle: Deletes offline versions first. need-slot: Creates a… |
| autoSwitch | string | no | Specifies whether automatic switchover to online is enabled |
| cron | string | no | The time expression |
| enabled | string | no | Specifies whether to execute the task |
| filter | object | no | The cleanup configuration |
| forkedAppId | string | no | The ID of the previous version |
| permanent | string | no | Specifies whether persistence is enabled |
| runNow | string | no | Specifies whether to execute the task immediately |
| type | string | no | The task type |
| version | string | no | The version number to delete |

### Creates a search strategy
`POST https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/create-search-strategy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The application name |
| appId | string | yes | The version number |
| description | string | no | The strategy description |
| isDefault | string | no | Specifies whether to set as the default |
| mergeConfig | object | no | The merge sort configuration |
| name | string | no | The strategy name |
| searchConfigs | array | no | The search strategy |

### Validates the fine sort expression when dryRun is set to true. The default value of dryRun is false
`POST https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/create-second-rank` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The application name |
| appId | string | yes | The version number |
| dryRun | string | no | Specifies whether the request is a dry run |
| active | string | no | Specifies whether the expression is the default expression |
| description | string | no | The description |
| meta | string | no | The expression |
| name | string | no | The name |

### Creates a sort script
`POST https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/create-sort-script` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The name or ID of the application |
| appVersionId | string | yes | The ID of the report under the application |
| description | string | no | The description of the script |
| scope | string | no | The scope of the script |
| scriptName | string | no | The name of the script |
| type | string | no | The type of the script. Currently, only cava_script is supported |

### Creates a custom analyzer
`POST https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/create-user-analyzer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| business | string | no | The name of the basic analyzer |
| businessAppGroupId | string | no | The application ID for the custom model-based analyzer |
| businessType | string | no | The type of the basic analyzer. Valid values: AUTO, MODEL, SYSTEM, and USER |
| name | string | no | The name of the analyzer |
| type | string | no | The engine type. Valid values: HA3 and ES |
| dryRun | string | no | Specifies whether to perform a dry run. Valid values: true: sends a check request without creating the analyzer. The system checks the… |

### Deletes an experiment
`POST https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/delete-abtest-experiment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The application name |
| sceneId | string | yes | The scenario ID |
| groupId | string | yes | The group ID |
| experimentId | string | yes | The experiment ID |

### Deletes an ABTest experiment group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/delete-abtest-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The application name |
| sceneId | string | yes | The scenario ID |
| groupId | string | yes | The group ID |

### Deletes an ABTest experiment scenario
`POST https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/delete-abtest-scene` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The name or ID of the application |
| sceneId | string | yes | The scenario ID |

### Deletes an algorithm instance. Ensure that the instance is not in use before deletion to avoid affecting…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/delete-function-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The name of the OpenSearch application |
| functionName | string | yes | The name of the feature |
| instanceName | string | yes | The name of the instance |

### Deletes a specified algorithm resource
`POST https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/delete-function-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The application ID |
| functionName | string | yes | The feature name |
| resourceName | string | yes | The resource name |

### Deletes a training record. Records that are currently being trained cannot be deleted
`POST https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/delete-function-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The application name |
| functionName | string | yes | The feature name |
| instanceName | string | yes | The instance name |
| generation | string | yes | The iteration count |

### Deletes a sort script
`POST https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/delete-sort-script` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The name or ID of the application |
| scriptName | string | yes | The name of the script |
| appVersionId | string | yes | The ID of the application version |

### Deletes a script file
`POST https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/delete-sort-script-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The application name |
| appVersionId | string | yes | The version ID |
| scriptName | string | yes | The script name |
| fileName | string | yes | The name of the script file to delete |

### Retrieves the details of an experiment
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/describe-abtest-experiment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The application name |
| sceneId | string | yes | The scenario ID |
| groupId | string | yes | The group ID |
| experimentId | string | yes | The experiment ID |

### Retrieves the details of an A/B test group
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/describe-abtest-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The name of the application |
| sceneId | string | yes | The ID of the scene |
| groupId | string | yes | The ID of the group |

### Gets details of an A/B test scenario
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/describe-abtest-scene` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The name or ID of the application |
| sceneId | string | yes | The ID of the test scenario |

### Retrieves the details of an OpenSearch application version
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/describe-app` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The application name |
| appId | string | yes | The version ID |

### Queries the details of an OpenSearch application
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/describe-app-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The name of the application |

### Queries the statistics about a version of an OpenSearch application
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/describe-app-statistics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The name of the application |
| appId | string | yes | The version number of the application |

### Retrieves the versions of an OpenSearch application
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/describe-apps` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The name of the application |

### Retrieves the details of a data collection for a specified application
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/describe-data-collction` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The name of the application |
| dataCollectionIdentity | string | yes | The ID of the data collection |

### Retrieves the details of an elastic plan
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/describe-elastic-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The name or ID of the application |
| planId | string | yes | The ID of the alert plan |
| dryRun | string | no | Specifies whether to only validate the request parameters. Default value: false. Valid values: true: Only validates the parameters. false:… |

### Queries the rough sort expression configuration of an OpenSearch application version
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/describe-first-rank` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The name of the application |
| appId | string | yes | The version number |
| name | string | yes | The name of the rough sort expression |

### Retrieves the details of an intervention dictionary
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/describe-intervention-dictionary` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| name | string | yes | The name of the intervention dictionary |

### Retrieves the list of query analysis rules for a specified OpenSearch application version
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/describe-query-processor` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The application name |
| appId | string | yes | The version number |
| name | string | yes | The rule name |

### Retrieves the endpoints for all regions
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/describe-regions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |

### Query a scheduled task for an OpenSearch application
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/describe-scheduled-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The name of the application |
| taskId | string | yes | The ID of the task |

### Queries the fine sort expression configuration of an OpenSearch application version
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/describe-second-rank` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The application name |
| appId | string | yes | The version number |
| name | string | yes | The fine sort expression name |

### Queries the status of the slow query feature
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/describe-slow-query-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The application name |

### Retrieves the details of a custom analyzer
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/describe-user-analyzer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| name | string | yes | The name of the analyzer |
| with | string | no | Specifies related information to return. The properties are returned based on the specified level. all: Returns information about the… |

### Disables the slow query service for Search Diagnoser
`POST https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/disable-slow-query` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The name of the application |

### Enables the slow query service for the optimizer
`POST https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/enable-slow-query` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The application name |

### Gets a merged wide table
`POST https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/generate-merged-table` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| spec | string | no | The specification of the target version. This parameter is used to check the special limits for an exclusive instance. Default value:… |
| indexSortConfig | array | no | The inverted index configuration |
| indexes | object | no | The index configuration |
| name | string | no | The wide table name |
| routeField | string | no | The level-1 routing field name |
| routeFieldValues | array | no | The list of hot values for the level-1 routing field (enables level-2 routing when configured) |
| secondRouteField | string | no | The level-2 routing field name. This field takes effect only when `routeFieldValues` is configured. By default, the primary key of the… |
| tables | object | no | The user data table |
| ttlField | object | no | The document cleanup configuration |

### Retrieves the industry type
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/get-domain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| domainName | string | yes | The industry type |
| appGroupIdentity | string | yes | The name or ID of the application |

### Retrieves the version information used when creating an instance for the current feature
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/get-function-current-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| functionName | string | yes | The feature name. Supported models: CTR model: ctr Popularity model: pop Category model: category Hot word model: hot Hint model: hint… |
| modelType | string | yes | The model type. The model types corresponding to different features are as follows: CTR model: tf_checkpoint Popularity model: pop… |
| functionType | string | no | The feature type. Valid values: PAAS (default) SAAS |
| domain | string | no | The industry. Default value: empty, which indicates the General-purpose Edition |
| category | string | no | The vertical category. Default value: empty |

### Retrieves the default algorithm instance used by the application
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/get-function-default-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The name of the application |
| functionName | string | yes | The name of the feature |

### Retrieves the details of an instance by instance name
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/get-function-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The application name |
| functionName | string | yes | The feature name |
| instanceName | string | yes | The instance name |
| output | string | no | Specifies the level of detail in the response. Valid values: simple: Returns only basic information. normal: Returns information such as… |

### Retrieves the algorithm resource with the specified name
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/get-function-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The application ID |
| functionName | string | yes | The feature name |
| resourceName | string | yes | The instance name |
| output | string | no | The output level |

### Retrieves the training details
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/get-function-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The application name |
| functionName | string | yes | The feature name |
| instanceName | string | yes | The instance name |
| generation | string | yes | The number of iterations |

### Retrieves version information based on the version ID
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/get-function-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| functionName | string | yes | The feature name |
| versionId | string | yes | The version ID |

### Retrieves the names of all files in a specified script for a specific application version
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/get-script-file-names` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The name or ID of the application |
| appVersionId | string | yes | The ID of the application version |
| scriptName | string | yes | The name of the script |

### Retrieves the details of a search strategy
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/get-search-strategy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The application group ID |
| appId | string | yes | The application version |
| strategyName | string | yes | The strategy name |

### Retrieves the details of a sort script
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/get-sort-script` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The name or ID of the application |
| scriptName | string | yes | The name of the script |
| appVersionId | string | yes | The ID of the application version |

### Retrieves the content of a sort script
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/get-sort-script-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The name or ID of the application |
| scriptName | string | yes | The name of the script |
| appVersionId | string | yes | The ID of the application version |
| fileName | string | yes | The name of the script file |

### Lists the experiments
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/list-abtest-experiments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The application name |
| sceneId | string | yes | The scenario ID |
| groupId | string | yes | The group ID |

### Retrieves the whitelist
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/list-abtest-fixed-flow-dividers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The application name |
| sceneId | string | yes | The scenario ID |
| groupId | string | yes | The group ID |
| experimentId | string | yes | The experiment ID |

### Retrieves a list of test groups
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/list-abtest-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The application name |
| sceneId | string | yes | The scenario ID |

### Lists A/B test scenarios
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/list-abtest-scenes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The name of the application |

### Queries a list of OpenSearch applications
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/list-app-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| pageNumber | integer | no | The page number. Default value: 1 |
| pageSize | integer | no | The number of entries to return on each page. Default value: 10 |
| instanceId | string | no | The instance ID. Exact match is used |
| name | string | no | The name of the application |
| type | string | no | The application type. Valid values: standard: Standard Edition. enhanced: New Advanced Edition |
| sortBy | integer | no | The sort order. Valid values: 0: Sorts by creation time in descending order. 1: Sorts by modification time in descending order. Default… |
| resourceGroupId | string | no | The ID of the resource group |
| tags | string | no | The list of tags (JSON-encoded) |

### Retrieves the data collection checklist of an OpenSearch application
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/list-data-collections` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The application name |
| pageNumber | integer | no | The page number. Default value: 1 |
| pageSize | integer | no | The number of entries to return on each page. Default value: 10 |

### Retrieves all fields of a specified data table. This is an internal API operation
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/list-data-source-table-fields` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| dataSourceType | string | yes | The data source type. Valid values: rds polardb odps mysql drds |
| params | string | yes | The data source parameters. This is a JSON string that must be URL-encoded. The parameters vary by data source. For more information,… |
| rawType | string | no | Specifies whether to return the original field types of the data source |
| zoneId | string | no | The ID of the zone where the destination data source resides |

### Retrieves all data from the specified data source
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/list-data-source-tables` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| dataSourceType | string | yes | The data source type. Valid values: rds polardb odps mysql drds |
| params | string | yes | The data source parameters. This is a JSON string and must be URL-encoded. Parameters vary by data source. For more information, see:… |
| zoneId | string | no | The ID of the zone where the target data source resides |

### Retrieves a list of elastic plans
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/list-elastic-plans` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The application name |
| name | string | no | The elastic plan name |
| enabled | string | no | Specifies whether the elastic plan is enabled. Valid values: true: Enabled. false: Disabled |
| pageNumber | integer | no | The page number. Default value: 1 |
| pageSize | integer | no | The number of entries per page. Default value: 10 |
| nextToken | string | no | The token for the next query |
| maxResults | integer | no | The maximum number of records to retrieve in a single request |

### Retrieves the list of rough sort configurations for a specified OpenSearch application version
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/list-first-ranks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The application name |
| appId | string | yes | The version number |

### Queries all instances that belong to the user and match the specified conditions
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/list-function-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The application name |
| functionName | string | yes | The feature name |
| modelType | string | no | The model type |
| functionType | string | no | The feature type |
| source | string | no | The instance source. Valid values: builtin: System instance. user: User instance. This is the default value. all: All instances |
| pageNumber | integer | no | The page number. Default value: 1 |
| pageSize | integer | no | The number of entries per page. Default value: 10 |
| output | string | no | The detail level of the response. Valid values: normal: displays information such as createParameters and cron. This is the default value.… |

### Retrieves a list of algorithm resources
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/list-function-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The application ID |
| functionName | string | yes | The feature name |
| resourceType | string | no | The resource type |
| output | string | no | The output level |
| pageNumber | integer | no | The page number |
| pageSize | integer | no | The page size |

### Retrieves training records. The returned results are sorted in descending order by start time
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/list-function-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The application name |
| functionName | string | yes | The feature name |
| instanceName | string | yes | The instance name |
| status | string | no | The task status. Valid values: success failed running |
| startTime | integer | no | The start time. Only records with a start time later than the specified time are returned. Unit: milliseconds |
| endTime | integer | no | The end time. Only records with an end time earlier than the specified time are returned. Unit: milliseconds |
| pageNumber | integer | no | The page number. Default value: 1 |
| pageSize | integer | no | The number of entries per page. Default value: 1 |

### Retrieves the intervention dictionary list for a user
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/list-intervention-dictionaries` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| pageSize | integer | no | The number of entries to return on each page. Default value: 10 |
| pageNumber | integer | no | The page number. Default value: 1 |
| types | string | no | The collection of intervention dictionary types. Format: urlencode(["synonym", "stopword"]) Valid values: stopword: stop word synonym:… |
| aclAuthorities | string | no | The aclAuthorities |
| excludeUnauthorized | string | no | The excludeUnauthorized |

### Retrieves the intervention entry list
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/list-intervention-dictionary-entries` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| name | string | yes | The name of the intervention dictionary |
| word | string | no | The intervention entry |
| pageNumber | integer | no | The page number. Default value: 1 |
| pageSize | integer | no | The number of entries to return on each page. Default value: 10 |

### Retrieves the Named Entity Recognition results
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/list-intervention-dictionary-ner-results` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| name | string | yes | The name of the intervention dictionary |
| query | string | yes | The keyword to search for |
| analyzerType | string | no | The type of the analyzer used for Named Entity Recognition. Valid values: MODEL, SYSTEM, and USER. If you set this parameter to AUTO, the… |
| analyzerGeneration | string | no | The generation of the analyzer used for Named Entity Recognition |

### Retrieves the list of resources associated with an intervention dictionary. If the intervention dictionary…
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/list-intervention-dictionary-related-entities` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| name | string | yes | The name of the intervention dictionary |

### Queries the current processing flow
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/list-proceedings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The application group ID |
| filterFinished | string | no | Specifies whether to filter out completed tasks |

### Tests the query analysis effectiveness. (Only applicable to existing applications of the open-source…
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/list-query-processor-analyzer-results` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The application name |
| appId | string | yes | The version number |
| name | string | yes | The rule name |
| text | string | yes | The content to be tested |
| operator | string | no | The operator. Valid values: AND and OR |

### Retrieves the recommended entity type importance settings for Named Entity Recognition
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/list-query-processor-ners` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| domain | string | no | The industry type. Valid values: ECOMMERCE: E-commerce |
| category | string | no | The industry vertical |

### Queries the query analysis rules for a specified OpenSearch application version
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/list-query-processors` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The application name |
| appId | string | yes | The version number |
| isActive | integer | no | Specifies whether the rule is set as the default rule. Default value: 0. Valid values: 0: Queries all rules. 1: Queries rules that are set… |

### Lists the quota approval tickets for a specified OpenSearch application
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/list-quota-review-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The name of the application group |
| pageNumber | integer | no | The page number. The default value is 1 |
| pageSize | integer | no | The number of entries to return on each page. The default value is 10 |

### Retrieves a list of scheduled tasks for an OpenSearch application
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/list-scheduled-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The name of the application |
| type | string | no | The type of the scheduled task. Valid values: wipe: data cleanup fork: index rebuild check-status: application status check index: index… |
| pageNumber | integer | no | The page number. Default value: 1 |
| pageSize | integer | no | The number of entries to return on each page. Default value: 10 |

### Retrieves the details of query policies
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/list-search-strategies` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The name of the application |
| appId | string | yes | The ID of the application version |

### Lists the fine sort expressions for a specific version of an OpenSearch application
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/list-second-ranks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The name or ID of the application group |
| appId | string | yes | The version number |

### Lists the slow query optimization suggestions provided by Optimization Master
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/list-slow-query-categories` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The application name |

### Lists the slow queries in Optimization Master
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/list-slow-query-queries` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The application name |
| categoryIndex | string | yes | The optimization suggestion ID |

### Retrieves a list of sort expressions for an application version
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/list-sort-expressions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The application name |
| appId | string | yes | The version ID |

### Lists all sort scripts for a specified application version
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/list-sort-scripts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The name or ID of the application |
| appVersionId | string | yes | The ID of the application version |

### Queries log statistics, such as application error logs, hot word lists, and slow query logs
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/list-statistic-logs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The application name |
| moduleName | string | yes | The module name. Valid values: hot: hot word list error: application log slow-log: slow query log Currently, only hot is supported |
| startTime | integer | no | The start time. Default value: the timestamp of 00:00:00 on the current day |
| endTime | string | no | The end time. Default value: the timestamp of 24:00:00 on the current day |
| pageNumber | integer | no | The page number. Default value: 1 |
| pageSize | integer | no | The number of entries to return on each page. Default value: 10 |
| query | string | no | The content of the query clause |
| sortBy | string | no | The content of the sort clause |
| distinct | string | no | Specifies whether to use the distinct clause |
| columns | string | no | The fields to query. Format: columns=wordsTopPv. For more information, see https://help.aliyun.com/document_detail/187665.html |

### Queries statistical reports, such as application, drop-down suggestion, top search hint, A/B test, and data…
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/list-statistic-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The name of the application |
| moduleName | string | yes | The name of the module. This is an enumeration. Valid values: app: Operations report. app-query: Operations report > Query analysis… |
| startTime | integer | no | The start timestamp, in seconds |
| endTime | integer | no | The end timestamp, in seconds. The default value is the current timestamp |
| pageNumber | integer | no | The page number. Default value: 1 |
| pageSize | integer | no | The number of entries to return on each page. Default value: 10 |
| columns | string | no | The fields to query. Specify the fields in the columns="pv,uv,ipv" format. For more information, see… |
| query | string | no | The query conditions, in the k1:v1,k2:v2 format. Valid values: experimentSerialNumber: the globally unique serial number of the… |

### Queries the tags of specified resources
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/list-tag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| resourceType | string | yes | The resource type |
| resourceId | string | no | The resource IDs. You can specify a maximum of 50 resource IDs (JSON-encoded) |
| tag | string | no | The tags to query. The list can contain a maximum of 20 tags (JSON-encoded) |
| nextToken | string | no | The token to start the next query |

### Retrieves the list of custom analyzer entries
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/list-user-analyzer-entries` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| name | string | yes | The name of the analyzer |
| word | string | no | The entry key |
| pageNumber | integer | no | The page number. Default value: 1 |
| pageSize | integer | no | The number of entries to return on each page. Default value: 10 |

### Retrieves the list of custom tokenizers for a user
`GET https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/list-user-analyzers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| pageNumber | integer | no | The page number. Default value: 1 |
| pageSize | integer | no | The number of entries to return on each page. Default value: 10 |

### Modifies the attributes of an OpenSearch application or sets the online version of the application
`POST https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/modify-app-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The name of the application |
| currentVersion | string | no | The online version |
| description | string | no | The description |
| domain | string | no | The industry type. Valid values: general: General industry. ecommerce: E-commerce industry. education: Education industry. esports: Gaming… |
| resourceGroupId | string | no | The ID of the resource group to which the instance belongs |
| dryRun | string | no | Specifies whether to perform a pre-upgrade check. A value of true indicates that a check is performed. A value of false indicates that no… |

### Modifies the quota of an OpenSearch application
`POST https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/modify-app-group-quota` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The name of the application |
| clientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure… |
| dryRun | string | no | Specifies whether to check the validity of the input parameters. Default value: false. Valid values: true: checks only the validity of the… |
| computeResource | integer | no | 计算资源 (单位:LCU) |
| docSize | integer | no | 存储容量 (单位:GB) |
| orderType | string | no | 变配类型 |
| spec | string | no | 规格 |

### Updates an elastic plan
`POST https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/modify-elastic-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The application name |
| planId | string | yes | The elastic plan ID |
| dryRun | string | no | Specifies whether to validate the request parameters. Default value: false. Valid values: true false |
| customDates | array | no | The list of days of the week |
| description | string | no | The description |
| elasticLcu | integer | no | The elastic incremental LCU |
| enabled | string | no | Specifies whether the plan is enabled |
| endHour | integer | no | The end time of the elastic plan |
| scheduleType | string | no | The task scheduling type |
| startHour | integer | no | The start time of the elastic plan |

### Modifies the rough sort expression configuration of an OpenSearch application version. If dryRun is set to…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/modify-first-rank` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| dryRun | string | no | Specifies whether the request is a dry run |
| appGroupIdentity | string | yes | The application name |
| appId | string | yes | The version number |
| name | string | yes | The name of the rough sort expression |
| active | string | no | Specifies whether the expression is the default expression |
| description | string | no | The description |
| meta | string | no | The expression information |
| type | string | no | The expression type (STRUCT, STRING) |

### Modifies the query analysis rules of a specified application version. If dryRun is set to true, the query…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/modify-query-processor` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The name of the application |
| appId | string | yes | The version number |
| dryRun | string | no | Specifies whether the request is a dry run |
| name | string | yes | The name of the rule |
| body | string | no | The request body |

### Modifies a scheduled task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/modify-scheduled-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The name or ID of the application |
| taskId | string | yes | The task ID |
| appStrategy | string | no | The policy used when creating a new application version. Valid values: delete-idle: Deletes offline versions first. need-slot: Creates a… |
| autoSwitch | string | no | Specifies whether automatic switchover to online is enabled |
| cron | string | no | The time expression |
| enabled | string | no | Specifies whether to execute the task |
| filter | object | no | The cleanup configuration |
| forkedAppId | string | no | The ID of the previous version |
| permanent | string | no | Specifies whether persistence is enabled |
| runNow | string | no | Specifies whether to execute the task immediately |
| type | string | no | The task type |
| version | string | no | The version number to delete |

### Modifies a fine sort expression for an OpenSearch application version. If you set `dryRun` to `true`, the…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/modify-second-rank` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The name of the application group |
| appId | string | yes | The version number |
| name | string | yes | The name of the fine sort expression |
| dryRun | string | no | Specifies whether to perform a dry run |
| active | string | no | Specifies whether the expression is the default expression |
| description | string | no | The description |
| meta | string | no | The expression |

### Accepts intervention entry changes
`POST https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/push-intervention-dictionary-entries` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| name | string | yes | The name of the intervention dictionary |
| dryRun | string | no | Specifies whether to validate the input data. Default value: false. Valid values: true: Validates only the parameters. false: Validates… |
| body | array | no | The request body |

### Applies changes to the entries of a custom analyzer
`POST https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/push-user-analyzer-entries` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| name | string | yes | The name of the analyzer |
| dryRun | string | no | Specifies whether to perform a dry run. This parameter is only used to check whether the data source is valid. Valid values: true and false |
| entries | array | no | The entries of the custom analyzer |

### Publishes a sort script
`POST https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/release-sort-script` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The name or ID of the application |
| scriptName | string | yes | The name of the script |
| appVersionId | string | yes | The version ID of the application |

### Deletes a version of an OpenSearch application
`POST https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/remove-app` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The name or ID of the application group |
| appId | string | yes | The ID of the application version |

### Deletes an OpenSearch application
`POST https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/remove-app-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The name of the application |

### Disables data collection
`POST https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/remove-data-collection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The application name |
| dataCollectionIdentity | string | yes | The data collection ID |

### Retrieves the details of an elastic plan
`POST https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/remove-elastic-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The application name |
| planId | string | yes | The elastic plan ID |

### Deletes the rough sort configuration of a specified OpenSearch application version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/remove-first-rank` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The application name |
| appId | string | yes | The version number |
| name | string | yes | The name of the rough sort expression |

### Deletes an intervention dictionary
`POST https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/remove-intervention-dictionary` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| name | string | yes | The name of the intervention dictionary |

### Deletes a query analysis rule for a specified OpenSearch application version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/remove-query-processor` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The application name |
| appId | string | yes | The version number |
| name | string | yes | The rule name |

### Deletes a scheduled task from an OpenSearch application
`POST https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/remove-scheduled-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The name of the application |
| taskId | string | yes | The task ID |

### Deletes a search strategy
`POST https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/remove-search-strategy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The application name |
| appId | string | yes | The version number |
| strategyName | string | yes | The strategy name |

### Deletes a fine sort expression from a version of an OpenSearch application
`POST https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/remove-second-rank` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The name of the application |
| appId | string | yes | The version number |
| name | string | yes | The name of the fine sort expression |

### Deletes a custom analyzer
`POST https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/remove-user-analyzer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| name | string | yes | The name of the analyzer |

### Renews an application. This API operation is unavailable. To renew an application, use the OpenSearch console
`POST https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/renew-app-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The name of the application |
| clientToken | string | no | The client token that is used to ensure the idempotence of the request |
| autoRenew | string | no | Specifies whether to enable auto-renewal |
| duration | integer | no | The duration |
| pricingCycle | string | no | The pricing cycle. Valid values: Year Month |

### Converts a service-based application to an instance-based application
`POST https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/replace-app-group-commodity-code` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The name of the application |

### Uploads the content of a sort script
`POST https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/save-sort-script-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The name or ID of the application |
| scriptName | string | yes | The name of the script to update |
| appVersionId | string | yes | The version ID of the application |
| fileName | string | yes | The file name |
| content | string | no | The script content, in Base64 encoding |
| version | integer | no | The version of the script content |

### Starts a slow query analysis task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/start-slow-query-analyzer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| appGroupIdentity | string | yes | The name of the application |

### Adds tags to resources
`POST https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/tag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://opensearch.ap-southeast-1.aliyuncs.com |
| resourceId | array | yes | The IDs of the resources. You can specify up to 50 resource IDs |
| resourceType | string | yes | The resource type |
| tag | array | yes | The tags to add to the resources. You can add up to 20 tags |

…and 17 more. See the OpenAPI spec.

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/bind-esuser-analyzer" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Open Search API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-opensearch/bind-esuser-analyzer with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud Open Search API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud Open Search itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud Open Search API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-opensearch.

### What is the status of the Alibaba Cloud Open Search API?
Needs your own provider key (bring your own key)