Normes API et SDK multilingues prédéfinis
L'OpenAPI de ce produit (searchengine/2021-10-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
|
API |
Titre |
Description |
| CreatePublicUrl | Activation du nom de domaine public. | Active le nom de domaine public. |
| DeletePublicUrl | Suppression d'un nom de domaine public. | Supprime un nom de domaine public. |
| ModifyPublicUrlIpList | Modification de la liste blanche des noms de domaine publics. | Modifie la liste blanche des noms de domaine publics. |
| ModifyPassword | Modification du mot de passe de l'instance. | Modifie le mot de passe d'une instance. |
| ListInstanceSpecs | ListInstanceSpecs. | Consulte les spécifications d'une instance. |
Centre de configuration
|
API |
Titre |
Description |
| Configuration des tables en ligne | Configuration des tables en ligne | |
| GetIndexOnlineStrategy | GetIndexOnlineStrategy. | Consulte la stratégie en ligne effective d'un index. |
| ModifyIndexOnlineStrategy | ModifyIndexOnlineStrategy. | Modifie la stratégie en ligne d'un index. |
| ModifyOnlineConfig | ModifyOnlineConfig. | Modifie les configurations en ligne. |
| ListOnlineConfigs | ListOnlineConfigs. | Consulte une configuration en ligne. |
| Structure d'index | Structure d'index | |
| ModifyIndex | Modifier un index. | Modifie un index. |
| StartIndex | StartIndex. | Reprend un index. |
| StopIndex | StopIndex. | Arrête un index. |
| BuildIndex | BuildIndex. | Reconstruit un index. |
| ModifyIndexVersion | ModifyIndexVersion. | Modifie la version d'index d'un cluster (restauration d'une version d'index). |
| ModifyFile | ModifyFile. | Modifie un fichier. |
| PublishIndexVersion | PublishIndexVersion. | Publie une version d'index spécifiée. |
| ModifyIndexPartition | ModifyIndexPartition. | Modifie les informations sur les partitions d'index. |
| GetIndexVersion | GetIndexVersion. | Consulte les informations relatives aux versions d'index vers lesquelles la version d'index actuelle peut être restaurée. |
| ListIndexes | Obtenir la liste des index | Obtient la liste des index. |
| RecoverIndex | Restaurer les données d'un index | Restaure les données d'un index. |
| Configuration avancée | Configuration avancée | |
| CreateConfigDir | Créer un répertoire dans une configuration avancée. | Crée un répertoire dans une configuration avancée. |
| DeleteConfigDir | Supprimer un dossier de configuration avancée. | Supprime un dossier de configuration avancée. |
| ModifyAdvanceConfig | Modification du contenu des fichiers HTTP et Git | Modifie le contenu des fichiers HTTP et Git. |
| DeleteAdvanceConfig | DeleteAdvanceConfig. | Supprime les détails des configurations avancées. |
| ModifyAdvanceConfigFile | Modifier un dictionnaire. | Modifie un dictionnaire. |
| PublishAdvanceConfig | Publication d'une version avancée. | Publie une version avancée. |
| GetAdvanceConfig | GetAdvanceConfig. | Consulte les informations sur une configuration avancée. |
| GetAdvanceConfigFile | GetAdvanceConfigFile. | Consulte les informations sur un fichier de configuration avancée. |
| ListAdvanceConfigDir | Obtenir la liste des fichiers d'un répertoire de configuration avancée. | Obtient la liste des fichiers d'un répertoire de configuration avancée. |
| ListAdvanceConfigs | Liste des configurations avancées | Consulte la liste des configurations avancées. |
| Configuration de la source de données | Configuration de la source de données | |
| ModifyDataSourceDeploy | Modification des informations de déploiement d'une source de données. | Modifie les informations de déploiement d'une source de données. |
| ListDataSourceSchemas | ListDataSourceSchemas. | Consulte les informations de schéma d'une source de données. |
| ListDateSourceGenerations | Obtenir les informations de reflux des données historiques pour une source de données | Obtient les informations de reflux des données historiques pour une source de données. |
| GetDataSourceDeploy | Obtenir les informations de déploiement de la source de données | Obtient les informations de déploiement de la source de données. |
Centre d'exploitation et de maintenance
|
API |
Titre |
Description |
| Développement SQL | Développement SQL | |
| CloneSqlInstance | Clonage d'une instance SQL. | Clone une instance SQL. |
| DeleteSqlInstance | DeleteSqlInstance. | Supprime une instance SQL. |
| ExecuteSqlInstance | Exécution d'une instance SQL. | Exécute une instance SQL. |
| GetDatabaseSchema | GetDatabaseSchema. | Obtient le schéma d'une base de données. |
| UpdateSqlInstanceContent | UpdateSqlInstanceContent. | Met à jour le contenu d'une instance SQL. |
| UpdateSqlInstanceName | UpdateSqlInstanceName. | Met à jour le nom d'une instance SQL. |
| UpdateSqlInstanceParams | UpdateSqlInstanceParams. | Met à jour les paramètres d'une instance SQL. |
| RenameFolder | RenameFolder. | Renomme un dossier. |
| Historique des modifications | Historique des modifications | |
| ListClusterTasks | Liste des tâches de cluster | Consulte les tâches de cluster. |
| ListDataSourceTasks | Liste des tâches de source de données | Obtient les tâches de source de données. |
| ForceSwitch | ForceSwitch. | Effectue un basculement forcé. |
| Gestion des journaux | Gestion des journaux | |
| ListLogs | ListLogs. | Consulte les journaux d'une instance. |
| Gestion des déploiements | Gestion des déploiements | |
| ModifyNodeConfig | ModifyNodeConfig. | Modifie un nœud. |
| GetDeployGraph | GetDeployGraph. | Affiche la vue d'ensemble du déploiement. |
| GetNodeConfig | Récupération des informations de configuration d'un nœud. | Obtient les informations de configuration d'un nœud. |
| Gestion des opérations | Gestion des opérations | |
| ListIndexRecoverRecords | Récupération des enregistrements de données | Obtient les enregistrements de récupération de données. |
| ListPausePolicys | ListPausePolicys. | Consulte les stratégies de mise en pause. |
| ModifyPausePolicy | ModifyPausePolicy. | Modifie la stratégie de pause. |
| RemoveCluster | RemoveCluster. | Supprime un cluster. |
| ModifyClusterDesc | ModifyClusterDesc. | Modifie la description d'un cluster spécifié. |
| ModifyClusterOfflineConfig | ModifyClusterOfflineConfig. | Modifie les informations de configuration d'un cluster. |
| ModifyClusterOnlineConfig | ModifyClusterOnlineConfig. | Modifie la configuration en ligne d'un cluster. |
| GetCluster | Obtenir les détails d'un cluster spécifique | Consulte les détails d'un cluster spécifique. |
| GetClusterRunTimeInfo | Obtention des informations du cluster | Obtient les informations du cluster. |
| ListClusterNames | ListClusterNames. | Consulte les noms des clusters. |
Gestion des tables
|
API |
Titre |
Description |
| Gestion des alias de table | Gestion des alias de table | |
| ModifyAlias | ModifyAlias. | Modifie un alias de table. |
| CreateTable | Création d'une table d'index. | Crée une table d'index. |
| ModifyTable | Modification d'une table d'index. | Modifie une table d'index. |
| DeleteTable | Suppression de la table d'index. | Supprime une table d'index. |
| Reindex | Reconstruction d'un index. | Reconstruit un index. |
| ListTableGenerations | ListTableGenerations. | Consulte la liste des versions d'index. |
| GetTableGeneration | GetTableGeneration | Consulte l'état d'une version d'index en fonction de l'identifiant de la version complète de l'index. |
Autres
|
API |
Titre |
Description |
| ListPostQueryResult | ListPostQueryResult. | Obtient les résultats d'un test de recherche pour une instance de l'édition Retrieval-Augmented Generation en envoyant une requête POST. |
| ListRestQueryResult | ListRestQueryResult. | Obtient les résultats de test d'une requête de recherche REST pour une instance de l'édition Retrieval Engine. |
| ListVectorQueryResult | ListVectorQueryResult. | Obtient les résultats d'un test de requête vectorielle dans l'édition Vector Search. |
| PushDocuments | PushDocuments. | Pousse des documents. |
| ListQueryResult | Résultats de la requête. | Consulte le résultat de la requête. |
| ModifyModel | ModifyModel | Modifie les détails et l'état d'un modèle. |
| DebugModel | DebugModel. | Débogue un modèle. |
| GetModel | Récupère les détails du modèle | Consulte les informations de configuration détaillées d'un modèle spécifique en fonction de l'identifiant de l'instance et du nom du modèle. |
| ListModels | Liste des modèles | Consulte la liste des modèles selon des conditions spécifiées par identifiant d'instance. |
| ModifySearcherReplica | ModifySearcherReplica. | Modifie le nombre de réplicas ou de partitions pour les nœuds de données d'une instance. |
Others
|
API |
Titre |
Description |
| ChangeResourceGroup | ChangeResourceGroup. | Modifie le groupe de ressources d'une instance. |
| CreateAlias | Créer un alias. | Crée un alias. |
| CreateCluster | Ajout d'un cluster. | Ajoute un cluster. |
| CreateConfigFile | Créer un fichier avec des configurations avancées. | Crée un fichier avec des configurations avancées. |
| CreateDataSource | Créer une source de données | Crée une source de données. |
| CreateFolder | Créer un dossier. | Crée un dossier. |
| CreateIndex | CreateIndex. | Crée un index. |
| CreateInstance | Créer une instance | Crée une instance Wentian Engine. |
| CreateModel | CreateModel. | Crée un modèle. |
| CreateSqlInstance | Créer une instance SQL. | Crée une instance SQL. |
| DeleteAlias | Supprimer un alias. | Supprime un alias. |
| DeleteConfigFile | Supprimer un fichier de configuration avancée. | Supprime un fichier de configuration avancée. |
| DeleteDataSource | DeleteDataSource. | Supprime une source de données spécifiée. |
| DeleteFolder | DeleteFolder. | Supprime un dossier. |
| DeleteIndex | DeleteIndex. | Supprime un index. |
| DeleteIndexVersion | DeleteIndexVersion. | Supprime la version d'un index. |
| DeleteInstance | DeleteInstance. | Supprime une instance spécifiée. |
| DeleteModel | DeleteModel. | Supprime un modèle. |
| DescribeRegions | DescribeRegions. | Consulte les régions disponibles. |
| GetDataSource | GetDataSource. | Obtient une source de données. |
| GetFile | GetFile. | Obtient les détails d'une version d'index. |
| GetIndex | Détails de la table d'index | Obtient les détails d'une version de table d'index. |
| GetInstance | Obtention des détails de l'instance | Obtient les détails d'une instance spécifiée par identifiant d'instance. |
| GetSqlInstance | Obtenir les informations de l'instance SQL. | Obtient les informations de l'instance SQL. |
| GetTable | Obtention des informations de la table d'index. | Obtient les informations de la table d'index. |
| ListAliases | ListAliases. | Répertorie les alias de table. |
| ListClusters | ListClusters. | Consulte les clusters. |
| ListDatabases | ListDatabases. | Répertorie les bases de données existantes. |
| ListDataSources | ListDataSources. | Obtient la liste des sources de données. |
| ListInstances | Liste des instances | Obtient la liste des instances. |
| ListSchemas | ListSchemas | Obtient la liste des schémas en fonction d'une configuration de synchronisation des données. |
| ListTables | ListTables. | Consulte la liste des tables d'index. |
| ListTagResources | Liste des ressources balisées. | Consulte les balises associées à une ou plusieurs ressources. |
| ListTasks | ListTasks. | Obtient l'historique des modifications d'une instance. |
| StopTask | StopTask. | Arrête une tâche FSM. |
| TagResources | TagResources. | Ajoute ou met à jour des balises pour plusieurs ressources. |
| UntagResources | UntagResources. | Supprime les balises d'un lot de ressources. |
| UpdateInstance | Modification de la configuration d'une instance spécifiée | Modifie la configuration d'une instance spécifiée. |