ModifyIndex - OpenSearch: Central de Documentação do Alibaba Cloud

Modifica um índice.

Descrição da operação

Método

PUT

URI

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

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

searchengine:ModifyIndex

update

*Instance

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

Nenhuma

Sintaxe da solicitação

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

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
instanceId	string	Sim	O ID da instância.	ha-cn-pl32rf0****
indexName	string	Sim	O nome do índice.	test_api

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
dryRun	boolean	Não	Especifica se deve apenas validar os parâmetros de entrada sem executar a operação real. Valor padrão: false. Valores válidos: true: Apenas valida a validade dos parâmetros. false: Valida a validade dos parâmetros e cria a configuração de atribuição.	true
body	object	Não	Os parâmetros do corpo da solicitação.
dataSourceInfo	object	Não	As informações da fonte de dados. Este parâmetro é obrigatório para a nova versão do AISearch.
buildMode	string	Não	O modo de reconstrução do índice. Valores válidos: api (enviar fonte de dados via API) e indexRecover (recuperar fonte de dados do índice).	api
generation	integer	Não	A geração da tabela de dump ao recuperar a fonte de dados do índice.	1718698593
dataTimeSec	integer	Não	O timestamp para rastreamento de dados incrementais.	1709715164
processPartitionCount	integer	Não	O número de recursos para atualizações de dados.	4
name	string	Não	O nome da fonte de dados.	ha-cn-pl32rf0****_index_1
type	string	Não	O tipo de fonte de dados. Valores válidos: odps, swift, saro, oss e unKnow.	odps
domain	string	Não	A implantação offline.	vpc_hz_domain_1
config	object	Não	A configuração da fonte de dados ODPS.
endpoint	string	Não	The ODPS endpoint.	http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api
accessKey	string	Não	The AccessKey ID of the ODPS data source.	L***p
accessSecret	string	Não	The AccessKey secret of the ODPS data source.	5**9a6
project	string	Não	The ODPS data source project name.	bbt_algo_pai
partition	string	Não	The ODPS partition. Example: ds=20180102.	ds=20230114
table	string	Não	The table name for saro or ODPS data sources.	item
namespace	string	Não	The namespace for saro data sources.	test-namespace
path	string	Não	The path for HDFS data sources.	test-hdfs-path
ossPath	string	Não	The path for OSS data sources.	/opensearch/oss.json
bucket	string	Não	The OSS bucket.	test-bucket
format	string	Não	The OSS file format type. Valid values: ha3 json.	ha3
catalog	string	Não	The data catalog ID for DLF data sources.	test-catalog
database	string	Não	The database for DLF data sources.	test-database
tag	string	Não	The tag for DLF data sources.	test-tag
tableFormat	string	Não	The table format for DLF data sources.	paimon lance object
saroConfig	object	Não	A configuração da fonte de dados saro.
namespace	string	Não	The namespace of the saro data source.	flink-test-fjx-default
tableName	string	Não	The saro data table name.	device_event_shy_summary_
autoBuildIndex	boolean	Não	Especifica se a indexação completa automática deve ser ativada.	true
processParallelNum	integer	Não	O número de processos simultâneos de indexação completa.	2
partition	string	Não	A partição da fonte de dados ODPS. Este parâmetro é obrigatório quando o tipo de fonte de dados é ODPS.	ds=20230114
ossDataPath	string	Não	O caminho do arquivo selecionado para reconstrução de índice a partir de uma fonte de dados OSS.	/opensearch/oss.json
description	string	Não	A descrição.	"test"
content	string	Não	O conteúdo do arquivo.	{\"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	Não	A partição de dados.	2
dataSource	string	Não	A fonte de dados.	ha-cn-pl32rf0****_index_1
domain	string	Não	A implantação da fonte de dados.	vpc_hz_domain_1
buildParallelNum	integer	Não	O número de threads simultâneas de construção de indexação completa.	2
mergeParallelNum	integer	Não	O número de threads simultâneas de merge de indexação completa.	2
cluster	object	Não	As informações do cluster.
	object	Não	Informações do cluster.
	object	Não	Atualizações de conteúdo para cluster.json.
value	string	Não	Variável.	partition
description	string	Não	Descrição.	Custom Variable
disableModify	boolean	Não	Se o usuário pode modificar isto.	true
isModify	boolean	Não	Se isto foi modificado.	false
type	string	Não	Variável normal: NORMAL, variável de função: FUNCTION.	NORMAL
clusterConfigName	string	Não	O nome do arquivo cluster.json.	ha-cn-pl32rf0**@a-cn-pl32rf0**_test_api@hz_pre_vpc_domain_1@test_api@index_config_v1
config	object	Não	As informações de configuração offline.
	object	Não	Configuração offline.
desc	string	Não	Observações.	test
files	array<object>	Não	Lista de arquivos modificados.
	array<object>	Não
operateType	string	Não	Operation type. Valid values: UPDATE (update) and DELETE (delete). Default value: UPDATE.	UPDATE
parentFullPath	string	Não	The path of the parent directory	/
fileName	string	Não	File name	/intervene_dict/analyzer.dict
config	object	Não	The configuration for this update
content	string	Não	File content for dictionary configuration	$dictContent
variables	object	Não	Variable
	object	Não	Variable information
description	string	Não	Description	test
disableModify	boolean	Não	Whether the user can modify this	true
isModify	boolean	Não	Whether this has been modified	false
type	string	Não	Normal variable: NORMAL, function variable: FUNCTION	NORMAL
value	string	Não	Variable	test
dirName	string	Não	Directory name	/test
pushMode	string	Não	O modo de push de configuração. Valor padrão: somente push de configuração.	PUSH_ONLY
extend	object	Não	O conteúdo estendido para configurações de campo. key: vector (campo vetorial), embeding (campo que requer embedding) ou description (campo de observações). value: ["nome do campo do schema"].	{ "vector": [ "source_image_vector" ], "embeding": [ "source_image" ], "description": [] }

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
requestId	string	O ID da solicitação.	93A9E542-8CF8-5BA6-99AB-94C0FE520429
result	any	O resultado retornado.	{}

Exemplos

Resposta de sucesso

JSON formato

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

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.