使用ModifyIndex API修改索引-智能OpenSearch OpenSearch-阿里雲 - OpenSearch

修改索引。

介面說明

方法

PUT

URI

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

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

searchengine:ModifyIndex

update

*Instance

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

無

請求文法

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

路徑參數

名稱	類型	必填	描述	樣本值
instanceId	string	是	執行個體 ID。	ha-cn-pl32rf0****
indexName	string	是	索引名稱。	test_api

請求參數

名稱	類型	必填	描述	樣本值
dryRun	boolean	否	是否校驗入參資料合法性，預設 false。取值： true：只校驗參數合法性。 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 json	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	否	集群信息
	object	否	cluster.json 更新内容
value	string	否	变量	partition
description	string	否	描述信息	Custom Variable
disableModify	boolean	否	是否可被用户修改	true
isModify	boolean	否	是否被修改过	false
type	string	否	普通变量：NORMAL， function 变量：FUNCTION	NORMAL
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<object>	否	修改的文件列表
	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": "{}"
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。