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

Obtiene los detalles de una versión de tabla de índices.

Descripción de la operación

Método

GET

URI

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

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

get

*Instance.

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

Ninguna

Sintaxis de la solicitud

GET /openapi/ha3/instances/{instanceId}/indexes/{indexName} 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****
indexName	string	Sí	El nombre del índice.	test_api

Parámetros de la solicitud

Parámetro

Tipo

Obligatorio

Descripción

Ejemplo

Solicitud de ejemplo

GET  /openapi/ha3/instances/ose-test1/indexes/index1?dataSource=xxx

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
requestId	string	El ID de la solicitud.	4FB0325E-8C37-5525-96AC-0333523170A3
result	object	La información del índice.
name	string	El nombre del índice.	test_api
versions	array<object>	La información de la versión.
	array<object>	La información de la versión de datos.
desc	string	La información de la descripción.	Index Note
files	array<object>	La ubicación.
	object	Los detalles de la versión.
fullPathName	string	La ruta completa.	/qrs.json
isDir	boolean	Especifica si el elemento es una carpeta.	true
isTemplate	boolean	Especifica si el elemento es una plantilla.	true
name	string	El nombre del archivo.	qrs.json
name	string	El nombre de la versión.	test
status	string	El estado. Valores válidos: NEW: creado PUBLISH: normal IN_USE: en uso NOT_USE: no en uso STOP_USE: deteniendo el uso RESTORE_USE: reanudando el uso FAIL: fallido	PUBLISH
updateTime	integer	La hora de actualización. El valor es una marca de tiempo UNIX en segundos.	1718846192
versionId	integer	El ID de la versión.	1
dataSource	string	El origen de datos.	ha-cn-pl32rf0****_test_api
domain	string	El nombre de despliegue del origen de datos.	sz_vpc_domain_1
indexStatus	string	El estado. Valores válidos: NEW: creado PUBLISH: normal IN_USE: en uso NOT_USE: no en uso STOP_USE: deteniendo el uso RESTORE_USE: reanudando el uso FAIL: fallido	IN_USE
content	string	El contenido del archivo.	{"summarys":{"parameter":{"file_compressor":"zstd"},"summary_fields":["id"]},"file_compress":[{"name":"file_compressor","type":"zstd"},{"name":"no_compressor","type":""}],"indexs":[{"index_fields":"name","index_name":"ids","index_type":"STRING"},{"has_primary_key_attribute":true,"index_fields":"id","is_primary_key_sorted":false,"index_name":"id","index_type":"PRIMARYKEY64"}],"attributes":[{"file_compress":"no_compressor","field_name":"id"}],"fields":[{"user_defined_param":{},"compress_type":"uniq","field_type":"STRING","field_name":"id"},{"compress_type":"uniq","field_type":"STRING","field_name":"name"}],"table_name":"api"}
partition	integer	El fragmento de datos.	2
fullVersion	integer	La versión de datos.	1688523414
fullUpdateTime	string	La hora de conmutación completa. El formato es AAAA-MM-DD HH:mm:ss.	2024-06-20 08:52:54
incUpdateTime	string	La hora de actualización incremental. El formato es AAAA-MM-DD HH:mm:ss.	2024-06-20 08:52:54
indexSize	integer	El tamaño del índice.	4689
description	string	La descripción.	note
dataSourceInfo	object	La información del origen de datos.
processPartitionCount	integer	El número de recursos de actualización de datos.	2
name	string	El nombre del origen de datos.	ha-cn-pl32rf0****_test_api
type	string	El tipo de origen de datos. Valores válidos: odps, swift, saro, oss y unKnow.	odps
domain	string	El despliegue fuera de línea.	vpc_hz_domain_1
config	object	La configuración del origen de datos ODPS.
endpoint	string	La información relacionada con ODPS.	http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api
accessKey	string	El ID de AccessKey del origen de datos ODPS.	L***p
accessSecret	string	El secreto de AccessKey del origen de datos ODPS.	5**9a6
project	string	El nombre del proyecto del origen de datos ODPS.	tisplus_dev
partition	string	La partición de ODPS. Ejemplo: ds=20180102.	ds=20220713
table	string	La información relacionada con Saro y ODPS.	dump_odps_demo
namespace	string	La información relacionada con Saro.	TEST_dump_demo_sj_na61hunbu2_share_holo
path	string	La información relacionada con HDFS.	http://test_opensearch/sift_oss_test.data
ossPath	string	La información relacionada con el origen de datos OSS.	/test_opensearch/sift_oss_test.data
bucket	string	El nombre del bucket.	ha3test-oss
format	string	El tipo de formato de archivo de OSS. Valores válidos: ha3 json	ha3
catalog	string	El ID del catálogo de datos del origen de datos DLF.	clg-paimon-21cc136237a6457f8618f5f82d116d7e
database	string	La base de datos del origen de datos DLF.	dlf_test
tag	string	La etiqueta del origen de datos DLF.	test_tag
saroConfig	object	La configuración del origen de datos Saro.
namespace	string	El espacio de nombres del origen de datos Saro.	TEST_dump_demo_sj_na61hunbu2_share_holo
tableName	string	El nombre de la tabla del origen de datos de Saro.	llm
autoBuildIndex	boolean	Especifica si la compilación completa automática está habilitada.	true
processParallelNum	integer	El número de procesos de compilación completa simultáneos.	2
createTime	string	La hora de creación. El formato es AAAA-MM-DD HH:mm:ss.	2024-05-21 16:05:26
updateTime	string	La hora de actualización. El formato es AAAA-MM-DD HH:mm:ss.	2024-05-21 16:05:26
cluster	object	La información del clúster.
	object	La información del clúster.
buildParallelNum	integer	El número de tareas de compilación completa simultáneas.	2
mergeParallelNum	integer	El número de tareas de fusión de compilación completa simultáneas.	2
config	object	La información de configuración.
	object	La información de configuración.
	object	La información del elemento de configuración secundario.
name	string	The configuration name.	ha-cn-pl32rf0****_offline_adv_v1
updateTime	string	La hora de actualización. El valor es una marca de tiempo UNIX en milisegundos.	1716258634000
desc	string	La descripción de la configuración avanzada.	Note Information
configWhenBuild	object	La configuración que entra en vigor en la próxima compilación.
	object	La configuración que entra en vigor en la próxima compilación.
	object	Los elementos de configuración secundarios que entrarán en vigor la próxima vez.
name	string	The configuration name.	ha-cn-pl32rf0****_offline_adv_v1
updateTime	string	La hora de actualización. El valor es una marca de tiempo UNIX en milisegundos.	1716258634000
desc	string	La descripción de la configuración avanzada.	Note Information
extend	object	La información extendida.
	array	La información extendida.
	string	La información extendida.	Extended Information

Respuesta de ejemplo

Respuesta exitosa

{
    "requestId": "e1eef569-1ff7-4bf8-acf7-1cecca9894ce",
    "result": {
        "name": "index-name",
        "dataSource": "ha-cn-xxx-index-name",
        "domain": "test", // El nombre de despliegue del origen de datos.
        "partition": 2,
        "indexStatus": "IN_USE",
        "content": "{\n\t\"summarys\":{\n\t\t\"parameter\":{\n\t\t\t\"file_compressor\":\"zstd\"\n\t\t},\n\t\t\"summary_fields\":[\n\t\t\t\"id\"\n\t\t]\n\t},\n\t\"file_compress\":[\n\t\t{\n\t\t\t\"name\":\"file_compressor\",\n\t\t\t\"type\":\"zstd\"\n\t\t},\n\t\t{\n\t\t\t\"name\":\"no_compressor\",\n\t\t\t\"type\":\"\"\n\t\t}\n\t],\n\t\"indexs\":[\n\t\t{\n\t\t\t\"index_fields\":\"name\",\n\t\t\t\"index_name\":\"ids\",\n\t\t\t\"index_type\":\"STRING\"\n\t\t},\n\t\t{\n\t\t\t\"has_primary_key_attribute\":true,\n\t\t\t\"index_fields\":\"id\",\n\t\t\t\"is_primary_key_sorted\":false,\n\t\t\t\"index_name\":\"id\",\n\t\t\t\"index_type\":\"PRIMARYKEY64\"\n\t\t}\n\t],\n\t\"attributes\":[\n\t\t{\n\t\t\t\"file_compress\":\"no_compressor\",\n\t\t\t\"field_name\":\"id\"\n\t\t}\n\t],\n\t\"fields\":[\n\t\t{\n\t\t\t\"user_defined_param\":{},\n\t\t\t\"compress_type\":\"uniq\",\n\t\t\t\"field_type\":\"STRING\",\n\t\t\t\"field_name\":\"id\"\n\t\t},\n\t\t{\n\t\t\t\"compress_type\":\"uniq\",\n\t\t\t\"field_type\":\"STRING\",\n\t\t\t\"field_name\":\"name\"\n\t\t}\n\t],\n\t\"table_name\":\"api\"\n}",
        "extend": {
            "vector": [
                "vector"
            ],
            "embeding": [
                "id"
            ],
            "description": [
                "{\"feild2\":\"Nota 2\"}",
                "{\"feild3\":\"Nota 3\"}"
            ]
        },
        "cluster": {
            "build_parallel_num": "2",
            "merge_parallel_num": "2"
        },
        "dataSourceInfo": {
            "type": "odps",
            "dataSource": "ha-cn-xxx-index-name",
            "processPartitionCount": 2,
            "domain": "test",
            "autoBuildIndex": true,
            "config": {
                "project": "tisplus_dev",
                "table": "tisplus_one_key_build_station_template_table_test",
                "partition": "ds=12345",
                "accesskeyId": "root",
                "accesskeySecret": "root123",
                "endpoint": "http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api"
            },
            "saroConfig": {
                "namespace": "TEST_dump_demo_sj_na61hunbu2_share_holo",
                "tableName": "dump_odps_demo"
            },
            "processParallelNum": 2,
           "swiftConfig":{
              "topic":"ha-cn-xxx-index-name"
            }
        },
        "config": {
            "OFFLINE_DICT": {
                "name": "ha-cn-finxmo71065_offline_dict_v2",
                "updateTime": 1709259817000,
                "desc": "Descripción"
            },
            "OFFLINE_TABLE": {
                "name": "ha-cn-finxmo71065_table_ha-cn-finxmo71065_test_saro_v2",
                "updateTime": 1709261682000,
                "desc": "Descripción"
            },
            "OFFLINE_COMMON": {
                "name": "ha-cn-finxmo71065_offline_adv_v2",
                "updateTime": 1709259817000,
                "desc": "Descripción"
            },
            "OFFLINE_PLUGIN": {
                "name": "ha-cn-finxmo71065_offline_plugin_v2",
                "updateTime": 1709259817000,
                "desc": "Descripción"
            },
            "OFFLINE_INDEX": {
                "name": "ha-cn-finxmo71065@ha-cn-finxmo71065_test_saro@test_saro@index_config_v2",
                "updateTime": 1709259817000,
                "desc": "Descripción"
            }
        },
        "configWhenBuild": {
            "OFFLINE_DICT": {
                "name": "ha-cn-finxmo71065_offline_dict_v2",
                "updateTime": 1709259817000,
                "desc": "Descripción"
            },
            "OFFLINE_TABLE": {
                "name": "ha-cn-finxmo71065_table_ha-cn-finxmo71065_test_saro_v2",
                "updateTime": 1709261682000,
                "desc": "Descripción"
            },
            "OFFLINE_COMMON": {
                "name": "ha-cn-finxmo71065_offline_adv_v2",
                "updateTime": 1709259817000,
                "desc": "Descripción"
            },
            "OFFLINE_PLUGIN": {
                "name": "ha-cn-finxmo71065_offline_plugin_v2",
                "updateTime": 1709259817000,
                "desc": "Descripción"
            },
            "OFFLINE_INDEX": {
                "name": "ha-cn-finxmo71065@ha-cn-finxmo71065_test_saro@test_saro@index_config_v2",
                "updateTime": 1709259817000,
                "desc": "Descripción"
            }
        }
    }

Ejemplos

Respuesta exitosa

JSON Formato

{
  "requestId": "4FB0325E-8C37-5525-96AC-0333523170A3",
  "result": {
    "name": "test_api",
    "versions": [
      {
        "desc": "Index Note",
        "files": [
          {
            "fullPathName": "/qrs.json\n",
            "isDir": true,
            "isTemplate": true,
            "name": "qrs.json"
          }
        ],
        "name": "test",
        "status": "PUBLISH",
        "updateTime": 1718846192,
        "versionId": 1
      }
    ],
    "dataSource": "ha-cn-pl32rf0****_test_api\n",
    "domain": "sz_vpc_domain_1",
    "indexStatus": "IN_USE",
    "content": "{\"summarys\":{\"parameter\":{\"file_compressor\":\"zstd\"},\"summary_fields\":[\"id\"]},\"file_compress\":[{\"name\":\"file_compressor\",\"type\":\"zstd\"},{\"name\":\"no_compressor\",\"type\":\"\"}],\"indexs\":[{\"index_fields\":\"name\",\"index_name\":\"ids\",\"index_type\":\"STRING\"},{\"has_primary_key_attribute\":true,\"index_fields\":\"id\",\"is_primary_key_sorted\":false,\"index_name\":\"id\",\"index_type\":\"PRIMARYKEY64\"}],\"attributes\":[{\"file_compress\":\"no_compressor\",\"field_name\":\"id\"}],\"fields\":[{\"user_defined_param\":{},\"compress_type\":\"uniq\",\"field_type\":\"STRING\",\"field_name\":\"id\"},{\"compress_type\":\"uniq\",\"field_type\":\"STRING\",\"field_name\":\"name\"}],\"table_name\":\"api\"}",
    "partition": 2,
    "fullVersion": 1688523414,
    "fullUpdateTime": "2024-06-20 08:52:54",
    "incUpdateTime": "2024-06-20 08:52:54",
    "indexSize": 4689,
    "description": "note",
    "dataSourceInfo": {
      "processPartitionCount": 2,
      "name": "ha-cn-pl32rf0****_test_api\n",
      "type": "odps",
      "domain": "vpc_hz_domain_1",
      "config": {
        "endpoint": "http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api",
        "accessKey": "L***p",
        "accessSecret": "5**9a6",
        "project": "tisplus_dev",
        "partition": "ds=20220713",
        "table": "dump_odps_demo",
        "namespace": "TEST_dump_demo_sj_na61hunbu2_share_holo",
        "path": "http://test_opensearch/sift_oss_test.data",
        "ossPath": "/test_opensearch/sift_oss_test.data",
        "bucket": "ha3test-oss",
        "format": "ha3",
        "catalog": "clg-paimon-21cc136237a6457f8618f5f82d116d7e",
        "database": "dlf_test",
        "tag": "test_tag"
      },
      "saroConfig": {
        "namespace": "TEST_dump_demo_sj_na61hunbu2_share_holo",
        "tableName": "llm"
      },
      "autoBuildIndex": true,
      "processParallelNum": 2
    },
    "createTime": "2024-05-21 16:05:26",
    "updateTime": "2024-05-21 16:05:26",
    "cluster": {
      "key": {
        "buildParallelNum": 2,
        "mergeParallelNum": 2
      }
    },
    "config": {
      "key": {
        "key": {
          "name": "\nha-cn-pl32rf0****_offline_adv_v1",
          "updateTime": "1716258634000",
          "desc": "Note Information"
        }
      }
    },
    "configWhenBuild": {
      "key": {
        "key": {
          "name": "\nha-cn-pl32rf0****_offline_adv_v1",
          "updateTime": "1716258634000",
          "desc": "Note Information"
        }
      }
    },
    "extend": {
      "key": [
        "Extended Information"
      ]
    }
  }
}

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.