Présentation des API - OpenSearch - Centre de documentation Alibaba Cloud

Normes API et SDK multilingues prédéfinis

L'OpenAPI de ce produit (OpenSearch/2017-12-25) utilise le style de signature ROA. Des SDK sont disponibles pour les langages de programmation courants. Les développeurs peuvent télécharger le SDK pour appeler directement l'OpenAPI de ce produit, sans se soucier des détails techniques. Si le SDK existant ne répond pas à vos besoins, utilisez le mécanisme de signature pour une intégration par auto-signature. L'auto-signature étant particulièrement complexe, comptez environ 5 jours ouvrables. Nous vous recommandons donc de rejoindre notre groupe d'assistance DingTalk (147535001692) pour bénéficier d'un accompagnement expert lors de l'intégration.

Avant d'utiliser l'API, préparez votre compte d'identité et votre clé d'accès (AccessKey) afin d'accéder efficacement à l'API via des outils clients (tels que SDK et CLI). Pour plus d'informations, consultez Obtenir un AccessKey.

Scénarios de signature personnalisée

Si votre scénario métier présente des exigences particulières et nécessite une intégration par auto-signature, consultez d'abord notre équipe de support technique (groupe d'assistance DingTalk : 147535001692) pour obtenir un accompagnement professionnel et garantir une intégration efficace.

Préparation du compte et de la sécurité

Les comptes Alibaba Cloud disposent de permissions administratives complètes sur l'ensemble des ressources. En cas de compromission d'un AccessKey, toutes les ressources associées sont exposées à un risque d'accès non autorisé. Pour garantir la sécurité, créez un utilisateur RAM disposant uniquement de permissions d'accès API et configurez son AccessKey. Appliquez ensuite des politiques RAM selon le principe du moindre privilège (PoLP). N'utilisez le compte Alibaba Cloud que dans les scénarios spécifiques où ses permissions sont explicitement requises.

Instances d'application

API	Titre	Description
Gestion des applications	Gestion des applications
DescribeAppGroup	Détails de l'instance d'application.	Consulte les détails d'une application OpenSearch.
RenewAppGroup	RenewAppGroup.	Renouvelle une application. Cette opération d'API n'est pas disponible. Pour renouveler une application, utilisez la console OpenSearch.
CreateAppGroup	Créer une application.	Crée une application OpenSearch.
ModifyAppGroup	ModifyAppGroup.	Modifie les propriétés d'une application OpenSearch ou définit sa version en ligne.
ModifyAppGroupQuota	Modifier le quota de l'application.	Modifie le quota d'une application OpenSearch.
UpdateAppGroupDeleteProtection	UpdateAppGroupDeleteProtection.	Met à jour l'état de protection contre la suppression d'un groupe d'applications.
RemoveAppGroup	RemoveAppGroup.	Supprime une application OpenSearch.
ListAppGroups	Liste des applications	Obtient la liste des applications OpenSearch.
Versions d'application	Versions d'application
CreateApp	Création d'une version d'application.	Crée une version pour une application OpenSearch.
RemoveApp	RemoveApp.	Supprime une version d'une application OpenSearch.
DescribeApps	Récupération de la liste des versions d'une application.	Obtient la liste des versions d'une application OpenSearch.
DescribeApp	Consultation des détails de la version de l'application.	Consulte les détails d'une version spécifique d'application OpenSearch.
DescribeAppStatistics	DescribeAppStatistics.	Consulte les statistiques d'une version d'une application OpenSearch.

Fonctionnalités liées aux instances

API	Titre	Description
Mise à l'échelle élastique basée sur le temps	Mise à l'échelle élastique basée sur le temps
CreateElasticPlan	Créer un plan élastique.	Crée un plan élastique.
RemoveElasticPlan	Supprime un plan élastique.	Obtient les détails d'un plan élastique.
ModifyElasticPlan	Mise à jour d'un plan élastique.	Met à jour un plan élastique.
ListElasticPlans	Liste des plans élastiques.	Obtient la liste des plans élastiques.
DescribeElasticPlan	Détails du plan élastique.	Obtient les détails d'un plan élastique.
Analyseurs personnalisés	Analyseurs personnalisés
ListUserAnalyzers	Liste des analyseurs personnalisés pour un utilisateur.	Obtient la liste des analyseurs personnalisés pour un utilisateur.
CreateUserAnalyzer	Créer un analyseur personnalisé.	Crée un analyseur personnalisé.
DescribeUserAnalyzer	DescribeUserAnalyzer.	Obtient les détails d'un analyseur personnalisé.
RemoveUserAnalyzer	RemoveUserAnalyzer.	Supprime un analyseur personnalisé.
ListUserAnalyzerEntries	ListUserAnalyzerEntries.	Consulte les entrées d'un analyseur personnalisé.
PushUserAnalyzerEntries	PushUserAnalyzerEntries.	Applique les modifications aux entrées d'un analyseur personnalisé.
Tests A/B	Tests A/B
Scénarios d'expérience	Scénarios d'expérience
ListABTestScenes	ListABTestScenes.	Consulte les scénarios de test.
CreateABTestScene	Création d'une scène d'expérience ABTest.	Crée une scène d'expérience ABTest.
DescribeABTestScene	DescribeABTestScene.	Consulte un scénario de test A/B.
UpdateABTestScene	Modifier une scène d'expérience.	Modifie une scène d'expérience ABTest.
DeleteABTestScene	Supprimer un scénario d'expérience ABTest.	Supprime un scénario d'expérience ABTest.
Groupes d'expérience	Groupes d'expérience
ListABTestGroups	ListABTestGroups.	Obtient la liste des groupes de test.
CreateABTestGroup	CreateABTestGroup.	Crée un groupe d'expérimentation.
DeleteABTestGroup	Supprimer un groupe d'expériences ABTest.	Supprime un groupe d'expériences ABTest.
DescribeABTestGroup	DescribeABTestGroup.	Obtient les détails d'un groupe de test A/B.
UpdateABTestGroup	UpdateABTestGroup	Modifie un groupe de test.
Expériences	Expériences
ListABTestExperiments	Répertorier les expériences ABTest.	Répertorie les expériences ABTest.
CreateABTestExperiment	Créer une expérience ABTest.	Crée une expérience.
DescribeABTestExperiment	DescribeABTestExperiment	Obtient les détails d'une expérience.
UpdateABTestExperiment	UpdateABTestExperiment.	Met à jour les paramètres d'une expérience de test A/B.
DeleteABTestExperiment	Supprimer une expérience ABTest.	Supprime une expérience ABTest.
Listes blanches	Listes blanches
ListABTestFixedFlowDividers	ListABTestFixedFlowDividers.	Répertorie les listes blanches.
UpdateABTestFixedFlowDividers	UpdateABTestFixedFlowDividers.	Met à jour les données de la liste blanche.
Expressions de tri approximatif	Expressions de tri approximatif
ListFirstRanks	Liste des configurations de tri approximatif pour une version d'application spécifiée.	Obtient la liste des configurations de tri approximatif pour une version d'application OpenSearch spécifiée.
CreateFirstRank	Créer une configuration d'expression de tri approximatif pour une version d'application.	Crée une configuration d'expression de tri approximatif pour une version d'application OpenSearch. Lorsque dryRun=true, l'expression de tri approximatif est validée. Par défaut, le paramètre dryRun n'est pas transmis et sa valeur par défaut est false.
DescribeFirstRank	DescribeFirstRank.	Consulte l'expression de tri approximatif configurée pour une version d'application OpenSearch.
RemoveFirstRank	Supprimer la règle de tri grossier.	Supprime la configuration de tri grossier d'une version d'application OpenSearch spécifiée.
ModifyFirstRank	ModifyFirstRank.	Modifie l'expression de tri approximatif pour une version d'application OpenSearch. Si vous définissez le paramètre dryRun sur true, cette opération valide l'expression de tri approximatif modifiée. La valeur par défaut de ce paramètre est false.
Expressions de tri fin	Expressions de tri fin
ListSecondRanks	ListSecondRanks.	Répertorie les expressions de tri fin pour une version spécifique d'une application OpenSearch.
CreateSecondRank	Créer une configuration d'expression de tri fin pour une version d'application.	Crée une configuration d'expression de tri fin pour une version d'application. Lorsque dryRun est défini sur true, seule l'expression de tri fin est validée. Par défaut, dryRun est défini sur false s'il n'est pas spécifié.
DescribeSecondRank	Consulter la configuration de l'expression de tri fin d'une version d'application.	Consulte la configuration de l'expression de tri fin d'une version d'application OpenSearch.
ModifySecondRank	ModifySecondRank.	Modifie une expression de tri fin pour une version d'application OpenSearch. Si vous définissez dryRun sur true, l'expression de tri fin modifiée est validée. Le paramètre dryRun est false par défaut.
RemoveSecondRank	RemoveSecondRank.	Supprime une expression de tri fin d'une version d'une application OpenSearch.
Analyseurs de requête	Analyseurs de requête
ListQueryProcessors	ListQueryProcessors.	Consulte la liste des règles d'analyse de requête configurées pour une version spécifique d'une application OpenSearch.
CreateQueryProcessor	Créer une règle d'analyse de requête.	Crée une règle d'analyse de requête. Lorsque dryRun=true, le système valide la règle d'analyse de requête. Par défaut, dryRun n'est pas spécifié et sa valeur par défaut est false.
ModifyQueryProcessor	ModifyQueryProcessor.	Modifie une règle d'analyse de requête pour une version d'application spécifique. Si vous définissez le paramètre dryRun sur true, cette opération vérifie la règle d'analyse de requête spécifiée. Si vous ne spécifiez pas le paramètre dryRun, la valeur par défaut est false.
RemoveQueryProcessor	Supprimer une règle d'analyse de requête pour une version d'application spécifiée.	Supprime une règle d'analyse de requête pour une version d'application OpenSearch spécifiée.
DescribeQueryProcessor	DescribeQueryProcessor.	Décrit une règle d'analyse de requête pour une version d'une application OpenSearch.
ListQueryProcessorNers	Paramètres d'importance recommandés pour les types d'entités.	Obtient les paramètres d'importance recommandés pour les types d'entités de la reconnaissance d'entités nommées.
ListQueryProcessorAnalyzerResults	ListQueryProcessorAnalyzerResults.	Teste les résultats de l'analyse des requêtes. Cette opération ne peut être appelée que pour les applications existantes de l'édition compatible open source.
Dictionnaires d'intervention	Dictionnaires d'intervention
ListInterventionDictionaries	ListInterventionDictionaries.	Obtient la liste des dictionnaires d'intervention.
CreateInterventionDictionary	Créer un dictionnaire d'intervention.	Crée un dictionnaire d'intervention.
DescribeInterventionDictionary	DescribeInterventionDictionary.	Obtient les détails d'un dictionnaire d'intervention.
RemoveInterventionDictionary	Suppression d'un dictionnaire d'intervention.	Supprime un dictionnaire d'intervention.
ListInterventionDictionaryEntries	ListInterventionDictionaryEntries.	Consulte les entrées d'intervention dans un dictionnaire d'intervention.
PushInterventionDictionaryEntries	Acceptation des modifications des entrées d'intervention.	Accepte les modifications des entrées d'intervention.
ListInterventionDictionaryRelatedEntities	ListInterventionDictionaryRelatedEntities.	Consulte la liste des ressources associées à un dictionnaire d'intervention. Si un processeur de requêtes (QP) référence le dictionnaire, l'opération renvoie toutes les applications associées ainsi que les informations sur le QP.
ListInterventionDictionaryNerResults	ListInterventionDictionaryNerResults.	Obtient les résultats de la reconnaissance d'entités nommées (NER).
Assistant d'optimisation	Assistant d'optimisation
EnableSlowQuery	EnableSlowQuery.	Active le service de requêtes lentes pour l'optimiseur.
DisableSlowQuery	DisableSlowQuery.	Désactive le service de requêtes lentes pour Search Diagnoser.
DescribeSlowQueryStatus	DescribeSlowQueryStatus	Consulte l'état de la fonctionnalité de requêtes lentes.
StartSlowQueryAnalyzer	StartSlowQueryAnalyzer.	Démarre une tâche d'analyse des requêtes lentes.
ListSlowQueryQueries	Liste des requêtes lentes.	Répertorie les requêtes lentes du conseiller d'optimisation.
ListSlowQueryCategories	Liste des suggestions d'optimisation des requêtes lentes du conseiller d'optimisation.	Répertorie les suggestions d'optimisation des requêtes lentes provenant du conseiller d'optimisation.
Approbation de quota	Approbation de quota
ListQuotaReviewTasks	ListQuotaReviewTasks.	Répertorie les tickets d'approbation de quota pour une application OpenSearch spécifiée.
Tâches planifiées	Tâches planifiées
ListScheduledTasks	ListScheduledTasks.	Consulte la liste des tâches planifiées pour une application OpenSearch.
CreateScheduledTask	Création d'une tâche planifiée pour une application.	Crée une tâche planifiée pour une application OpenSearch.
DescribeScheduledTask	DescribeScheduledTask.	Consulte une tâche planifiée pour une application OpenSearch.
ModifyScheduledTask	ModifyScheduledTask.	Modifie une tâche planifiée.
RemoveScheduledTask	RemoveScheduledTask.	Supprime une tâche planifiée d'une application OpenSearch.
Stratégies de recherche	Stratégies de recherche
ListSortExpressions	Liste des expressions de tri pour une version d'application.	Obtient la liste des expressions de tri pour une version d'application.
Instances du moteur Elasticsearch	Instances du moteur Elasticsearch
UnbindEsInstance	UnbindEsInstance.	Dissocie une instance Elasticsearch d'une application OpenSearch.
BindEsInstance	BindEsInstance.	Lie une instance Elasticsearch en tant que dépendance.
BindESUserAnalyzer	Associer un analyseur personnalisé à une instance Elasticsearch.	Associe un analyseur personnalisé à une instance Elasticsearch.
UnbindESUserAnalyzer	Dissocier un analyseur personnalisé d'une instance Elasticsearch.	Dissocie un analyseur personnalisé d'une instance Elasticsearch.
Flux de traitement actuels	Flux de traitement actuels
ListProceedings	Liste des tâches d'importation hors ligne en cours pour le groupe d'applications	Obtient le flux de traitement actuel.
Statistiques	Statistiques
ListStatisticLogs	ListStatisticLogs.	Consulte les statistiques des journaux, telles que les journaux d'erreurs d'application, les classements des mots-clés populaires et les journaux de requêtes lentes.
ListStatisticReport	ListStatisticReport.	Consulte les rapports statistiques, tels que les rapports d'application, de suggestions de liste déroulante, de suggestions de recherche principales, de tests A/B et de qualité des données.
Scripts Cava	Scripts Cava
ListSortScripts	ListSortScripts.	Répertorie tous les scripts de tri pour une version d'application spécifiée.
UpdateSortScript	Modification de la description du script de tri.	Modifie la description d'un script de tri.
SaveSortScriptFile	SaveSortScriptFile.	Importe un script de tri.
ReleaseSortScript	ReleaseSortScript.	Publie un script de tri.
GetSortScriptFile	Récupération du contenu du script de tri.	Obtient le contenu d'un script de tri.
GetSortScript	Détails du script de tri.	Obtient les détails d'un script de tri.
GetScriptFileNames	GetScriptFileNames.	Obtient les noms de tous les fichiers d'un script spécifié pour une version d'application spécifique.
DeleteSortScriptFile	DeleteSortScriptFile.	Supprime un fichier de script.
DeleteSortScript	DeleteSortScript.	Supprime un script de tri.
CreateSortScript	Créer un script de tri.	Crée un script de tri.
CompileSortScript	CompileSortScript	Compiles a sort script.
Stratégies de requête	Stratégies de requête
UpdateSearchStrategy	UpdateSearchStrategy.	Cette opération prend en charge les tests à blanc.
RemoveSearchStrategy	Suppression d'une stratégie de recherche.	Supprime une stratégie de recherche.
ListSearchStrategies	ListSearchStrategies.	Obtient les détails des stratégies de requête.
GetSearchStrategy	Stratégie de recherche.	Obtient les détails d'une stratégie de recherche.
CreateSearchStrategy	Créer une stratégie d'analyse de requête.	Crée une stratégie d'analyse de requête.

Fonctionnalités liées aux versions

API	Titre	Description
Champs d'affichage par défaut	Champs d'affichage par défaut
UpdateFetchFields	UpdateFetchFields.	Cette opération prend en charge les tests à blanc.
Résumés des résultats de recherche	Résumés des résultats de recherche
UpdateSummaries	UpdateSummaries.	Cette opération prend en charge les tests à blanc.

Fonctionnalités liées aux algorithmes

API	Titre	Description
CreateFunctionResource	Création d'une ressource d'algorithme.	Crée une ressource d'algorithme sous une fonctionnalité spécifiée.
GetFunctionCurrentVersion	GetFunctionCurrentVersion.	Obtient les informations de version de la fonctionnalité utilisée pour créer une instance.
GetFunctionVersion	GetFunctionVersion.	Consulte les informations d'une version de fonction.
GetFunctionDefaultInstance	Instance par défaut.	Obtient l'instance d'algorithme par défaut utilisée par une application.
UpdateFunctionDefaultInstance	UpdateFunctionDefaultInstance.	Définit l'instance d'algorithme par défaut pour l'application spécifiée. La nouvelle instance d'algorithme remplace automatiquement l'instance par défaut précédemment définie. Si aucune instance n'est spécifiée, l'instance par défaut est annulée.
ListFunctionTasks	Obtention des enregistrements d'entraînement.	Obtient les enregistrements d'entraînement. Les résultats sont triés par heure de début dans l'ordre décroissant.
GetFunctionTask	Obtenir les détails de l'entraînement.	Obtient les détails de l'entraînement.
DeleteFunctionTask	DeleteFunctionTask.	Supprime un enregistrement d'entraînement. Un enregistrement d'entraînement en cours ne peut pas être supprimé.
CreateFunctionTask	Démarrer l'entraînement de l'algorithme.	Démarre une tâche d'entraînement.
ListFunctionInstances	Liste des instances.	Obtient toutes les instances qui répondent aux conditions spécifiées pour l'utilisateur actuel.
GetFunctionInstance	GetFunctionInstance.	Consulte une instance d'algorithme par nom d'instance.
DeleteFunctionInstance	Supprimer une instance d'algorithme.	Supprime une instance d'algorithme. Avant la suppression, assurez-vous que l'instance n'est pas utilisée afin d'éviter d'affecter les services en ligne.
UpdateFunctionInstance	Mise à jour d'une instance d'algorithme	Met à jour les informations de l'instance en fonction du nom de l'instance.
GetFunctionResource	GetFunctionResource	Obtient la ressource d'algorithme spécifiée.
ListFunctionResources	ListFunctionResources.	Répertorie les ressources d'algorithme.
DeleteFunctionResource	DeleteFunctionResource.	Supprime une ressource d'algorithme spécifiée.
UpdateFunctionResource	Mise à jour d'une ressource d'algorithme.	Met à jour une ressource d'algorithme.
CreateFunctionInstance	Créer une instance d'algorithme	Crée une instance d'algorithme pour une fonctionnalité spécifiée.

Autres documents (non répertoriés dans ce répertoire)

API	Titre	Description
ValidateDataSources	Validation des sources de données.	Valide les sources de données.
ReplaceAppGroupCommodityCode	ReplaceAppGroupCommodityCode.	Convertit une application basée sur un service en application basée sur une instance.
ListDataSourceTables	Récupération de la liste des sources de données d'une instance spécifiée.	Obtient toutes les données d'une source de données spécifiée.
ListDataSourceTableFields	Obtenir tous les champs d'une table de données spécifiée.	Obtient tous les champs d'une table de données spécifiée. Il s'agit d'une opération interne.
GetDomain	GetDomain.	Obtient le type d'industrie.
GenerateMergedTable	GenerateMergedTable.	Consulte les informations relatives à une table large générée après l'exécution d'une opération JOIN sur plusieurs tables.
DescribeRegions	DescribeRegions.	Obtient les points de terminaison de toutes les régions.

Autres

API	Titre	Description
DescribeDataCollction	DescribeDataCollction.	Obtient les détails d'une collecte de données pour une application spécifiée.
ListDataCollections	ListDataCollections.	Obtient la liste de contrôle de la collecte de données d'une application OpenSearch.
RemoveDataCollection	RemoveDataCollection.	Désactive la collecte de données.
UntagResources	UntagResources.	Supprime les balises des ressources.
ListTagResources	ListTagResources.	Consulte les balises des ressources spécifiées.
TagResources	TagResources.	Ajoute des balises aux ressources.
CreateAppGroupCredentials	Créer un identifiant de groupe d'applications.	Crée un identifiant d'accès à la demande pour un groupe d'applications spécifié. Prend en charge le mode de test à blanc pour prévisualiser l'opération.