GetTable - OpenSearch - Centro de documentación de Alibaba Cloud

Obtiene la información de la tabla de índices.

Descripción de la operación

Método

GET

URI

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

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

searchengine:GetTable

get

*Instance

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

Ninguna

Sintaxis de la solicitud

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

Parámetros de ruta

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
instanceId	string	Sí	El ID de la instancia.	ha-cn-pl32rf0****
tableName	string	Sí	El nombre de la tabla de índices.	test_summary

Parámetros de la solicitud

Parámetro

Tipo

Obligatorio

Descripción

Ejemplo

Ejemplo de solicitud

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

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
requestId	string	El ID de la solicitud.	2AE63638-5420-56DC-BF59-37D8174039A0
result	object	Resultado de la respuesta.
name	string	El nombre del índice.	test_oss
status	string	El estado de la tabla de índices (NEW, PUBLISH, IN_USE: estado normal después de que la versión del motor de recuperación se crea correctamente, NOT_USE, STOP_USE, RESTORE_USE, FAIL: estado cuando una nueva versión de la recuperación vectorial no logra crear un índice por primera vez).	IN_USE
dataProcessorCount	integer	El número de recursos de actualización de datos.	1
partitionCount	integer	El número de fragmentos de datos.	1
dataSource	object	La configuración del origen de datos.
type	string	El tipo de origen de datos: solo admite tres tipos: odps, swift y oss (odps, swift, saro, oss, unKnow).	odps
dataTimeSec	integer	La marca de tiempo de los datos incrementales.	1715160176
autoBuildIndex	boolean	Indica si se debe reconstruir automáticamente el índice.	true
config	object	La configuración del origen de datos.
endpoint	string	Información relacionada con ODPS.	http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api
accessKey	string	AK	ak
accessSecret	string	AS	as
project	string	El nombre del proyecto del origen de datos ODPS.	dp_pdm_marketing_prod
partition	string	La información de partición.	ds=20220808
table	string	El nombre de la tabla del origen de datos saro/ODPS.	test_add
namespace	string	Información relacionada con saro.	namespace
path	string	Información relacionada con HDFS.	vendor/sebastian/comparator/src/exceptions
ossPath	string	La ruta de archivo de OSS.	/opensearch_index_data/sift_oss_test.data
bucket	string	El espacio de nombres de OSS.	heytea-ops-oss
rawSchema	string	Si el usuario proporciona rawSchema, se utiliza directamente como la estructura de esquema HA3 sin necesidad de ensamblaje manual.	{}
primaryKey	string	El campo de clave primaria.	id
fieldSchema	object	Colección de mapas de campos, clave: nombre del campo, valor: tipo de campo.
	string	id	INT64
vectorIndex	array<object>	La estructura del índice.
	array<object>
indexName	string	El nombre de la estructura del índice.	test_odps
vectorField	string	El campo vectorial.	source_image_vector
sparseIndexField	string	El campo de índice de vector disperso.	sparse_indices
sparseValueField	string	El campo de valor de vector disperso.	sparse_values
dimension	string	La dimensión del vector.	128
vectorIndexType	string	El algoritmo de índice vectorial.	Qc
distanceType	string	El tipo de distancia.	SquaredEuclidean
namespace	string	El campo de espacio de nombres.	namespace
advanceParams	object	La configuración de la estructura del índice.
buildIndexParams	string	Los parámetros de construcción del índice.	{ "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	Los parámetros de búsqueda del índice.	{"proxima.qc.searcher.scan_ratio":0.01}
minScanDocCnt	string	El número mínimo de candidatos de recuperación.	20000
linearBuildThreshold	string	El umbral de construcción lineal.	5000
dataProcessConfig	array<object>	La configuración de procesamiento de campos.
	array<object>	La configuración de procesamiento de campos.
operator	string	El método de procesamiento de campos (copy: copia el campo de origen al campo de destino, vectorize: vectoriza el campo de origen mediante un modelo y almacena el vector en el campo de destino).	vectorize
dstField	string	El campo de destino.	source_image_vector
srcField	string	El campo de origen.	source_image
params	object	La información de configuración del modelo.
vectorModel	string	Modelo de vectorización.	clip
vectorModal	string	Tipo de datos.	image
srcFieldConfig	object	Origen de información de vectorización.
ossEndpoint	string	Endpoint de la región de OSS.	oss-cn-hangzhou-internal.aliyuncs.com
ossBucket	string	Bucket de OSS.	test
uid	string	ID de la cuenta en la nube.	uid

Ejemplos

Respuesta exitosa

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 error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.