DataWorks:API de service de données

Étape 1 : Générer l'API de profil utilisateur

Suivez les étapes ci-dessous dans DataService Studio.

1. Connectez-vous à la console DataWorks. Dans la région cible, cliquez sur Data Analysis and Service > DataService Studio dans le volet de navigation de gauche. Sélectionnez un espace de travail dans la liste déroulante et cliquez sur Go to DataService Studio.

2. Créez une API.

   Sur la page DataService Studio, cliquez sur l'icône et choisissez Create API > Generate API. Dans la boîte de dialogue Generate API, sélectionnez Wizard Mode.

   Remarque

   Vous pouvez générer une API en Wizard Mode ou en Script Mode. Cet exemple utilise Wizard Mode.

   • Pour savoir comment générer une API en Wizard Mode, consultez la rubrique Générer une API à partir d'une source de données (API Gateway).

   • Pour savoir comment générer une API en Script Mode, consultez la rubrique Générer une API en mode Script.

Étape 2 : Configurer l'API de profil utilisateur

1. Configurez l'API.

   En Wizard Mode, configurez les paramètres suivants pour créer une API de service de données pour une source de données MaxCompute. Pour plus d'informations, consultez la rubrique Générer une API à partir d'une source de données (API Gateway).

   Module	Paramètre	Description	Exemple
   Table	Data Source Type	Sélectionnez le type de source de données. Remarque Les API de service de données ne prennent pas en charge les sources de données Hive. Les types de sources de données disponibles sont limités aux options de la liste déroulante.	Cet exemple utilise une source de données MaxCompute.
   	Data Source Name	Sélectionnez une source de données existante.	Utilisez votre source de données métier.
   	Data Source Environment	Production Environment Development Environment	Sélectionnez Production Environment.
   	Data Table Name	Sélectionnez la table pour l'API.	Sélectionnez la table ads_user_info_1d.
   Select Parameters	Pagination for Return Results	Activez ou désactivez la pagination des résultats. Ce paramètre affecte les paramètres de requête et de réponse de l'API. Dans le panneau Service Resource Group à droite, vous pouvez définir le nombre maximal d'enregistrements de données pour une seule requête en fonction du type de groupe de ressources. Pour plus d'informations, consultez Générer une API à partir d'une source de données (API Gateway).	Désactivez Pagination for Return Results.
   	Set as Req Param	Sélectionnez les champs à utiliser comme paramètres de requête.	Définissez le champ de partition dt comme Request Parameters.
   	Set as Resp Param	Sélectionnez les champs à utiliser comme paramètres de réponse.	Définissez tous les champs de la table ads_user_info_1d comme Response Parameters.
   Sorting Fields	Le champ de tri est facultatif. Si vous souhaitez trier par un champ, sélectionnez d'abord le champ souhaité dans la liste des paramètres.		Ne pas trier.

2. Configurez le groupe de ressources de service

   Après avoir configuré l'API, cliquez sur Resource Group for DataService Studio dans le volet de navigation de droite pour configurer ses ressources. Le tableau suivant décrit les paramètres. Pour plus d'informations, consultez la rubrique Configurer un groupe de ressources de service pour une API.

   Module	Paramètre	Description
   Resource Group Type	Scheme	Exclusive Resource Group for DataService Studio.
   	Exclusive Resource Group for DataService Studio	Sélectionnez un groupe de ressources serverless (recommandé) ou un Exclusive Resource Group for DataService Studio. Important Si vous avez acheté un Exclusive Resource Group for DataService Studio, vous pouvez l'utiliser directement. Si vous ne disposez pas de groupe de ressources, nous vous recommandons d'acheter un groupe de ressources serverless à usage général. Pour plus d'informations, consultez Utiliser un groupe de ressources serverless. Si un groupe de ressources serverless nouvellement acheté est grisé et ne peut pas être sélectionné lors de la configuration du groupe de ressources de service, vous devez allouer un quota pour l'utilisation Data Services du groupe de ressources. Pour plus d'informations, consultez Allouer des quotas d'UC aux tâches.
   Environment Configuration	Timeout	Définissez la valeur sur 30 000 ms.
   	Maximum Number of Data Records for a Single Request	Définissez la valeur sur 2 000.

Étape 3 : Tester et publier l'API

1. Testez l'API pour vérifier qu'elle renvoie les paramètres de réponse attendus. Pour plus d'informations, consultez la rubrique Tester une API.

   1. Une fois la configuration terminée, cliquez sur l'icône pour enregistrer l'API, puis cliquez sur l'icône pour ouvrir la page de test.

   2. Dans la boîte de dialogue API test, saisissez les valeurs des paramètres de requête.

   3. Cliquez sur Start Test pour démarrer le test de l'API.

2. La publication d'une API l'ajoute à API Gateway et génère un endpoint en ligne. Pour plus d'informations, consultez la rubrique Tester, publier et gérer les versions d'une API.

   1. Une fois que l'API a passé le test avec succès, cliquez sur l'icône sur la page de modification de l'API pour soumettre l'API. Une nouvelle version de l'API est générée. Dans le volet de droite de la page des détails de l'API, cliquez sur l'onglet Version pour accéder à la page de gestion des versions. Recherchez la version dont le statut est Publishable, par exemple v1.

   2. Cliquez sur Publish pour publier l'API.

   3. Une fois l'API publiée, vous pouvez cliquer sur Service Management dans la section de gestion des versions ou accéder à Service Management > API Management > Published APIs. Pour plus d'informations, consultez la rubrique Gérer et maintenir les API.