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 (OpenSearch/2017-12-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 de aplicación

API	Título	Descripción
Gestión de aplicaciones	Gestión de aplicaciones
DescribeAppGroup	Ver detalles de la instancia de la aplicación.	Consulta los detalles de una aplicación de OpenSearch.
RenewAppGroup	RenewAppGroup.	Renueva una aplicación. Esta operación de API no está disponible. Para renovar una aplicación, utilice la consola de OpenSearch.
CreateAppGroup	Crear una aplicación.	Crea una aplicación de OpenSearch.
ModifyAppGroup	ModifyAppGroup.	Modifica las propiedades de una aplicación de OpenSearch o establece su versión en línea.
ModifyAppGroupQuota	Modificar cuota de la aplicación.	Modifica la cuota de una aplicación de OpenSearch.
UpdateAppGroupDeleteProtection	UpdateAppGroupDeleteProtection.	Actualiza el estado de protección contra eliminación de un grupo de aplicaciones.
RemoveAppGroup	RemoveAppGroup.	Elimina una aplicación de OpenSearch.
ListAppGroups	Obtención de la lista de aplicaciones.	Obtiene la lista de aplicaciones de OpenSearch.
Versiones de aplicación	Versiones de aplicación
CreateApp	Crear una versión de aplicación.	Crea una versión para una aplicación de OpenSearch.
RemoveApp	RemoveApp.	Elimina una versión de una aplicación de OpenSearch.
DescribeApps	Obtener la lista de versiones de una aplicación.	Obtiene la lista de versiones de una aplicación de OpenSearch.
DescribeApp	Ver detalles de la versión de la aplicación.	Consulta los detalles de una versión específica de la aplicación OpenSearch.
DescribeAppStatistics	DescribeAppStatistics.	Consulta las estadísticas de una versión de una aplicación de OpenSearch.

Funciones relacionadas con instancias

API	Título	Descripción
Escalado elástico basado en tiempo	Escalado elástico basado en tiempo
CreateElasticPlan	Crear un plan elástico.	Crea un plan elástico.
RemoveElasticPlan	Eliminar un plan elástico.	Obtiene los detalles de un plan elástico.
ModifyElasticPlan	Actualizar un plan elástico.	Actualiza un plan elástico.
ListElasticPlans	Obtener una lista de planes elásticos.	Obtiene una lista de planes elásticos.
DescribeElasticPlan	Obtener detalles del plan elástico.	Obtiene los detalles de un plan elástico.
Analizadores personalizados	Analizadores personalizados
ListUserAnalyzers	Obtener la lista de tokenizadores personalizados de un usuario.	Obtiene la lista de tokenizadores personalizados de un usuario.
CreateUserAnalyzer	Crear analizador personalizado.	Crea un analizador personalizado.
DescribeUserAnalyzer	DescribeUserAnalyzer.	Obtiene los detalles de un analizador personalizado.
RemoveUserAnalyzer	RemoveUserAnalyzer.	Elimina un analizador personalizado.
ListUserAnalyzerEntries	ListUserAnalyzerEntries.	Consulta las entradas de un analizador personalizado.
PushUserAnalyzerEntries	PushUserAnalyzerEntries.	Aplica cambios a las entradas de un analizador personalizado.
Pruebas A/B	Pruebas A/B
Escenarios de experimentos	Escenarios de experimentos
ListABTestScenes	ListABTestScenes.	Consulta escenarios de prueba.
CreateABTestScene	Crear una escena de experimento ABTest.	Crea una escena de experimento ABTest.
DescribeABTestScene	DescribeABTestScene.	Consulta un escenario de prueba A/B.
UpdateABTestScene	Modificar una escena de experimento.	Modifica una escena de experimento ABTest.
DeleteABTestScene	Eliminar un escenario de experimento ABTest.	Elimina un escenario de experimento ABTest.
Grupos de experimentos	Grupos de experimentos
ListABTestGroups	ListABTestGroups.	Obtiene una lista de grupos de prueba.
CreateABTestGroup	CreateABTestGroup.	Crea un grupo de experimentos.
DeleteABTestGroup	Eliminar un grupo de experimentos ABTest.	Elimina un grupo de experimentos ABTest.
DescribeABTestGroup	DescribeABTestGroup.	Obtiene los detalles de un grupo de prueba A/B.
UpdateABTestGroup	UpdateABTestGroup.	Modifica un grupo de prueba.
Experimentos	Experimentos
ListABTestExperiments	Listar experimentos de ABTest.	Lista los experimentos de ABTest.
CreateABTestExperiment	Crear un experimento de aBTest.	Crea un experimento.
DescribeABTestExperiment	DescribeABTestExperiment.	Obtiene los detalles de un experimento.
UpdateABTestExperiment	UpdateABTestExperiment.	Actualiza los parámetros de un experimento de prueba A/B.
DeleteABTestExperiment	Eliminar un experimento de ABTest.	Elimina un experimento de ABTest.
Listas blancas	Listas blancas
ListABTestFixedFlowDividers	ListABTestFixedFlowDividers.	Enumera las listas blancas.
UpdateABTestFixedFlowDividers	UpdateABTestFixedFlowDividers.	Actualiza los datos de la lista blanca.
Expresiones de ordenamiento grueso	Expresiones de ordenamiento grueso
ListFirstRanks	Obtener la lista de configuraciones de ordenamiento preliminar para una versión especificada de la aplicación.	Obtiene la lista de configuraciones de ordenamiento preliminar para una versión especificada de la aplicación OpenSearch.
CreateFirstRank	Crear una configuración de expresión de ordenamiento preliminar para una versión de aplicación.	Crea una configuración de expresión de ordenamiento preliminar para una versión de aplicación de OpenSearch. Cuando dryRun=true, se valida la expresión de ordenamiento preliminar. De forma predeterminada, no se pasa dryRun y su valor es false.
DescribeFirstRank	DescribeFirstRank.	Consulta la expresión de clasificación aproximada configurada para una versión de aplicación de OpenSearch.
RemoveFirstRank	Eliminar regla de ordenamiento preliminar.	Elimina la configuración de ordenamiento preliminar de una versión de aplicación de OpenSearch especificada.
ModifyFirstRank	ModifyFirstRank.	Modifica la expresión de ordenamiento preliminar para una versión de aplicación de OpenSearch. Si establece el parámetro dryRun en true, esta operación valida la expresión de ordenamiento preliminar modificada. El valor predeterminado de este parámetro es false.
Expresiones de ordenamiento fino	Expresiones de ordenamiento fino
ListSecondRanks	ListSecondRanks.	Enumera las expresiones de ordenamiento fino para una versión específica de una aplicación de OpenSearch.
CreateSecondRank	Crear una configuración de expresión de clasificación fina para una versión de aplicación.	Crea una configuración de expresión de clasificación fina para una versión de aplicación. Cuando dryRun se establece en true, solo se valida la expresión de clasificación fina. De forma predeterminada, dryRun se establece en false si no se especifica.
DescribeSecondRank	Ver configuración de expresión de clasificación fina de una versión de aplicación.	Consulta la configuración de expresión de clasificación fina de una versión de aplicación de OpenSearch.
ModifySecondRank	ModifySecondRank.	Modifica una expresión de clasificación fina para una versión de aplicación de OpenSearch. Si establece `dryRun` en `true`, se valida la expresión de clasificación fina modificada. El parámetro `dryRun` es `false` de forma predeterminada.
RemoveSecondRank	RemoveSecondRank.	Elimina una expresión de clasificación fina de una versión de una aplicación de OpenSearch.
Analizadores de consultas	Analizadores de consultas
ListQueryProcessors	ListQueryProcessors.	Consulta una lista de reglas de análisis de consultas configuradas para una versión específica de una aplicación de OpenSearch.
CreateQueryProcessor	Crear una regla de análisis de consultas.	Crea una regla de análisis de consultas. Cuando dryRun=true, el sistema valida la regla de análisis de consultas. De forma predeterminada, dryRun no se especifica y su valor es false.
ModifyQueryProcessor	ModifyQueryProcessor.	Modifica una regla de análisis de consultas para una versión específica de la aplicación. Si establece el parámetro dryRun en true, esta operación verifica la regla de análisis de consultas especificada. Si no especifica el parámetro dryRun, el valor predeterminado es false.
RemoveQueryProcessor	Eliminar una regla de análisis de consultas para una versión de aplicación especificada.	Elimina una regla de análisis de consultas para una versión de aplicación de OpenSearch especificada.
DescribeQueryProcessor	DescribeQueryProcessor.	Describe una regla de análisis de consultas para una versión de una aplicación de OpenSearch.
ListQueryProcessorNers	Obtener la configuración de importancia de tipos de entidades recomendada.	Obtiene la configuración de importancia recomendada para los tipos de entidades de Reconocimiento de Entidades Nombradas.
ListQueryProcessorAnalyzerResults	ListQueryProcessorAnalyzerResults.	Prueba los resultados del análisis de consultas. Esta operación solo se puede invocar para aplicaciones existentes de la edición compatible con código abierto.
Diccionarios de intervención	Diccionarios de intervención
ListInterventionDictionaries	ListInterventionDictionaries.	Obtiene una lista de diccionarios de intervención.
CreateInterventionDictionary	Crear un diccionario de intervención.	Crea un diccionario de intervención.
DescribeInterventionDictionary	DescribeInterventionDictionary.	Obtiene los detalles de un diccionario de intervención.
RemoveInterventionDictionary	Eliminar un diccionario de intervención.	Elimina un diccionario de intervención.
ListInterventionDictionaryEntries	Listar entradas del diccionario de intervención.	Consulta las entradas de intervención en un diccionario de intervención.
PushInterventionDictionaryEntries	Aceptar cambios en las entradas de intervención.	Acepta cambios en las entradas de intervención.
ListInterventionDictionaryRelatedEntities	ListInterventionDictionaryRelatedEntities.	Consulta la lista de recursos asociados con un diccionario de intervención. Si un procesador de consultas (QP) hace referencia al diccionario, la operación devuelve todas las aplicaciones asociadas e información sobre el QP.
ListInterventionDictionaryNerResults	ListInterventionDictionaryNerResults.	Obtiene los resultados del reconocimiento de entidades con nombre (NER).
Asistente de optimización	Asistente de optimización
EnableSlowQuery	EnableSlowQuery.	Habilita el servicio de consultas lentas para el optimizador.
DisableSlowQuery	DisableSlowQuery.	Deshabilita el servicio de consultas lentas para Search Diagnoser.
DescribeSlowQueryStatus	DescribeSlowQueryStatus.	Consulta el estado de la función de consultas lentas.
StartSlowQueryAnalyzer	StartSlowQueryAnalyzer.	Inicia una tarea de análisis de consultas lentas.
ListSlowQueryQueries	Listar sentencias de consulta lenta.	Lista las sentencias de consulta lenta del asesor de optimización.
ListSlowQueryCategories	Enumerar sugerencias de optimización de consultas lentas del asesor de optimización.	Enumera las sugerencias de optimización de consultas lentas del asesor de optimización.
Aprobación de cuotas	Aprobación de cuotas
ListQuotaReviewTasks	ListQuotaReviewTasks.	Lista los tickets de aprobación de cuota para una aplicación de OpenSearch especificada.
Tareas programadas	Tareas programadas
ListScheduledTasks	ListScheduledTasks.	Consulta una lista de tareas programadas para una aplicación de OpenSearch.
CreateScheduledTask	Crear una tarea programada para una aplicación.	Crea una tarea programada para una aplicación de OpenSearch.
DescribeScheduledTask	DescribeScheduledTask.	Consulta una tarea programada para una aplicación de OpenSearch.
ModifyScheduledTask	ModifyScheduledTask.	Modifica una tarea programada.
RemoveScheduledTask	RemoveScheduledTask.	Elimina una tarea programada de una aplicación de OpenSearch.
Estrategias de búsqueda	Estrategias de búsqueda
ListSortExpressions	Obtener lista de expresiones de ordenamiento para una versión de aplicación.	Obtiene la lista de expresiones de ordenamiento para una versión de aplicación.
Instancias del motor Elasticsearch	Instancias del motor Elasticsearch
UnbindEsInstance	UnbindEsInstance.	Desvincula una instancia de Elasticsearch de una aplicación de OpenSearch.
BindEsInstance	BindEsInstance.	Vincula una instancia de Elasticsearch como dependencia.
BindESUserAnalyzer	Asociar un analizador personalizado con una instancia de Elasticsearch.	Asocia un analizador personalizado con una instancia de Elasticsearch.
UnbindESUserAnalyzer	Desvincular un analizador personalizado de una instancia de Elasticsearch.	Desvincula un analizador personalizado de una instancia de Elasticsearch.
Flujos de procesamiento actuales	Flujos de procesamiento actuales
ListProceedings	Lista de tareas de importación sin conexión en curso para el grupo de aplicaciones	Obtiene el flujo de procesamiento actual.
Estadísticas	Estadísticas
ListStatisticLogs	ListStatisticLogs.	Consulta estadísticas de registros, como registros de errores de aplicaciones, clasificaciones de palabras clave y registros de consultas lentas.
ListStatisticReport	ListStatisticReport.	Consulta informes estadísticos, como informes de aplicación, sugerencias desplegables, sugerencias de búsqueda principal, pruebas A/B e informes de calidad de datos.
Scripts de Cava	Scripts de Cava
ListSortScripts	ListSortScripts.	Lista todos los scripts de ordenamiento para una versión de aplicación especificada.
UpdateSortScript	Modify sort script description.	Modifica la descripción de un script de ordenamiento.
SaveSortScriptFile	SaveSortScriptFile.	Carga un script de ordenamiento.
ReleaseSortScript	ReleaseSortScript.	Libera un script de ordenamiento.
GetSortScriptFile	Obtener contenido del script de ordenamiento.	Obtiene el contenido de un script de ordenamiento.
GetSortScript	Obtener detalles del script de ordenamiento.	Obtiene los detalles de un script de ordenamiento.
GetScriptFileNames	GetScriptFileNames.	Obtiene los nombres de todos los archivos en un script especificado para una versión de aplicación específica.
DeleteSortScriptFile	DeleteSortScriptFile.	Elimina un archivo de script.
DeleteSortScript	DeleteSortScript.	Elimina un script de ordenamiento.
CreateSortScript	Crear un script de ordenamiento.	Crea un script de ordenamiento.
CompileSortScript	Compilar un script de ordenamiento.	Compila un script de ordenamiento.
Políticas de consulta	Políticas de consulta
UpdateSearchStrategy	UpdateSearchStrategy.	Esta operación admite ejecuciones de prueba.
RemoveSearchStrategy	Eliminar una política de análisis de consultas.	Elimina una política de análisis de consultas.
ListSearchStrategies	ListSearchStrategies.	Obtiene los detalles de las políticas de consulta.
GetSearchStrategy	GetSearchStrategy.	Obtiene los detalles de una política de consulta.
CreateSearchStrategy	Crear una política de análisis de consultas.	Crea una política de análisis de consultas.

Funciones relacionadas con versiones

API	Título	Descripción
Campos de visualización predeterminados	Campos de visualización predeterminados
UpdateFetchFields	UpdateFetchFields.	Esta operación admite ejecuciones de prueba.
Resúmenes de resultados de búsqueda	Resúmenes de resultados de búsqueda
UpdateSummaries	UpdateSummaries.	Esta operación admite ejecuciones de prueba.

Funciones relacionadas con algoritmos

API	Título	Descripción
CreateFunctionResource	Crear un recurso de algoritmo.	Crea un recurso de algoritmo bajo una característica especificada.
GetFunctionCurrentVersion	GetFunctionCurrentVersion.	Obtiene la información de versión de la función que se utiliza para crear una instancia.
GetFunctionVersion	GetFunctionVersion.	Consulta la información sobre una versión de función.
GetFunctionDefaultInstance	Obtener instancia predeterminada.	Obtiene la instancia de algoritmo predeterminada utilizada por una aplicación.
UpdateFunctionDefaultInstance	UpdateFunctionDefaultInstance.	Establece la instancia de algoritmo predeterminada para la aplicación especificada. La nueva instancia de algoritmo sobrescribe automáticamente la instancia predeterminada configurada previamente. Si no se especifica ninguna instancia, se cancela la instancia predeterminada.
ListFunctionTasks	Obtener registros de entrenamiento.	Obtiene los registros de entrenamiento. Los resultados se ordenan por hora de inicio en orden descendente.
GetFunctionTask	Obtener detalles del entrenamiento.	Obtiene los detalles del entrenamiento.
DeleteFunctionTask	DeleteFunctionTask.	Elimina un registro de entrenamiento. No se puede eliminar un registro de entrenamiento que esté en curso.
CreateFunctionTask	Iniciar entrenamiento de algoritmo.	Inicia una tarea de entrenamiento.
ListFunctionInstances	Obtener lista de instancias.	Obtiene todas las instancias que cumplen con las condiciones especificadas del usuario actual.
GetFunctionInstance	GetFunctionInstance.	Consulta una instancia de algoritmo por nombre de instancia.
DeleteFunctionInstance	Eliminar una instancia de algoritmo.	Elimina una instancia de algoritmo. Antes de eliminarla, asegúrese de que la instancia no esté en uso para evitar afectar los servicios en línea.
UpdateFunctionInstance	Actualizar una instancia de algoritmo	Actualiza la información de la instancia según el nombre de la instancia.
GetFunctionResource	Get function resource.	Obtiene el recurso de algoritmo especificado.
ListFunctionResources	ListFunctionResources.	Lista los recursos de algoritmo.
DeleteFunctionResource	DeleteFunctionResource.	Elimina un recurso de algoritmo especificado.
UpdateFunctionResource	Actualizar un recurso de algoritmo.	Actualiza un recurso de algoritmo.
CreateFunctionInstance	Crear una instancia de algoritmo	Crea una instancia de algoritmo para una función especificada.

Otros documentos (no incluidos en este directorio)

API	Título	Descripción
ValidateDataSources	ValidateDataSources.	Valida orígenes de datos.
ReplaceAppGroupCommodityCode	ReplaceAppGroupCommodityCode.	Convierte una aplicación basada en servicio a una aplicación basada en instancia.
ListDataSourceTables	Obtener la lista de orígenes de datos de una instancia especificada.	Obtiene todos los datos de un origen de datos especificado.
ListDataSourceTableFields	Obtener todos los campos de una tabla de datos especificada.	Obtiene todos los campos de una tabla de datos especificada. Esta es una operación interna.
GetDomain	GetDomain.	Obtiene el tipo de industria.
GenerateMergedTable	GenerateMergedTable.	Consulta la información sobre una tabla ancha que se genera después de realizar una operación JOIN en varias tablas.
DescribeRegions	DescribeRegions.	Obtiene los endpoints de todas las regiones.

Otros

API	Título	Descripción
DescribeDataCollction	DescribeDataCollction.	Obtiene los detalles de una recopilación de datos para una aplicación especificada.
ListDataCollections	ListDataCollections.	Obtiene la lista de verificación de recopilación de datos de una aplicación de OpenSearch.
RemoveDataCollection	RemoveDataCollection.	Deshabilita la recopilación de datos.
UntagResources	Quitar etiquetas de recursos.	Elimina etiquetas de los recursos.
ListTagResources	ListTagResources.	Consulta las etiquetas de los recursos especificados.
TagResources	TagResources.	Agrega etiquetas a los recursos.
CreateAppGroupCredentials	Crear credencial de grupo de aplicaciones.	Crea una credencial de acceso para un grupo de aplicaciones especificado bajo demanda. Admite el modo dryRun para obtener una vista previa de la operación.