# Alibaba Cloud SearchEngine API

> Alibaba Cloud SearchEngine API on Apizie: 115 endpoints (Rebuilds an index, Changes the resource group of an instance, Clones an SQL instance, Creates an alias, …) 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://apizie.tech/v1/cloud:aliyun-searchengine/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-searchengine`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/searchengine
- Page: https://apizie.tech/api/cloud/aliyun-searchengine
- OpenAPI: https://apizie.tech/api/cloud/aliyun-searchengine/openapi.json

Alibaba Cloud OpenAPI for SearchEngine (searchengine, version 2021-10-25). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Rebuilds an index
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/build-index` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The ID of the instance |
| buildMode | string | no | The method to rebuild the index. Valid values: api and indexRecover |
| dataSourceName | string | no | The name of the data source |
| dataSourceType | string | no | The type of the data source |
| dataTimeSec | integer | no | The UNIX timestamp in seconds. This parameter is an integer. This parameter is required if data is pushed to the data source using an API |
| domain | string | no | The data center of the data source |
| generation | integer | no | The backfill ID |
| partition | string | no | Required if dataSourceType is set to odps |
| path | string | no | The relative path |
| tag | string | no | The tag of the Data Lake Formation (DLF) data source |

### Changes the resource group of an instance
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/change-resource-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| newResourceGroupId | string | no | The ID of the new resource group |
| resourceType | string | no | The resource type |

### Clones an SQL instance
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/clone-sql-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| database | string | yes | The database name |
| sqlInstanceId | string | yes | The SQL instance ID |
| name | string | yes | The name |
| targetFolderId | integer | yes | The ID of the target folder |

### Creates an alias
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/create-alias` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| newMode | string | no | Specifies whether the new version of the console page is used |
| alias | string | no | The alias |
| index | string | no | The associated index |

### Add a cluster
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/create-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| autoLoad | string | no | Specifies whether to automatically mount the cluster |
| dataNode | object | no | The details of the data node |
| description | string | no | The cluster description |
| name | string | no | The cluster name |
| queryNode | object | no | The details of the query node |

### Creates a file directory in an advanced configuration
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/create-config-dir` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| configName | string | yes | The configuration name |
| dirName | string | no | The directory name |
| parentFullPath | string | no | The parent file path |

### Creates a file with advanced configurations
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/create-config-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| configName | string | yes | The configuration name |
| fileName | string | no | The directory name |
| ossPath | string | no | The OSS storage address |
| parentFullPath | string | no | The parent file path |

### Creates a data source
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/create-data-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| dryRun | string | no | Specifies whether to perform a dry run to create the data source. A dry run only validates whether the data source is valid. Valid values:… |
| autoBuildIndex | string | no | Specifies whether to automatically rebuild the index |
| config | object | no | The configuration information |
| domain | string | no | The data center of the data source |
| name | string | no | The name of the data source |
| saroConfig | object | no | The saro datasource config |
| type | string | no | The type of the data source. Valid values: odps, oss, and swift |

### Creates a folder
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/create-folder` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| database | string | yes | The database name |
| name | string | yes | The folder name |
| parent | integer | yes | The parent category ID (required). If left empty, the default value is 1 |
| type | string | yes | table, instance, template, function |

### Creates an index
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/create-index` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| buildParallelNum | integer | no | The concurrency for full index building |
| content | string | no | The index schema |
| dataSource | string | no | The name of the data source |
| dataSourceInfo | object | no | Information about the data source. This parameter is required for new versions of Vector Search Edition |
| domain | string | no | The data center of the data source |
| extend | object | no | The extended field configuration. key: The field type. Valid values: \`vector\` (vector field), \`embeding\` (field that requires… |
| mergeParallelNum | integer | no | The concurrency for full index merging |
| name | string | no | The name of the index |
| partition | integer | no | The number of data shards |
| dryRun | string | no | Specifies whether to perform a dry run. A dry run only checks whether the data source is valid. Valid values: true false |

### Creates a Wentian Engine instance
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/create-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| chargeType | string | no | The billing method of the instance. Valid values: PREPAY: subscription. If you select this billing method, make sure that your account… |
| components | array | no | The list of specifications for the instance |
| order | object | no | The payment information |
| resourceGroupId | string | no | The ID of the resource group |
| tags | array | no | The list of instance tags |

### Creates a model
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/create-model` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| dryRun | string | no | Specifies whether to perform only a dry run. The default value is false |
| content | object | no | The model details |
| name | string | yes | The model name |

### Enables the public domain name
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/create-public-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |

### Creates an SQL instance
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/create-sql-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| database | string | yes | The database name |
| name | string | yes | The SQL instance name |
| parent | integer | yes | The unique identifier of the parent work item |

### Creates an index table
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/create-table` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| dryRun | string | no | Specifies whether to perform a dry run (only validates whether the data source is valid). Valid values: true: performs a dry run. false:… |
| dataProcessConfig | array | no | The field processing configuration |
| dataProcessorCount | integer | no | The number of data update resources |
| dataSource | object | no | The datasource config |
| fieldSchema | object | no | The field schema. The key is the field name |
| name | string | no | The index name |
| partitionCount | integer | no | The number of data shards |
| primaryKey | string | no | The primary key field |
| rawSchema | string | no | The raw schema. If you specify this parameter, the value is used directly as the HA3 schema structure without manual assembly |
| scene | string | no | The template type |
| vectorIndex | array | no | The index structure |

### Debugs a model
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/debug-model` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| modelName | string | yes | The name of the model |
| isOnline | string | no | Specifies whether to perform an online query. Set this parameter to true to use the search configuration. Set this parameter to false to… |
| input | string | no | The input of the model |

### Deletes an advanced configuration
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/delete-advance-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| configName | string | yes | The configuration name |

### Deletes an alias
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/delete-alias` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| alias | string | yes | The alias |

### Deletes an advanced configuration folder
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/delete-config-dir` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| configName | string | yes | The configuration name |
| dirName | string | yes | The folder name |
| parentFullPath | string | yes | The path of the parent folder |

### Deletes an advanced configuration file
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/delete-config-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| configName | string | yes | The configuration name |
| fileName | string | yes | The file name |
| parentFullPath | string | yes | The path of the parent directory |

### Deletes a specified data source
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/delete-data-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| dataSourceName | string | yes | The name of the data source |

### Deletes a folder
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/delete-folder` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| database | string | yes | The database name |
| folderId | string | yes | The folder ID |

### Deletes an index
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/delete-index` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| indexName | string | yes | The index name |
| dataSource | string | yes | The data source |
| deleteDataSource | string | no | Specifies whether to delete the data source |

### Deletes the version of an index
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/delete-index-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| indexName | string | yes | The index name |
| versionName | string | yes | The name of the version |

### Deletes a specified instance
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/delete-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |

### Deletes a model
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/delete-model` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| modelName | string | yes | The name of the model |

### Deletes a public domain name
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/delete-public-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |

### Deletes an SQL instance
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/delete-sql-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| database | string | yes | The database name |
| sqlInstanceId | string | yes | The SQL instance ID |

### Delete an index table
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/delete-table` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| tableName | string | yes | The name of the index table |

### Queries available regions
`GET https://apizie.tech/v1/cloud:aliyun-searchengine/describe-regions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| acceptLanguage | string | no | The language of the response. Default value: zh-cn |

### Executes a SQL instance
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/execute-sql-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| database | string | yes | The database name |
| sqlInstanceId | string | yes | The SQL instance ID |
| combineParam | object | no | The combined parameters |
| content | string | yes | The SQL content |
| domain | string | no | The data source server room |
| dynamicParam | object | no | The dynamic parameters |
| kvpair | object | no | The key-value struct |
| params | object | no | The SQL execution parameters |
| staticParam | object | no | The static parameters |

### Performs a forced switchover
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/force-switch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| fsmId | string | yes | The task ID |

### Queries the information about an advanced configuration
`GET https://apizie.tech/v1/cloud:aliyun-searchengine/get-advance-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| type | string | no | The type of the advanced configuration. Valid values: -ONLINE: online configuration -ONLINE_CAVA: online Cava configuration… |
| configName | string | yes | The name of the advanced configuration |

### Queries the information about an advanced configuration file
`GET https://apizie.tech/v1/cloud:aliyun-searchengine/get-advance-config-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| configName | string | yes | The name of the advanced configuration |
| fileName | string | yes | The name of the file |

### Queries the details of a specific cluster
`GET https://apizie.tech/v1/cloud:aliyun-searchengine/get-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| clusterName | string | yes | The cluster name |

### Retrieves cluster information
`GET https://apizie.tech/v1/cloud:aliyun-searchengine/get-cluster-run-time-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |

### Obtains a data source
`GET https://apizie.tech/v1/cloud:aliyun-searchengine/get-data-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| dataSourceName | string | yes | The name of the data source |

### Retrieves data source deployment information
`GET https://apizie.tech/v1/cloud:aliyun-searchengine/get-data-source-deploy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| deployName | string | yes | The data center |
| dataSourceName | string | yes | The name of the data source |

### Retrieves the schema of a database
`GET https://apizie.tech/v1/cloud:aliyun-searchengine/get-database-schema` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The ID of the instance |
| database | string | yes | The name of the database |
| tableName | string | yes | The name of the table |

### Displays the overview of the deployment
`GET https://apizie.tech/v1/cloud:aliyun-searchengine/get-deploy-graph` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |

### Retrieves the details of an index version
`GET https://apizie.tech/v1/cloud:aliyun-searchengine/get-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| indexName | string | yes | The index name |
| versionName | string | yes | The version name |
| fileName | string | yes | The full path of the file |

### Retrieves the details of an index table version
`GET https://apizie.tech/v1/cloud:aliyun-searchengine/get-index` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| indexName | string | yes | The index name |

### Gets the online strategy of an index
`GET https://apizie.tech/v1/cloud:aliyun-searchengine/get-index-online-strategy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| dataSourceName | string | yes | The name of the data source |
| deployName | string | yes | The name of the data center in which the data source is deployed |
| indexName | string | yes | The index name |

### Gets the index versions to which a cluster can be rolled back
`GET https://apizie.tech/v1/cloud:aliyun-searchengine/get-index-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| clusterName | string | yes | The name of the cluster |

### Retrieves the details of a specified instance by instance ID
`GET https://apizie.tech/v1/cloud:aliyun-searchengine/get-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |

### Queries the detailed configuration information of a specific model by instance ID and model name
`GET https://apizie.tech/v1/cloud:aliyun-searchengine/get-model` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| modelName | string | yes | The model name |

### Retrieves the configuration information of a node
`GET https://apizie.tech/v1/cloud:aliyun-searchengine/get-node-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| type | string | no | The node type. Valid values: qrs: query node search: data node index: index node cluster: cluster |
| name | string | no | The node name |
| clusterName | string | no | The cluster name |

### Retrieves SQL instance information
`GET https://apizie.tech/v1/cloud:aliyun-searchengine/get-sql-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| database | string | yes | The database name |
| sqlInstanceId | string | yes | The SQL instance ID |
| version | integer | no | The instance version |

### Get index table information
`GET https://apizie.tech/v1/cloud:aliyun-searchengine/get-table` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | Instance ID |
| tableName | string | yes | Index table name |

### Queries the status of an index version based on the ID of the full index version
`GET https://apizie.tech/v1/cloud:aliyun-searchengine/get-table-generation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| tableName | string | yes | The name of the table |
| generationId | string | yes | The ID of the full index version |

### Retrieves the list of files in an advanced configuration directory
`GET https://apizie.tech/v1/cloud:aliyun-searchengine/list-advance-config-dir` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| configName | string | yes | The configuration name |
| dirName | string | yes | The directory name |

### Queries the list of advanced configurations
`GET https://apizie.tech/v1/cloud:aliyun-searchengine/list-advance-configs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| type | string | no | The type of the advanced configuration. Valid values: online offline (default) |
| dataSourceName | string | no | The name of the data source |
| indexName | string | no | The name of the index |
| newMode | string | no | Specifies whether to use the new version of the console page |
| pageNumber | string | no | The page number. Default value: 1 |
| pageSize | string | no | The number of entries per page. Default value: 10 |

### Lists table aliases
`GET https://apizie.tech/v1/cloud:aliyun-searchengine/list-aliases` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |

### Queries cluster names
`GET https://apizie.tech/v1/cloud:aliyun-searchengine/list-cluster-names` (byok)

### Queries cluster tasks
`GET https://apizie.tech/v1/cloud:aliyun-searchengine/list-cluster-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |

### Queries clusters
`GET https://apizie.tech/v1/cloud:aliyun-searchengine/list-clusters` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |

### Queries the schema information about a data source
`GET https://apizie.tech/v1/cloud:aliyun-searchengine/list-data-source-schemas` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| dataSourceName | string | yes | The name of the data source |

### Retrieves data source tasks
`GET https://apizie.tech/v1/cloud:aliyun-searchengine/list-data-source-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |

### Obtains the list of data sources
`GET https://apizie.tech/v1/cloud:aliyun-searchengine/list-data-sources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |

### Lists the existing databases
`GET https://apizie.tech/v1/cloud:aliyun-searchengine/list-databases` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |

### Retrieves the historical data backflow information for a data source
`GET https://apizie.tech/v1/cloud:aliyun-searchengine/list-date-source-generations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| dataSourceName | string | yes | The name of the data source |
| validStatus | string | no | Specifies whether the status is valid. Default value: true. true: Returns generations for which tasks are completed and have not expired.… |
| domainName | string | yes | The data center where the data source is deployed |

### Retrieves data recovery records
`GET https://apizie.tech/v1/cloud:aliyun-searchengine/list-index-recover-records` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| indexName | string | yes | The index name |
| instanceId | string | yes | The instance ID |

### Retrieves the list of indexes
`GET https://apizie.tech/v1/cloud:aliyun-searchengine/list-indexes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| newMode | string | no | Specifies whether the new version of the console page is used |
| catalog | string | no | The data catalog ID of the DLF data source |
| database | string | no | The database of the DLF data source |
| table | string | no | The data table of the DLF data source |

### Gets the specifications available for a cluster
`GET https://apizie.tech/v1/cloud:aliyun-searchengine/list-instance-specs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| type | string | yes | The node type. Valid values: qrs: Query Result Searcher (QRS) Worker search: Searcher Worker index: index node cluster: cluster |

### Retrieves a list of instances
`GET https://apizie.tech/v1/cloud:aliyun-searchengine/list-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| pageNumber | integer | no | Specifies the page number. Default value: 1 |
| pageSize | integer | no | Specifies the number of entries per page. Default value: 10. Valid values: 1 to 50 |
| instanceId | string | no | The instance ID |
| description | string | no | Filters instances by description. Fuzzy matching is supported |
| resourceGroupId | string | no | The resource group ID |
| edition | string | no | The instance edition. Valid values: vector (Vector Index Edition) and engine (Recall Engine Edition) |
| tags | string | no | The tags (JSON-encoded) |
| catalog | string | no | The DLF data catalog ID |
| database | string | no | The DLF database name |
| table | string | no | The data source table name |
| dataSourceType | string | no | The data source type |

### Queries the logs of an instance
`GET https://apizie.tech/v1/cloud:aliyun-searchengine/list-logs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| type | string | no | The log type. Valid values: \`select\` (query logs) and \`push\` (write logs) |
| pageNum | string | no | The page number. The default value is 1 |
| pageSize | string | no | The number of entries to return on each page. The default value is 10 |
| startTime | string | no | The start of the time range to query. This is a UNIX timestamp in seconds |
| endTime | string | no | The end of the time range to query. This is a UNIX timestamp in seconds |
| query | string | no | The search statement |

### Queries a list of models under specified conditions by instance ID
`GET https://apizie.tech/v1/cloud:aliyun-searchengine/list-models` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| name | string | no | The model name |
| type | string | no | The model category |
| pageNumber | integer | no | The page number. Default value: 1 |
| pageSize | integer | no | The number of entries per page. Default value: 10 |

### Gets details of online table configurations
`GET https://apizie.tech/v1/cloud:aliyun-searchengine/list-online-configs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| nodeName | string | yes | The name of the Query Result Searcher (QRS) worker |
| domain | string | yes | The name of the domain |

### Queries pause policies
`GET https://apizie.tech/v1/cloud:aliyun-searchengine/list-pause-policys` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |

### Retrieves search test results for a Retrieval Engine Edition instance by sending a POST request
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/list-post-query-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| type | string | no | sql: SQL query. ha3: HA3 query |
| body | object | no | The request structure |

### Gets search test results
`GET https://apizie.tech/v1/cloud:aliyun-searchengine/list-query-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| query | string | no | The query statement |
| sql | string | no | The SQL statement that is executed in the query |

### Retrieves the test results of a REST search query for a Retrieval Engine Edition instance
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/list-rest-query-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| indexName | string | no | The name of the index table |
| query | object | no | The REST query |

### Retrieves a list of schemas based on a data synchronization configuration
`GET https://apizie.tech/v1/cloud:aliyun-searchengine/list-schemas` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| type | string | yes | odps, swift, saro, oss, unknown |
| endpoint | string | no | The endpoint of the ODPS data source |
| accessKey | string | no | The AccessKey ID of the ODPS data source |
| accessSecret | string | no | The AccessKey secret of the ODPS data source |
| project | string | no | The name of the ODPS data source project |
| partition | string | no | The data partition |
| table | string | no | The name of the table in the Saro or ODPS data source |
| namespace | string | no | The namespace of the Saro data source |
| instanceId | string | yes | The instance ID |

### Queries a list of index versions
`GET https://apizie.tech/v1/cloud:aliyun-searchengine/list-table-generations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| tableName | string | yes | The name of the table |

### Queries a list of index tables
`GET https://apizie.tech/v1/cloud:aliyun-searchengine/list-tables` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| newMode | string | no | Specifies whether the OpenSearch Vector Search Edition instance is of the new version |

### Queries the tags attached to one or more resources
`GET https://apizie.tech/v1/cloud:aliyun-searchengine/list-tag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| resourceType | string | yes | The resource type |
| resourceId | string | no | The IDs of the resources. You can specify up to 50 resource IDs (JSON-encoded) |
| tag | string | no | A list of up to 20 tags to add (JSON-encoded) |
| nextToken | string | no | The token that is used to retrieve the next page of results |

### Retrieves the change history for an instance
`GET https://apizie.tech/v1/cloud:aliyun-searchengine/list-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| start | integer | no | The start time |
| end | integer | no | The end time |

### Retrieves the results of a vector query test in Vector Search Edition
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/list-vector-query-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| path | string | no | The path |
| queryType | string | no | The query type. Valid values: vector, primary_key, and vector_text |
| vectorQueryType | string | no | The vector query type. Valid values: vector, image, and text |
| body | object | no | The request body |

### Modifies the content of HTTP and Git files
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/modify-advance-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| configName | string | yes | The configuration name |
| content | string | no | The configuration content. This parameter is required for HTTP and Git requests |
| contentType | string | no | The type of the configuration content. Valid values: FILE, GIT, HTTP, and ODPS |
| desc | string | no | The description of the advanced configuration |
| files | array | no | The list of file names |
| name | string | no | The configuration name |
| status | string | no | The configuration status. Valid values: drafting: Draft. used: In use. unused: Unused. trash: Deleting |
| updateTime | integer | no | The update time. The value is a UNIX timestamp in milliseconds |

### Modifies a dictionary
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/modify-advance-config-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| configName | string | yes | The configuration name |
| fileName | string | yes | The file name |
| content | string | no | The file content |
| variables | object | no | The list of variables |

### Modifies a table alias
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/modify-alias` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The ID of the instance |
| alias | string | yes | The alias |
| index | string | no | The index to associate with the alias |

### Modifies the description of a specified cluster
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/modify-cluster-desc` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| clusterName | string | yes | The name of the cluster |
| body | object | no | The request body |

### Modifies the configuration information of a cluster
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/modify-cluster-offline-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| buildMode | string | no | The reindexing method. Valid values: api: API data source. indexRecover: data recovery by using indexing |
| config | object | no | The configuration name, which is stored as a key |
| dataSourceName | string | no | The name of the data source |
| dataSourceType | string | no | The type of the data source. Valid values: odps: MaxCompute. swift: Swift. unKnow: unknown type |
| dataTimeSec | integer | no | The data timestamp, in seconds. This parameter is required when an API-pushed data source triggers a full index build |
| domain | string | no | The data center in which the data source is deployed |
| generation | integer | no | The ID of the full index version |
| partition | string | no | This parameter is required when index building for full data in a MaxCompute data source is triggered |
| pushMode | string | no | The push mode of the configuration. By default, only the configuration is pushed |

### Modifies the online configuration of a cluster
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/modify-cluster-online-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| clusters | array | no | The cluster information |
| config | object | no | The configuration information |

### Modifies the deployment information of a data source
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/modify-data-source-deploy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| deployName | string | yes | The data center |
| dataSourceName | string | yes | The name of the data source |
| generationId | integer | no | The full index version |
| dryRun | string | no | Specifies whether to perform a dry run (only validates whether the data source is valid). Valid values: true: performs a dry run. false:… |
| autoBuildIndex | string | no | Specifies whether to enable automatic full indexing |
| extend | object | no | The extended information |
| processor | object | no | The process parameters |
| storage | object | no | The data source information |
| swift | object | no | The incremental Swift information |

### Modifies a file
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/modify-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| indexName | string | yes | The index name |
| versionName | string | yes | The version name |
| fileName | string | yes | The name of the file in the full path |
| content | string | no | The file content |
| partition | integer | no | The number of shards |

### Modifies an index
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/modify-index` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| indexName | string | yes | The index name |
| dryRun | string | no | Specifies whether to only validate the input parameters without performing the actual operation. Default value: false. Valid values: true:… |
| buildParallelNum | integer | no | The number of concurrent full-indexing build threads |
| cluster | object | no | The cluster information |
| clusterConfigName | string | no | The cluster.json file name |
| config | object | no | The offline configuration information |
| content | string | no | The file content |
| dataSource | string | no | The data source |
| dataSourceInfo | object | no | The data source information. This parameter is required for the new version of the Vector Search Edition |
| description | string | no | The description |
| domain | string | no | The data source deployment |
| extend | object | no | The extended content for field configurations. key: vector (vector field), embeding (field requiring embedding), or description (remarks… |
| mergeParallelNum | integer | no | The number of concurrent full-indexing merge threads |
| partition | integer | no | The data partition |
| pushMode | string | no | The push configuration mode. Default value: push configuration only |

### Modifies the online policy of an index
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/modify-index-online-strategy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| dataSourceName | string | yes | The name of the data source |
| deployName | string | yes | The name of the data center in which the data source is deployed |
| indexName | string | yes | The index name |
| changeRate | integer | no | The index change rate |

### Modifies the information about index partitions
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/modify-index-partition` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| dataSourceName | string | no | The name of the data source |
| domainName | string | no | The data center |
| generation | integer | no | The primary key |
| indexInfos | array | no | The index information |

### Modifies the index version of a cluster (an index version rollback)
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/modify-index-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| clusterName | string | yes | The name of the cluster |
| body | array | no | The request body |

### Modifies the details and status of a model
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/modify-model` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| modelName | string | yes | The model name |
| dryRun | string | no | Specifies whether to perform only a check. The default value is false |
| content | object | no | The model details |
| status | string | no | The model status. ok: The model is available. forbidden: The model is unavailable |

### Modifies node configuration
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/modify-node-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| type | string | yes | The type of the algorithm. Valid values: pop: a popularity model. cp: a category prediction model. hot: a top search model. hint: a hint… |
| name | string | yes | The name of the configuration before the modification |
| clusterName | string | no | The name of the cluster |
| dataSourceName | string | no | The name of the data source. Valid values: -search: search for data. -not_search: do not search for data |
| active | string | no | Specifies whether the index is active online |
| dataDuplicateNumber | integer | no | The number of data replicas |
| dataFragmentNumber | integer | no | The number of data shards |
| flowRatio | integer | no | The traffic percentage |
| minServicePercent | integer | no | The minimum service ratio |
| published | string | no | Specifies whether to mount the cluster |

### Modifies online configurations
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/modify-online-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| nodeName | string | yes | The node name |
| indexName | string | yes | The index name |
| body | object | no | The request body |

### Modifies the password of an instance
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/modify-password` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| password | string | no | The password |
| username | string | no | The username |

### Modifies the pause policy
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/modify-pause-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| body | object | no | The request body |

### Modifies the public domain name whitelist
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/modify-public-url-ip-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| body | object | no | The request body. Key: publicUrlAllow |

### Modifies the number of replicas or shards for data nodes in an instance
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/modify-searcher-replica` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| partition | integer | no | The number of shards for a data node |
| replica | integer | no | The number of replicas for a data node |

### Modifies an index table
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/modify-table` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| tableName | string | yes | The name of the index table |
| dryRun | string | no | Specifies whether to perform a dry run (only validates whether the data source is valid). Valid values: true: performs a dry run. false:… |
| dataProcessConfig | array | no | The field processing configuration |
| dataSource | object | no | The datasource config |
| fieldSchema | object | no | The field map collection |
| partitionCount | integer | no | The number of data shards |
| primaryKey | string | no | The primary key field |
| rawSchema | string | no | If rawSchema is provided, it is used directly as the HA3 schema structure without manual assembly |
| vectorIndex | array | no | The index structure |

### Publishes an advanced version
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/publish-advance-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| configName | string | yes | The configuration name |
| desc | string | no | The description of the advanced configuration |
| files | array | no | The file information |

### Publishes a specified index version
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/publish-index-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| indexName | string | yes | The index name |
| body | object | no | The request body |

### Pushes documents
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/push-documents` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| dataSourceName | string | yes | The name of the data source |
| body | array | no | The request body parameters |
| pkField | string | no | The primary key field |

### Recovers data from an index
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/recover-index` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| bucket | string | no | Required when exporting data to OSS. The name of the destination OSS bucket |
| buildDeployId | integer | no | The ID of the offline deployment for the data source. You can obtain this ID by calling the GetIndexVersion… |
| dataSourceName | string | no | The name of the data source |
| generation | string | no | The full version of the index |
| indexName | string | no | The name of the index |
| odpsAccessId | string | no | Required when exporting data to MaxCompute. The AccessKey ID used to access MaxCompute |
| odpsAccessKey | string | no | Required when exporting data to MaxCompute. The AccessKey secret used to access MaxCompute |
| odpsPartition | string | no | Optional when exporting data to MaxCompute. The destination MaxCompute partition |
| odpsProject | string | no | Required when exporting data to MaxCompute. The name of the destination MaxCompute project |
| odpsTable | string | no | Required when exporting data to MaxCompute. The name of the destination MaxCompute table |
| outPutType | string | no | The export type. Valid values: default (exports data to the internal HDFS for index rebuilding), oss, and odps |
| path | string | no | Required when exporting data to OSS. The destination path. The path must start with a forward slash (/) and contain opensearch. If the… |

### Rebuilds an index
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/reindex` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| tableName | string | yes | The name of the index table |
| dataTimeSec | integer | no | The timestamp in seconds. This parameter is of the INT type. This parameter is required when the data source uses API push |
| ossDataPath | string | no | The OSS file path |
| partition | string | no | The partition. This parameter is required when the data source is ODPS |

### Deletes a cluster
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/remove-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| clusterName | string | yes | The name of the cluster |

### Renames a folder
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/rename-folder` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| database | string | yes | The database name |
| folderId | string | yes | The folder ID |
| name | string | yes | The folder name |

### Resumes an index
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/start-index` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| indexName | string | yes | The index name |

### Stops an index
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/stop-index` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| indexName | string | yes | The index name |

### Stops an FSM task
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/stop-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| fsmId | string | yes | The ID of the finite state machine (FSM) |

### Adds or updates tags for multiple resources
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/tag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| resourceId | array | yes | The IDs of the resources. You can specify up to 50 IDs |
| resourceType | string | yes | The resource type |
| tag | array | yes | The tags to add. You can specify a maximum of 20 tags |

### Removes tags from a batch of resources
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/untag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| resourceType | string | yes | The resource type |
| resourceId | string | yes | The IDs of the resources. You can specify up to 50 resource IDs (JSON-encoded) |
| tagKey | string | no | The list of tag keys. You can include up to 20 tag keys (JSON-encoded) |
| all | string | no | Specifies whether to remove all tags. This parameter takes effect only when tags are empty. Valid values: `true` and `false`. Default… |

### Modifies the configuration of a specified instance
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/update-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| components | array | no | The list of instance specifications. You cannot update this parameter together with description |
| description | string | no | The instance description. You cannot update this parameter together with components or orderType |
| orderType | string | no | Valid values: UPGRAGE: Upgrades the instance specifications. DOWNGRADE: Downgrades the instance specifications. You cannot specify this… |

### Updates the content of an SQL instance
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/update-sql-instance-content` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The ID of the instance |
| database | string | yes | The name of the database |
| sqlInstanceId | string | yes | The ID of the SQL instance |
| content | string | yes | The SQL content |

### Updates the name of an SQL instance
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/update-sql-instance-name` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| database | string | yes | The database name |
| sqlInstanceId | string | yes | The SQL instance ID |
| name | string | yes | The name of the SQL instance |

### Updates the parameters of an SQL instance
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/update-sql-instance-params` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | The instance ID |
| database | string | yes | The database name |
| sqlInstanceId | string | yes | The SQL instance ID |
| combineParam | object | no | The combined parameters |
| dynamicParam | object | no | The dynamic parameters |
| kvpair | object | no | The key-value (KV) configuration of the instance |
| params | object | no | The parameters to modify |
| staticParam | object | no | The static parameters |

### version
`POST https://apizie.tech/v1/cloud:aliyun-searchengine/version` (byok)

## Example
```
curl "https://apizie.tech/v1/cloud:aliyun-searchengine/build-index" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud SearchEngine API?
Create a free Apizie key, then send POST https://apizie.tech/v1/cloud:aliyun-searchengine/build-index with the header x-api-key. Every endpoint returns { project, data, timestamp }.

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

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

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