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

Cria uma tabela de índice.

Descrição da operação

Método

POST

URI

/openapi/ha3/instances/{instanceId}/tables
```.

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

create

*Instance

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

Nenhuma

Sintaxe da solicitação

POST /openapi/ha3/instances/{instanceId}/tables 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****

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 (apenas valida 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	body.
name	string	Não	O nome do índice.	api_index_1
dataProcessorCount	integer	Não	O número de recursos de atualização de dados.	1
partitionCount	integer	Não	O número de shards de dados.	1
dataSource	object	Não	A configuração da fonte de dados.
type	string	Não	O tipo de fonte de dados. Apenas odps, swift e oss são suportados. Valores válidos: odps, swift, saro, oss e unKnow.	odps
dataTimeSec	integer	Não	O timestamp para rastreamento de dados incrementais.	1715160176
autoBuildIndex	boolean	Não	Especifica 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	The access 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 project name of the ODPS data source.	test_project
partition	string	Não	The partition. This parameter is required when the data source is ODPS.	ds=20220713
table	string	Não	The table name of the ODPS or DLF data source.	test56
path	string	Não	The relative path.	/test
ossPath	string	Não	The OSS data source path.	/opensearch/test.txt
bucket	string	Não	oss bucket	test-bucket
catalog	string	Não	The catalog name of the DLF data source.	test_catalog
database	string	Não	The database of the DLF data source.	opensearch_db
tag	string	Não	The tag of the DLF data source.	test
tableFormat	string	Não	The table format of the DLF data source.	paimon lance object
format	string	Não	The file format type.	ha3 json
rawSchema	string	Não	O schema bruto. Se você especificar este parâmetro, o valor será usado diretamente como a estrutura de schema HA3 sem montagem manual.	{}
primaryKey	string	Não	O campo de chave primária.	id
fieldSchema	object	Não	O schema de campos. A chave é o nome do campo.
	string	Não	map 结构	{ "id": "INT64", "source_image": "STRING", "namespace": "INT64", "source_image_vector": "MULTI_FLOAT" }
vectorIndex	array<object>	Não	A estrutura de índice.
	array<object>	Não
indexName	string	Não	O nome da estrutura de í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 vetorial.	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 de índice.
buildIndexParams	string	Não	The index building parameters.	{}
searchIndexParams	string	Não	The index search parameters.	{}
minScanDocCnt	string	Não	The minimum number of candidate documents for recall.	20000
linearBuildThreshold	string	Não	The threshold for linear building.	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	A configuração do modelo.
vectorModel	string	Não	The vectorization model.	clip
vectorModal	string	Não	The data type.	image
srcFieldConfig	object	Não	The vectorization information source.
ossEndpoint	string	Não	The OSS region endpoint.	oss-cn-hangzhou-internal.aliyuncs.com
ossBucket	string	Não	OSSBucket	test-bucket
uid	string	Não	The Alibaba Cloud account ID.	1062017779051424
scene	string	Não	O tipo de modelo.	videoSearcher

Exemplo de solicitação

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

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

{
    "name": "api",
    "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 de resposta

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
requestId	string	O ID da solicitação.	2AE63638-5420-56DC-BF59-37D8174039A0
result	object	O resultado retornado.	{}

Exemplos

Resposta de sucesso

JSON formato

{
  "requestId": "2AE63638-5420-56DC-BF59-37D8174039A0",
  "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.