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

Cria um índice.

Descrição da operação

Método

POST

URI

/openapi/ha3/instances/{instanceId}/indexes

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

create

*Instance

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

Nenhuma

Sintaxe da solicitação

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

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
body	object	Não	O corpo da solicitação.	{}
name	string	Não	O nome do índice.	index_1
dataSource	string	Não	O nome da fonte de dados.	ha-cn-35t3n1y****_index_1
domain	string	Não	O data center da fonte de dados.	vpc_hz_domain_1
content	string	Não	O esquema do índice.	{\"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	O número de shards de dados.	2
dataSourceInfo	object	Não	Informações sobre a fonte de dados. Este parâmetro é obrigatório para novas versões do Vector Search Edition.
dataTimeSec	integer	Não	O carimbo de data/hora UNIX para 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-35t3n1y****_index_1
type	string	Não	O tipo da fonte de dados. Valores válidos: odps swift saro oss	odps
domain	string	Não	O data center offline.	vpc_hz_domain_1
config	object	Não	Configurações relacionadas ao ODPS.
endpoint	string	Não	The endpoint of the ODPS or OSS data source.	https://oss-cn-hangzhou.aliyuncs.com
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 name of the ODPS project.	bbt_algo_pai
partition	string	Não	This parameter is required if the data source type is ODPS.	ds=20230114
table	string	Não	The name of the table.	bbt_rec_swing_u2i2i_score_be_v1
namespace	string	Não	The namespace.	test-namespace
path	string	Não	The path of the HDFS data source.	test-hdfs-path
ossPath	string	Não	The path of the OSS file.	/opensearch/oss.json
bucket	string	Não	The OSS bucket.	test-bucket
format	string	Não	The format of the OSS file. ha3 json	ha3
catalog	string	Não	The data catalog ID of the DLF data source.	test-catalog
database	string	Não	The database of the DLF data source.	test-database
tag	string	Não	The tag of the DLF data source.	test-tag
tableFormat	string	Não	The table format of the DLF data source.	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. This feature is available only for internal use.	test
tableName	string	Não	The name of the Saro data table. This feature is available only for internal use.	tableA
autoBuildIndex	boolean	Não	Especifica se deve ser acionada automaticamente uma indexação completa.	true
processParallelNum	integer	Não	A concorrência para processamento completo de dados.	2
scene	string	Não	O tipo de modelo.	videoSearcher
extend	object	Não	A configuração de campo estendida. key: O tipo de campo. Valores válidos: `vector` (campo de vetor), `embeding` (campo que requer incorporação) e `description` (campo de descrição). value: O nome do campo no esquema, como `["field_name"]`.	{ "vector": [ "source_image_vector" ], "embeding": [ "source_image" ], "description": [] }
buildParallelNum	integer	Não	A concorrência para construção completa do índice.	2
mergeParallelNum	integer	Não	A concorrência para mesclagem completa do índice.	2
dryRun	boolean	Não	Especifica se deve ser realizado um dry run. Um dry run verifica apenas se a fonte de dados é válida. Valores válidos: true false	true

Exemplo de solicitação

POST /openapi/ha3/instances/ose-test1/indexes

{
    "name": "index_1",
    "dataSource": "ha-cn-3********0d_index_1",
    "content": "",
    "extend":
    {
        "vector":
        [
            "source_image_vector"
        ],
        "embeding":
        [
            "source_image"
        ],
        "description":
        []
    },
    "partition": 1,
    "dataSourceInfo":
    {
        "type": "odps",
        "processPartitionCount": 2,
        "autoBuildIndex": true,
        "config":
        {
            "endpoint": "http://service.cn-hangzhou.maxcompute.aliyun.com/api",
            "project": "odps_project",
            "accessKey": "ak",
            "accessSecret": "as",
            "table": "odps_table",
            "partition": "ds=*******"
        },
        "saroConfig":
        {},
        "dataTimeSec": 1709715164
    }
}

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A resposta que é retornada.
requestId	string	O ID da solicitação.	407BFD91-DE7D-50BA-8F88-CDE52A3B5E46
result	object	O resultado da solicitação.	{}

Exemplo de resposta

Resposta bem-sucedida

{
  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
  "result": {}
}

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

Exemplos

Resposta de sucesso

JSON formato

{
  "requestId": "407BFD91-DE7D-50BA-8F88-CDE52A3B5E46",
  "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.