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

Descripción de la operación

Método

GET

URI

/openapi/ha3/instances/{instanceId}/indexes/{indexName}/versions/{versionName}/file

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

get

*Instance

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

Ninguna

Sintaxis de la solicitud

GET /openapi/ha3/instances/{instanceId}/indexes/{indexName}/versions/{versionName}/file 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
versionName	string	Sí	El nombre de la versión.	ha-cn-pl32rf0**@ha-cn-pl32rf0**_test_api@bj_vpc_domain_1@point_cloud_3d@index_config_edit

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
fileName	string	Sí	La ruta completa del archivo.	/schemas/automobile_vector_schema.json

Ejemplo de solicitud

GET  /openapi/ha3/instances/ose-test1/indexes/index1/versions/version1?fileName=/root/test.txt

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Esquema de la respuesta.
requestId	string	El ID de la solicitud.	2AE63638-5420-56DC-BF59-37D8174039A0
result	object	La información del índice.
name	string	El nombre del archivo.	testFile
fullPathName	string	La ruta completa del archivo.	/schema.json
dataSource	string	El origen de datos.	ha-cn-pl32rf0****_test_api
partition	integer	El número de fragmentos.	2
isDir	boolean	Indica si la ruta apunta a un directorio.	true
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"}
extend	object	La información extendida.
	array	La información extendida.
	string	La información extendida.

Ejemplo de respuesta

Respuesta exitosa

{
  "requestId": "e1eef569-1ff7-4bf8-acf7-1cecca9894ce",
  "result": {
    "name":"version1",  // El nombre del archivo
    "fullPathName": "/root/version1",   // La ruta completa del archivo
    "dataSource": "odps1", // El origen de datos
    "partition": 1,  // El fragmento
    "isDir": false, // Indica si la ruta apunta a un directorio
    "content": ""
  }
}

Ejemplos

Respuesta exitosa

JSON Formato

{
  "requestId": "2AE63638-5420-56DC-BF59-37D8174039A0",
  "result": {
    "name": "testFile",
    "fullPathName": "/schema.json",
    "dataSource": "ha-cn-pl32rf0****_test_api",
    "partition": 2,
    "isDir": true,
    "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\"}",
    "extend": {
      "key": [
        ""
      ]
    }
  }
}

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.