修改索引。
接口说明
方法
PUT
URI
/openapi/ha3/instances/{instanceId}/indexes/{indexName}
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
searchengine:ModifyIndex |
update |
*Instance
|
无 | 无 |
请求语法
PUT /openapi/ha3/instances/{instanceId}/indexes/{indexName} HTTP/1.1请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| instanceId |
string |
是 |
实例 ID |
ha-cn-pl32rf0**** |
| indexName |
string |
是 |
索引名称 |
test_api |
| dryRun |
boolean |
否 |
是否校验入参数据合法性，默认 false。 取值：
|
true |
| body |
object |
否 |
请求体参数 |
|
| dataSourceInfo |
object |
否 |
数据源相关信息 （向量检索版新版本必填） |
|
| buildMode |
string |
否 |
索引重建方式 (api: API 方式推送数据源, indexRecover: 从索引中恢复数据源) |
api |
| generation |
integer |
否 |
从索引中恢复数据源，dump 表的 generation |
1718698593 |
| dataTimeSec |
integer |
否 |
追增量时间戳 |
1709715164 |
| processPartitionCount |
integer |
否 |
数据更新资源数 |
4 |
| name |
string |
否 |
数据源名 |
ha-cn-pl32rf0****_index_1 |
| type |
string |
否 |
数据源类型 (odps, swift, saro, oss, unKnow) |
odps |
| domain |
string |
否 |
离线部署 |
vpc_hz_domain_1 |
| config |
object |
否 |
odps 数据源配置 |
|
| endpoint |
string |
否 |
odps 相关 |
http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api |
| accessKey |
string |
否 |
odps 数据源 ak |
L***p |
| accessSecret |
string |
否 |
odps 数据源 ak secret |
5**9a6 |
| project |
string |
否 |
odps 数据源项目名称 |
bbt_algo_pai |
| partition |
string |
否 |
ODPS Partition。例如：ds=20180102。 |
ds=20230114 |
| table |
string |
否 |
saro、odps 相关 |
item |
| namespace |
string |
否 |
saro 相关 |
test-namespace |
| path |
string |
否 |
hdfs 相关 |
test-hdfs-path |
| ossPath |
string |
否 |
oss 数据源相关 |
/opensearch/oss.json |
| bucket |
string |
否 |
OSS 存储空间。 |
test-bucket |
| format |
string |
否 |
oss 文件格式类型
|
ha3 |
| catalog |
string |
否 |
dlf 数据源-数据目录 ID |
test-catalog |
| database |
string |
否 |
dlf 数据源-数据库 |
test-database |
| tag |
string |
否 |
dlf 数据源-tag |
test-tag |
| tableFormat |
string |
否 |
dlf 数据源-表格式 |
paimon lance object |
| saroConfig |
object |
否 |
saro 数据源配置 |
|
| namespace |
string |
否 |
saro 数据源的 namespace |
flink-test-fjx-default |
| tableName |
string |
否 |
saro 数据表名称 |
device_event_shy_summary_ |
| autoBuildIndex |
boolean |
否 |
是否开启自动全量 |
true |
| processParallelNum |
integer |
否 |
全量 process 并发数 |
2 |
| partition |
string |
否 |
odps 数据源分区-数据源为 odps 时必填。 |
ds=20230114 |
| ossDataPath |
string |
否 |
oss 数据源进行索引重建时选择的文件地址 |
/opensearch/oss.json |
| description |
string |
否 |
描述信息。 |
"test" |
| content |
string |
否 |
文件内容 |
{\"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 |
否 |
数据分片 |
2 |
| dataSource |
string |
否 |
数据源 |
ha-cn-pl32rf0****_index_1 |
| domain |
string |
否 |
数据源部署 |
vpc_hz_domain_1 |
| buildParallelNum |
integer |
否 |
全量 build 并发数 |
2 |
| mergeParallelNum |
integer |
否 |
全量 merge 并发数 |
2 |
| cluster |
object |
否 |
集群信息 |
|
|
object |
否 |
集群信息 |
||
| clusterConfigName |
string |
否 |
cluster.json 文件名 |
ha-cn-pl32rf0****@a-cn-pl32rf0****_test_api@hz_pre_vpc_domain_1@test_api@index_config_v1 |
| config |
object |
否 |
离线配置信息 |
|
|
object |
否 |
离线配置 |
||
| desc |
string |
否 |
备注 |
test |
| files |
array |
否 |
修改的文件列表 |
|
|
array<object> |
否 |
|||
| operateType |
string |
否 |
操作类型：UPDATE:更新；DELETE:删除；默认 UPDATE |
UPDATE |
| parentFullPath |
string |
否 |
上级目录的路径 |
/ |
| fileName |
string |
否 |
文件名称 |
/intervene_dict/analyzer.dict |
| config |
object |
否 |
本次更新的配置 |
|
| content |
string |
否 |
文件内容--词典配置 |
$dictContent |
| variables |
object |
否 |
变量 |
|
|
object |
否 |
变量信息 |
||
| description |
string |
否 |
描述 |
test |
| disableModify |
boolean |
否 |
是否可被用户修改 |
true |
| isModify |
boolean |
否 |
是否被修改过 |
false |
| type |
string |
否 |
普通变量：NORMAL， function 变量：FUNCTION |
NORMAL |
| value |
string |
否 |
变量 |
test |
| dirName |
string |
否 |
目录名称 |
/test |
| pushMode |
string |
否 |
推送配置方式: 默认仅推送配置 |
PUSH_ONLY |
| extend |
object |
否 |
字段配置的扩展的内容。 key: vector(向量字段)、embeding(需 embeding 字段)、备注字段（description） value: ["schema 字段名称"] |
{ "vector": [ "source_image_vector" ], "embeding": [ "source_image" ], "description": [] } |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| requestId |
string |
请求 ID。 |
93A9E542-8CF8-5BA6-99AB-94C0FE520429 |
| result |
any |
返回结果。 |
{} |
示例
正常返回示例
JSON格式
{
"requestId": "93A9E542-8CF8-5BA6-99AB-94C0FE520429",
"result": "{}"
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。