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

Descripción de la operación

Método

POST

URI

/openapi/ha3/instances/{instanceId}/actions/build-index

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

update

*Instance

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

Ninguna

Sintaxis de la solicitud

POST /openapi/ha3/instances/{instanceId}/actions/build-index 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****

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
body	object	No	La carga útil completa de la solicitud como una cadena JSON. Para obtener más detalles, consulte la siguiente información.	{}
dataSourceName	string	No	El nombre del origen de datos.	ha-cn-pl32rf0****_test_api
domain	string	No	El centro de datos del origen de datos.	sz_vpc_domain_1
dataSourceType	string	No	El tipo del origen de datos.	odps
partition	string	No	Obligatorio si dataSourceType se establece en odps.	ds=20201010
dataTimeSec	integer	No	La marca de tiempo UNIX en segundos. Este parámetro es un número entero. Este parámetro es obligatorio si los datos se envían al origen de datos mediante una API.	1640867288
buildMode	string	No	El método para reconstruir el índice. Valores válidos: api e indexRecover.	api
generation	integer	No	El ID de backfill.	160131146
tag	string	No	La etiqueta del origen de datos de Data Lake Formation (DLF).	test
path	string	No	La ruta relativa.	/test/dir

Ejemplos de solicitud

POST /openapi/ha3/instances/ha3_instance_name/actions/build-index

 {
    "dataSourceName": "my_data_source",
    "domain": "test", // El despliegue del origen de datos.
    "indexes": [
      "index1",
      "index2"
    ],
    "dataSourceType": "odps", // Obligatorio. Valores válidos: odps y swift.
    "partition": "20201010", // Obligatorio si dataSourceType se establece en odps.
    "dataTimeSec": 1640867288 // La marca de tiempo UNIX en segundos. Este parámetro es un número entero. Obligatorio si los datos se envían al origen de datos mediante una API.
  }

{
    "dataSourceName": "my_data_source",
    "domain": "test", // El despliegue del origen de datos.
    "indexes": [
      "index1",
      "index2"
    ],
    "dataSourceType": "swift", // Obligatorio. Valores válidos: odps y swift.
    "partition": "20201010", // Obligatorio si dataSourceType se establece en odps.
    "dataTimeSec": 1640867288 // La marca de tiempo UNIX en segundos. Este parámetro es un número entero. Obligatorio si los datos se envían al origen de datos mediante una API.
  }

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Esquema de la respuesta.
requestId	string	El ID de la solicitud.	407BFD91-DE7D-50BA-8F88-CDE52A3B5E46
result	object	El resultado devuelto.	{}

Ejemplos de respuesta

Ejemplo de respuesta correcta

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

Para obtener más información, consulte Estructura de la respuesta.

Ejemplos

Respuesta exitosa

JSON Formato

{
  "requestId": "407BFD91-DE7D-50BA-8F88-CDE52A3B5E46",
  "result": {}
}

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.