ModifyIndex-阿里云帮助中心

Modifies an index.

Operation description

Method

PUT

URI

/openapi/ha3/instances/{instanceId}/indexes/{indexName}
```.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

searchengine:ModifyIndex

update

*Instance

acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}

None

Request syntax

PUT /openapi/ha3/instances/{instanceId}/indexes/{indexName} HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	ha-cn-pl32rf0****
indexName	string	Yes	The index name.	test_api

Request parameters

Parameter	Type	Required	Description	Example
dryRun	boolean	No	Specifies whether to only validate the input parameters without performing the actual operation. Default value: false. Valid values: true: Only validates the parameter validity. false: Validates the parameter validity and creates the attribution configuration.	true
body	object	No	The request body parameters.
dataSourceInfo	object	No	The data source information. This parameter is required for the new version of AISearch.
buildMode	string	No	The index rebuild mode. Valid values: api (push data source through API) and indexRecover (recover data source from the index).	api
generation	integer	No	The generation of the dump table when recovering the data source from the index.	1718698593
dataTimeSec	integer	No	The timestamp for incremental data tracking.	1709715164
processPartitionCount	integer	No	The number of resources for data updates.	4
name	string	No	The data source name.	ha-cn-pl32rf0****_index_1
type	string	No	The data source type. Valid values: odps, swift, saro, oss, and unKnow.	odps
domain	string	No	The offline deployment.	vpc_hz_domain_1
config	object	No	The ODPS datasource config.
endpoint	string	No	The endpoint of the ODPS data source.	http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api
accessKey	string	No	The AccessKey ID for the ODPS data source.	L***p
accessSecret	string	No	The AccessKey secret for the ODPS data source.	5**9a6
project	string	No	The name of the ODPS project.	bbt_algo_pai
partition	string	No	The ODPS partition. For example: `ds=20180102`.	ds=20230114
table	string	No	The name of the saro or ODPS table.	item
namespace	string	No	The namespace of the saro data source.	test-namespace
path	string	No	The path of the HDFS data source.	test-hdfs-path
ossPath	string	No	The path of the OSS data source.	/opensearch/oss.json
bucket	string	No	The OSS bucket.	test-bucket
format	string	No	The format of the files in the OSS bucket. ha3 json	ha3
catalog	string	No	The ID of the data catalog for the Data Lake Formation (DLF) data source.	test-catalog
database	string	No	The database of the DLF data source.	test-database
tag	string	No	The tag of the DLF data source.	test-tag
tableFormat	string	No	The table format of the DLF data source.	paimon lance object
saroConfig	object	No	The saro datasource config.
namespace	string	No	The namespace of the saro data source.	flink-test-fjx-default
tableName	string	No	The name of the saro data table.	device_event_shy_summary_
autoBuildIndex	boolean	No	Specifies whether to enable automatic full indexing.	true
processParallelNum	integer	No	The number of concurrent full-indexing processes.	2
partition	string	No	The ODPS data source partition. This parameter is required when the data source type is ODPS.	ds=20230114
ossDataPath	string	No	The file path selected for index rebuilding from an OSS data source.	/opensearch/oss.json
description	string	No	The description.	"test"
content	string	No	The file content.	{\"summarys\":{\"summary_fields\":[\"id\"]},\"indexs\":[{\"index_name\":\"index_id\",\"index_type\":\"PRIMARYKEY64\",\"index_fields\":\"id\",\"has_primary_key_attribute\":true,\"is_primary_key_sorted\":false}],\"attributes\":[\"id\"],\"fields\":[{\"field_name\":\"id\",\"field_type\":\"UINT16\"}],\"table_name\":\"index_2\"}
partition	integer	No	The data partition.	2
dataSource	string	No	The data source.	ha-cn-pl32rf0****_index_1
domain	string	No	The data source deployment.	vpc_hz_domain_1
buildParallelNum	integer	No	The number of concurrent full-indexing build threads.	2
mergeParallelNum	integer	No	The number of concurrent full-indexing merge threads.	2
cluster	object	No	The cluster information.
	object	No	Cluster information
	object	No	Content updates for cluster.json
value	string	No	Variable	partition
description	string	No	Description	Custom Variable
disableModify	boolean	No	Whether the user can modify this	true
isModify	boolean	No	Whether this has been modified	false
type	string	No	Normal variable: NORMAL, function variable: FUNCTION	NORMAL
clusterConfigName	string	No	The cluster.json file name.	ha-cn-pl32rf0**@a-cn-pl32rf0**_test_api@hz_pre_vpc_domain_1@test_api@index_config_v1
config	object	No	The offline configuration information.
	object	No	Offline configuration
desc	string	No	Remarks	test
files	array<object>	No	List of modified files
	array<object>	No
operateType	string	No	The operation type. Valid values: UPDATE and DELETE. Default value: UPDATE.	UPDATE
parentFullPath	string	No	The path of the parent folder.	/
fileName	string	No	The file name.	/intervene_dict/analyzer.dict
config	object	No	The configuration for the update.
content	string	No	The content of the file. This is the dictionary configuration.	$dictContent
variables	object	No	The variables.
	object	No	The variable information.
description	string	No	The description.	test
disableModify	boolean	No	Specifies whether the variable can be modified by users.	true
isModify	boolean	No	Specifies whether the variable has been modified.	false
type	string	No	The type of the variable. Valid values: NORMAL for a regular variable and FUNCTION for a function variable.	NORMAL
value	string	No	The value of the variable.	test
dirName	string	No	The folder name.	/test
pushMode	string	No	The push configuration mode. Default value: push configuration only.	PUSH_ONLY
extend	object	No	The extended content for field configurations. key: vector (vector field), embeding (field requiring embedding), or description (remarks field). value: ["schema field name"].	{ "vector": [ "source_image_vector" ], "embeding": [ "source_image" ], "description": [] }

Response elements

Element	Type	Description	Example
	object
requestId	string	The request ID.	93A9E542-8CF8-5BA6-99AB-94C0FE520429
result	any	The returned result.	{}

Examples

Success response

JSON format

{
  "requestId": "93A9E542-8CF8-5BA6-99AB-94C0FE520429",
  "result": "{}"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.