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

Obtém informações da tabela de índice.

Descrição da operação

Método

GET

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

get

*Instance

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

Nenhuma

Sintaxe da solicitação

GET /openapi/ha3/instances/{instanceId}/tables/{tableName} HTTP/1.1

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
instanceId	string	Sim	ID da instância.	ha-cn-pl32rf0****
tableName	string	Sim	Nome da tabela de índice.	test_summary

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

Nenhum parâmetro necessário.

Exemplo de solicitação

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

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
requestId	string	ID da solicitação.	2AE63638-5420-56DC-BF59-37D8174039A0
result	object	Resultado da resposta.
name	string	Nome do índice.	test_oss
status	string	Status da tabela de índice (NEW, PUBLISH, IN_USE: status normal após a versão do motor de recall ser criada com sucesso, NOT_USE, STOP_USE, RESTORE_USE, FAIL: status quando uma nova versão da versão de recuperação vetorial falha ao criar um índice pela primeira vez).	IN_USE
dataProcessorCount	integer	Número de recursos de atualização de dados.	1
partitionCount	integer	Número de shards de dados.	1
dataSource	object	Configuração da fonte de dados.
type	string	Data source type: only supports three types: odps, swift, and oss (odps, swift, saro, oss, unKnow)	odps
dataTimeSec	integer	Incremental data timestamp	1715160176
autoBuildIndex	boolean	Whether to automatically rebuild the index	true
config	object	Data source configuration
endpoint	string	ODPS-related	http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api
accessKey	string	AK	ak
accessSecret	string	AS	as
project	string	ODPS data source project name	dp_pdm_marketing_prod
partition	string	Partition information	ds=20220808
table	string	saro/ODPS data source table name	test_add
namespace	string	saro-related	namespace
path	string	HDFS-related	vendor/sebastian/comparator/src/exceptions
ossPath	string	OSS file path	/opensearch_index_data/sift_oss_test.data
bucket	string	OSS namespace	heytea-ops-oss
rawSchema	string	Se o usuário fornecer rawSchema, ele será usado diretamente como a estrutura de schema HA3 sem montagem manual.	{}
primaryKey	string	Campo de chave primária.	id
fieldSchema	object	Coleção de mapa de campos, key: nome do campo, value: tipo do campo.
	string	id	INT64
vectorIndex	array<object>	Estrutura de índice.
	array<object>
indexName	string	Index structure name	test_odps
vectorField	string	Vector field	source_image_vector
sparseIndexField	string	Sparse vector index field	sparse_indices
sparseValueField	string	Sparse vector value field	sparse_values
dimension	string	Vector dimension	128
vectorIndexType	string	Vector index algorithm	Qc
distanceType	string	Distance type	SquaredEuclidean
namespace	string	Namespace field	namespace
advanceParams	object	Index structure configuration
buildIndexParams	string	Index building parameters	{ "proxima.qc.builder.quantizer_class": "Int8QuantizerConverter", "proxima.qc.builder.quantize_by_centroid": true, "proxima.qc.builder.optimizer_class": "BruteForceBuilder", "proxima.qc.builder.thread_count": 10, "proxima.qc.builder.optimizer_params": { "proxima.linear.builder.column_major_order": true }, "proxima.qc.builder.store_original_features": false, "proxima.qc.builder.train_sample_count": 3000000, "proxima.qc.builder.train_sample_ratio": 0.5 }
searchIndexParams	string	Index search parameters	{"proxima.qc.searcher.scan_ratio":0.01}
minScanDocCnt	string	Minimum number of recall candidates	20000
linearBuildThreshold	string	Linear build threshold	5000
dataProcessConfig	array<object>	Configuração de processamento de campos.
	array<object>	Configuração de processamento de campos.
operator	string	Field processing method (copy: copies the source field to the target field, vectorize: vectorizes the source field using a model and stores the vector in the target field)	vectorize
dstField	string	Target field	source_image_vector
srcField	string	Source field	source_image
params	object	Model configuration information
vectorModel	string	Vectorization model	clip
vectorModal	string	Data type	image
srcFieldConfig	object	Vectorization information source
ossEndpoint	string	OSS region endpoint.	oss-cn-hangzhou-internal.aliyuncs.com
ossBucket	string	OSS Bucket	test
uid	string	Cloud account ID	uid

Exemplos

Resposta de sucesso

JSON formato

{
  "requestId": "2AE63638-5420-56DC-BF59-37D8174039A0",
  "result": {
    "name": "test_oss",
    "status": "IN_USE",
    "dataProcessorCount": 1,
    "partitionCount": 1,
    "dataSource": {
      "type": "odps",
      "dataTimeSec": 1715160176,
      "autoBuildIndex": true,
      "config": {
        "endpoint": "http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api",
        "accessKey": "ak",
        "accessSecret": "as",
        "project": "dp_pdm_marketing_prod",
        "partition": "ds=20220808",
        "table": "test_add",
        "namespace": "namespace",
        "path": "vendor/sebastian/comparator/src/exceptions",
        "ossPath": "/opensearch_index_data/sift_oss_test.data",
        "bucket": "heytea-ops-oss"
      }
    },
    "rawSchema": "{}",
    "primaryKey": "id",
    "fieldSchema": {
      "key": "INT64"
    },
    "vectorIndex": [
      {
        "indexName": "test_odps",
        "vectorField": "source_image_vector",
        "sparseIndexField": "sparse_indices",
        "sparseValueField": "sparse_values",
        "dimension": "128",
        "vectorIndexType": "Qc",
        "distanceType": "SquaredEuclidean",
        "namespace": "namespace",
        "advanceParams": {
          "buildIndexParams": "{\n  \"proxima.qc.builder.quantizer_class\": \"Int8QuantizerConverter\",\n  \"proxima.qc.builder.quantize_by_centroid\": true,\n  \"proxima.qc.builder.optimizer_class\": \"BruteForceBuilder\",\n  \"proxima.qc.builder.thread_count\": 10,\n  \"proxima.qc.builder.optimizer_params\": {\n    \"proxima.linear.builder.column_major_order\": true\n  },\n  \"proxima.qc.builder.store_original_features\": false,\n  \"proxima.qc.builder.train_sample_count\": 3000000,\n  \"proxima.qc.builder.train_sample_ratio\": 0.5\n}",
          "searchIndexParams": "{\"proxima.qc.searcher.scan_ratio\":0.01}",
          "minScanDocCnt": "20000",
          "linearBuildThreshold": "5000"
        }
      }
    ],
    "dataProcessConfig": [
      {
        "operator": "vectorize",
        "dstField": "source_image_vector",
        "srcField": "source_image",
        "params": {
          "vectorModel": "clip",
          "vectorModal": "image",
          "srcFieldConfig": {
            "ossEndpoint": "oss-cn-hangzhou-internal.aliyuncs.com\n",
            "ossBucket": "test",
            "uid": "uid"
          }
        }
      }
    ]
  }
}

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.