Descripción general de la API - OpenSearch - Centro de documentación de Alibaba Cloud

Estándares de API y SDK preconfigurados multilenguaje

La OpenAPI de este producto (searchengine/2021-10-25) utiliza el estilo de firma ROA. Se han encapsulado SDK para los lenguajes de programación más comunes con el fin de facilitar el desarrollo. Los desarrolladores pueden descargar el SDK para invocar directamente la OpenAPI de este producto sin preocuparse por los detalles técnicos. Si el SDK existente no satisface sus necesidades, utilice el mecanismo de firma para una integración con autofirma. Dado que los detalles de la autofirma son muy complejos, este proceso puede tardar alrededor de 5 días hábiles. Por lo tanto, se recomienda unirse a nuestro grupo de servicio de DingTalk (147535001692) para llevar a cabo la integración de firmas bajo la guía de expertos.

Antes de usar la API, prepare su cuenta de identidad y su clave de acceso (AccessKey) para acceder eficazmente a la API mediante herramientas cliente (como SDK y CLI). Para obtener más información, consulte Obtener un AccessKey.

Escenarios de firma personalizada

Si su escenario empresarial tiene requisitos especiales y necesita integrar la API mediante autofirma, se recomienda consultar primero a nuestro equipo de soporte técnico (grupo de servicio de DingTalk: 147535001692) para obtener orientación profesional y garantizar una integración eficiente.

Preparación de cuenta y seguridad

Las cuentas de Alibaba Cloud tienen permisos administrativos completos sobre todos los recursos. Si un AccessKey se ve comprometido, todos los recursos asociados corren el riesgo de sufrir accesos no autorizados. Para garantizar la seguridad, se recomienda crear un RAM user con permisos de acceso exclusivos a la API y configurar su AccessKey, además de establecer directivas de RAM basadas en el principio de menor privilegio (PoLP). Utilice la cuenta de Alibaba Cloud únicamente en escenarios específicos donde se requieran explícitamente sus permisos.

Instancias

API	Título	Descripción
CreatePublicUrl	Habilitar nombre de dominio público.	Habilita el nombre de dominio público.
DeletePublicUrl	Eliminar un nombre de dominio público.	Elimina un nombre de dominio público.
ModifyPublicUrlIpList	Modificar lista blanca de nombres de dominio públicos.	Modifica la lista blanca de nombres de dominio públicos.
ModifyPassword	Modificar contraseña de instancia.	Modifica la contraseña de una instancia.
ListInstanceSpecs	ListInstanceSpecs.	Consulta las especificaciones de una instancia.

Centro de configuración

API	Título	Descripción
Configuración de tabla en línea	Configuración de tabla en línea
GetIndexOnlineStrategy	GetIndexOnlineStrategy.	Consulta la política efectiva en línea de un índice.
ModifyIndexOnlineStrategy	ModifyIndexOnlineStrategy.	Modifica la política en línea de un índice.
ModifyOnlineConfig	ModifyOnlineConfig.	Modifica las configuraciones en línea.
ListOnlineConfigs	ListOnlineConfigs.	Consulta una configuración en línea.
Estructura de índices	Estructura de índices
ModifyIndex	Modificar un índice.	Modifica un índice.
StartIndex	StartIndex.	Reanuda un índice.
StopIndex	StopIndex.	Detiene un índice.
BuildIndex	BuildIndex.	Reconstruye un índice.
ModifyIndexVersion	ModifyIndexVersion.	Modifica la versión del índice de un clúster (reversión de versión de índice).
ModifyFile	ModifyFile.	Modifica un archivo.
PublishIndexVersion	PublishIndexVersion.	Publica una versión de índice especificada.
ModifyIndexPartition	ModifyIndexPartition.	Modifica la información de las particiones de índice.
GetIndexVersion	GetIndexVersion.	Consulta la información sobre las versiones de índice a las que se puede revertir la versión de índice actual.
ListIndexes	Obtener la lista de índices	Obtiene la lista de índices.
RecoverIndex	Recuperación de datos de un índice	Recupera datos de un índice.
Configuración avanzada	Configuración avanzada
CreateConfigDir	Crear un directorio de archivos en una configuración avanzada.	Crea un directorio de archivos en una configuración avanzada.
DeleteConfigDir	Eliminar una carpeta de configuración avanzada.	Elimina una carpeta de configuración avanzada.
ModifyAdvanceConfig	Modificar el contenido de archivos HTTP y Git	Modifica el contenido de los archivos HTTP y Git.
DeleteAdvanceConfig	DeleteAdvanceConfig.	Elimina los detalles de las configuraciones avanzadas.
ModifyAdvanceConfigFile	Modificar un diccionario.	Modifica un diccionario.
PublishAdvanceConfig	Publish an advanced version.	Publica una versión avanzada.
GetAdvanceConfig	GetAdvanceConfig	Consulta la información de una configuración avanzada.
GetAdvanceConfigFile	GetAdvanceConfigFile.	Consulta la información de un archivo de configuración avanzada.
ListAdvanceConfigDir	Obtener la lista de archivos en un directorio de configuración avanzada.	Obtiene la lista de archivos en un directorio de configuración avanzada.
ListAdvanceConfigs	Lista de configuraciones avanzadas	Consulta la lista de configuraciones avanzadas.
Configuración de origen de datos	Configuración de origen de datos
ModifyDataSourceDeploy	Modificar la información de despliegue del origen de datos.	Modifica la información de despliegue de un origen de datos.
ListDataSourceSchemas	ListDataSourceSchemas.	Consulta la información del esquema de un origen de datos.
ListDateSourceGenerations	Obtener información de retorno de datos históricos de un origen de datos	Obtiene la información de retorno de datos históricos de un origen de datos.
GetDataSourceDeploy	Información de despliegue del origen de datos	Obtiene la información de despliegue del origen de datos.

Centro de operaciones y mantenimiento

API	Título	Descripción
Desarrollo de SQL	Desarrollo de SQL
CloneSqlInstance	Clone SQL Instance.	Clona una instancia de SQL.
DeleteSqlInstance	DeleteSqlInstance.	Elimina una instancia de SQL.
ExecuteSqlInstance	Execute a SQL instance.	Ejecuta una instancia de SQL.
GetDatabaseSchema	GetDatabaseSchema.	Obtiene el esquema de una base de datos.
UpdateSqlInstanceContent	UpdateSqlInstanceContent.	Actualiza el contenido de una instancia SQL.
UpdateSqlInstanceName	UpdateSqlInstanceName.	Actualiza el nombre de una instancia SQL.
UpdateSqlInstanceParams	UpdateSqlInstanceParams.	Actualiza los parámetros de una instancia SQL.
RenameFolder	RenameFolder.	Cambia el nombre de una carpeta.
Historial de cambios	Historial de cambios
ListClusterTasks	Lista de tareas del clúster	Consulta las tareas del clúster.
ListDataSourceTasks	Lista de tareas de origen de datos	Obtiene las tareas de origen de datos.
ForceSwitch	ForceSwitch.	Realiza un cambio forzado.
Gestión de registros	Gestión de registros
ListLogs	ListLogs.	Consulta los registros de una instancia.
Gestión de despliegues	Gestión de despliegues
ModifyNodeConfig	ModifyNodeConfig.	Modifica un nodo.
GetDeployGraph	GetDeployGraph.	Muestra la descripción general del despliegue.
GetNodeConfig	Obtener información de configuración del nodo.	Obtiene la información de configuración de un nodo.
Gestión de operaciones	Gestión de operaciones
ListIndexRecoverRecords	Obtención de registros de recuperación de datos	Obtiene los registros de recuperación de datos.
ListPausePolicys	Listar políticas de pausa.	Consulta las políticas de pausa.
ModifyPausePolicy	ModifyPausePolicy.	Modifica la política de pausa.
RemoveCluster	RemoveCluster.	Elimina un clúster.
ModifyClusterDesc	ModifyClusterDesc.	Modifica la descripción de un clúster especificado.
ModifyClusterOfflineConfig	ModifyClusterOfflineConfig.	Modifica la información de configuración de un clúster.
ModifyClusterOnlineConfig	Modificar la configuración en línea del clúster.	Modifica la configuración en línea de un clúster.
GetCluster	Obtener detalles de un clúster específico	Consulta los detalles de un clúster específico.
GetClusterRunTimeInfo	Obtener información del clúster	Obtiene la información del clúster.
ListClusterNames	Listar nombres de clústeres.	Consulta los nombres de los clústeres.

Gestión de tablas

API	Título	Descripción
Gestión de alias de tabla	Gestión de alias de tabla
ModifyAlias	ModifyAlias.	Modifica un alias de tabla.
CreateTable	Crear una tabla de índices.	Crea una tabla de índices.
ModifyTable	Modificar una tabla de índices.	Modifica una tabla de índices.
DeleteTable	Eliminar tabla de índices.	Elimina una tabla de índices.
Reindex	Reconstruir un índice.	Reconstruye un índice.
ListTableGenerations	ListTableGenerations.	Consulta una lista de versiones de índice.
GetTableGeneration	GetTableGeneration	Consulta el estado de una versión de índice con base en el ID de la versión de índice completo.

Otros

API	Título	Descripción
ListPostQueryResult	ListPostQueryResult.	Obtiene los resultados de una prueba de búsqueda para una instancia de Retrieval-Augmented Generation Edition mediante el envío de una solicitud POST.
ListRestQueryResult	ListRestQueryResult.	Obtiene los resultados de prueba de una consulta de búsqueda REST para una instancia de Retrieval Engine Edition.
ListVectorQueryResult	ListVectorQueryResult.	Obtiene los resultados de una prueba de consulta vectorial en Vector Search Edition.
PushDocuments	PushDocuments.	Inserta documentos.
ListQueryResult	ListQueryResult.	Consulta el resultado de la consulta.
ModifyModel	ModifyModel.	Modifica los detalles y el estado de un modelo.
DebugModel	Debug a model.	Depura un modelo.
GetModel	Obtener detalles del modelo	Consulta la información de configuración detallada de un modelo específico por ID de instancia y nombre de modelo.
ListModels	Lista de modelos	Consulta una lista de modelos bajo condiciones especificadas por ID de instancia.
ModifySearcherReplica	ModifySearcherReplica.	Modifica el número de réplicas o fragmentos para los nodos de datos en una instancia.

Others

API	Título	Descripción
ChangeResourceGroup	ChangeResourceGroup.	Cambia el grupo de recursos de una instancia.
CreateAlias	Crear un alias.	Crea un alias.
CreateCluster	Agregar un clúster.	Agrega un clúster.
CreateConfigFile	Crear un archivo con configuraciones avanzadas.	Crea un archivo con configuraciones avanzadas.
CreateDataSource	Crear un origen de datos	Crea un origen de datos.
CreateFolder	Crear una carpeta.	Crea una carpeta.
CreateIndex	CreateIndex.	Crea un índice.
CreateInstance	Crear una instancia	Crea una instancia de Wentian Engine.
CreateModel	CreateModel.	Crea un modelo.
CreateSqlInstance	Crear una instancia de SQL.	Crea una instancia de SQL.
DeleteAlias	Eliminar un alias.	Elimina un alias.
DeleteConfigFile	Eliminar un archivo de configuración avanzada.	Elimina un archivo de configuración avanzada.
DeleteDataSource	DeleteDataSource.	Elimina un origen de datos especificado.
DeleteFolder	DeleteFolder.	Elimina una carpeta.
DeleteIndex	DeleteIndex.	Elimina un índice.
DeleteIndexVersion	DeleteIndexVersion.	Elimina la versión de un índice.
DeleteInstance	DeleteInstance.	Elimina una instancia especificada.
DeleteModel	DeleteModel.	Elimina un modelo.
DescribeRegions	DescribeRegions.	Consulta las regiones disponibles.
GetDataSource	GetDataSource.	Obtiene un origen de datos.
GetFile	GetFile.	Obtiene los detalles de una versión de índice.
GetIndex	Ver detalles de la tabla de índices	Obtiene los detalles de una versión de tabla de índices.
GetInstance	Detalles de la instancia	Obtiene los detalles de una instancia especificada por su ID de instancia.
GetSqlInstance	Obtener información de la instancia SQL.	Obtiene información de la instancia SQL.
GetTable	Obtener información de la tabla de índices.	Obtiene la información de la tabla de índices.
ListAliases	ListAliases.	Lista los alias de tabla.
ListClusters	ListClusters.	Consulta clústeres.
ListDatabases	ListDatabases.	Enumera las bases de datos existentes.
ListDataSources	ListDataSources.	Obtiene la lista de orígenes de datos.
ListInstances	Lista de instancias	Obtiene una lista de instancias.
ListSchemas	ListSchemas	Obtiene una lista de esquemas basados en una configuración de sincronización de datos.
ListTables	ListTables.	Consulta una lista de tablas de índice.
ListTagResources	ListTagResources.	Consulta las etiquetas asociadas a uno o más recursos.
ListTasks	ListTasks.	Obtiene el historial de cambios de una instancia.
StopTask	StopTask.	Detiene una tarea de FSM.
TagResources	TagResources.	Agrega o actualiza etiquetas para múltiples recursos.
UntagResources	UntagResources.	Elimina etiquetas de un lote de recursos.
UpdateInstance	Modificar la configuración de una instancia especificada	Modifica la configuración de una instancia especificada.