ModifyTable - OpenSearch - Alibaba Cloud Documentation Center

Modifies an index table.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
searchengine:ModifyTable	update	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	none	none

Request syntax

PUT /openapi/ha3/instances/{instanceId}/tables/{tableName} HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	ha-cn-tl32n3iu801
tableName	string	Yes	The name of the table.	index_hdfs
dryRun	boolean	No	Specifies whether to perform only a dry run, without performing the actual request. The system only checks the validity of the data source. Valid values: true false	true
body	object	No	The request body.
partitionCount	integer	No	The number of data shards.	1
dataSource	object	No	The configurations of the data source.
dataTimeSec	integer	No	The start timestamp from which incremental data is retrieved.	1715160176
autoBuildIndex	boolean	No	Specifies whether to automatically rebuild the index.	true
config	object	No	The configurations of the data source.
endpoint	string	No	The endpoint of the MaxCompute data source.	http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api
accessKey	string	No	The AccessKey ID of the MaxCompute data source.	AK
accessSecret	string	No	The AccessKey secret of the MaxCompute data source.	AS
project	string	No	The name of the MaxCompute project that is used as the data source.	yw_dw_rpt
partition	string	No	The partition in the MaxCompute table.	ds=20231220
table	string	No	The name of the MaxCompute table that is used as the data source.	behavior
ossPath	string	No	The path of the Object Storage Service (OSS) object.	oss://opensearch
bucket	string	No	The name of the OSS bucket.	antsys-shujiang-osstest
rawSchema	string	No	The instance schema. If this parameter is specified, the parameters about the index are not required.	{}
primaryKey	string	No	The primary key field.	id
fieldSchema	object	No	The fields.
	string	No	The field. The value is a key-value pair in which the key represents the field name and value represents the field type.	{ "id": "INT64", "source_image": "STRING", "namespace": "INT64", "source_image_vector": "MULTI_FLOAT" }
vectorIndex	array<object>	No	The index schema.
vectorIndex	object	No
indexName	string	No	The name of the index schema.	test_api
vectorField	string	No	The vector field.	source_image_vector
sparseIndexField	string	No	The field that stores the indexes of the elements in sparse vectors.	sparse_indices
sparseValueField	string	No	The field that stores the elements in sparse vectors.	sparse_values
dimension	string	No	The dimension of the vector.	128
vectorIndexType	string	No	The vector retrieval algorithm.	Qc
distanceType	string	No	The distance type.	SquaredEuclidean
namespace	string	No	The namespace field.	namespace
advanceParams	object	No	The configurations of the index schema.
buildIndexParams	string	No	The index building parameters.	{}
searchIndexParams	string	No	The index retrieval parameters.	{}
minScanDocCnt	string	No	The minimum number of retrieved candidate sets.	20000
linearBuildThreshold	string	No	The threshold for linear building.	5000
dataProcessConfig	array<object>	No	The configurations about field processing.
dataProcessConfig	object	No
operator	string	No	The method used to process the field. Valid values: copy and vectorize. A value of copy specifies that the value of the source field is copied to the destination field. A value of vectorize specifies that the value of the source field is vectorized by a vectorization model and the output vector is stored in the destination field.	vectorize
dstField	string	No	The destination field.	source_image_vector
srcField	string	No	The source field.	source_image
params	object	No	The information about the model.
vectorModel	string	No	The vectorization model.	clip
vectorModal	string	No	The data type.	image
srcFieldConfig	object	No	The source of the data to be vectorized.
ossEndpoint	string	No	The OSS endpoint.	oss-cn-hangzhou-internal.aliyuncs.com
ossBucket	string	No	The name of the OSS bucket.	test
uid	string	No	The ID of the Alibaba Cloud account.	uid

Sample requests

PUT /openapi/ha3/instances/{instanceId}/tables/{tableName}

Note In this sample code, only some request parameters are used. For more information about custom parameters, see the "Request parameters" section of this topic.

{
    "partitionCount": 1,
    "primaryKey": "id",
    "fieldSchema": {
        "id": "INT64",
        "source_image": "STRING",
        "namespace": "STRING",
        "source_image_vector": "MULTI_FLOAT"
    },
    "vectorIndex": [
        {
            "indexName": "test_index_1",
            "vectorField": "source_image_vector",
            "vectorIndexType": "HNSW",
            "dimension": "512",
            "distanceType": "InnerProduct"
        }
    ]
}

For more information, see Response structure.

Response parameters

Parameter	Type	Description	Example
	object
requestId	string	id of request	FE03180A-0E29-5474-8A86-33F0683294A4
result	object	Map	{}

Examples

Sample success responses

JSONformat

{
  "requestId": "FE03180A-0E29-5474-8A86-33F0683294A4",
  "result": {}
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-09-18	The internal configuration of the API is changed, but the call is not affected	View Change Details