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

Modifica uma tabela de índice.

Descrição da operação

Método

PUT

URI

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

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:ModifyTable

update

*Instance

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

Nenhuma

Sintaxe da solicitação

PUT /openapi/ha3/instances/{instanceId}/tables/{tableName} 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****
tableName	string	Sim	O nome da tabela de índice.	index_hdfs

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
dryRun	boolean	Não	Especifica se deve ser realizado um dry run (valida apenas se a fonte de dados é válida). Valores válidos: true: realiza um dry run. false: não realiza um dry run.	true
body	object	Não	Os parâmetros do corpo da solicitação.
partitionCount	integer	Não	O número de shards de dados.	1
dataSource	object	Não	A configuração da fonte de dados.
dataTimeSec	integer	Não	O timestamp para o rastreamento incremental de dados.	1715160176
autoBuildIndex	boolean	Não	Indica se a reconstrução automática de índice está ativada.	true
config	object	Não	A configuração da fonte de dados.
endpoint	string	Não	O endpoint de acesso.	http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api
accessKey	string	Não	O AccessKey ID da fonte de dados ODPS.	L***p
accessSecret	string	Não	O AccessKey secret da fonte de dados ODPS.	5**9a6
project	string	Não	O nome do projeto da fonte de dados ODPS.	test_project
partition	string	Não	As informações de partição.	ds=20231220
table	string	Não	O nome da tabela da fonte de dados ODPS ou DLF.	behavior
ossPath	string	Não	O caminho do arquivo OSS.	/opensearch/test.txt
bucket	string	Não	O bucket OSS.	test_bucket
catalog	string	Não	O nome do catálogo da fonte de dados DLF.	test_catalog
database	string	Não	O banco de dados da fonte de dados DLF.	opensearch_db
tag	string	Não	A tag da fonte de dados DLF.	test
tableFormat	string	Não	O formato de tabela da fonte de dados DLF.	paimon lance object
path	string	Não	O caminho relativo.	/test
format	string	Não	O tipo de formato de arquivo.	ha3 json
rawSchema	string	Não	Se o rawSchema for fornecido, ele será usado diretamente como a estrutura de schema do HA3 sem montagem manual.	{}
primaryKey	string	Não	O campo de chave primária.	id
fieldSchema	object	Não	A coleção de mapeamento de campos.
	string	Não	chave: nome do campo. valor: tipo do campo.	{ "id": "INT64", "source_image": "STRING", "namespace": "INT64", "source_image_vector": "MULTI_FLOAT" }
vectorIndex	array<object>	Não	A estrutura do índice.
	array<object>	Não	Os detalhes da estrutura do índice.
indexName	string	Não	O nome da estrutura do índice.	test_index
vectorField	string	Não	O campo de vetor.	source_image_vector
sparseIndexField	string	Não	O campo de índice de vetor esparso.	sparse_indices
sparseValueField	string	Não	O campo de valor de vetor esparso.	sparse_values
dimension	string	Não	As dimensões do vetor.	128
vectorIndexType	string	Não	O algoritmo de índice de vetor.	Qc
distanceType	string	Não	O tipo de distância.	SquaredEuclidean
namespace	string	Não	O campo de namespace.	namespace
advanceParams	object	Não	A configuração da estrutura do índice.
buildIndexParams	string	Não	Os parâmetros de construção de índice.	{}
searchIndexParams	string	Não	Os parâmetros de pesquisa de índice.	{}
minScanDocCnt	string	Não	O número mínimo de documentos candidatos a recuperar.	20000
linearBuildThreshold	string	Não	O limite para construção linear.	5000
dataProcessConfig	array<object>	Não	A configuração de processamento de campos.
	array<object>	Não	Os detalhes da configuração de processamento de campos.
operator	string	Não	O método de processamento de campos. Valores válidos: copy: copia o campo de origem para o campo de destino. vectorize: vetoriza o campo de origem usando um modelo e armazena o vetor no campo de destino.	vectorize
dstField	string	Não	O campo de destino.	source_image_vector
srcField	string	Não	O campo de origem.	source_image
params	object	Não	As informações de configuração do modelo.
vectorModel	string	Não	O modelo de vetorização.	clip
vectorModal	string	Não	O tipo de dados.	image
srcFieldConfig	object	Não	A fonte de informações de vetorização.
ossEndpoint	string	Não	O endpoint da região OSS.	oss-cn-hangzhou-internal.aliyuncs.com
ossBucket	string	Não	O nome do bucket OSS.	test-bucket
uid	string	Não	O ID da conta Alibaba Cloud.	1062017779051424

Exemplo de solicitação

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

Importante Este exemplo lista apenas os parâmetros mais simples. Para mais parâmetros personalizados, consulte os parâmetros da solicitação.

{
    "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"
        }
    ]
}

Para mais informações, consulte Estrutura da resposta.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
requestId	string	O ID da solicitação.	FE03180A-0E29-5474-8A86-33F0683294A4
result	object	O resultado retornado.	{}

Exemplos

Resposta de sucesso

JSON formato

{
  "requestId": "FE03180A-0E29-5474-8A86-33F0683294A4",
  "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.