Alibaba Cloud SDK:Utiliser le SDK Alibaba Cloud pour Node.js avec un IDE

Accédez à la page API Debugging du portail OpenAPI. Sélectionnez un produit cloud et une API. Cet exemple utilise l'API DescribeRegions d'ECS. Saisissez DescribeRegions dans la barre de recherche et cliquez sur le nom de l'API.

Dans l'onglet Parameter Settings, saisissez les paramètres requis. L'onglet Document situé à droite fournit la description de l'API, des notes, des informations de facturation et des détails sur les paramètres.

L'API DescribeRegions prend en charge trois paramètres :

Dans l'onglet SDK Sample Code de la colonne la plus à droite, sélectionnez un langage de programmation et cliquez sur Download Project pour télécharger le projet SDK complet sur votre ordinateur. Décompressez ensuite l'archive.

Sélectionnez SDK Version comme V2.0 Recommended.

Ouvrez VS Code. Dans la barre de menus, cliquez sur File > Open Folder. Sélectionnez le dossier décompressé.

Dans la barre de menus de VS Code, cliquez sur Terminal > New Terminal.

Dans le terminal, exécutez la commande suivante pour installer TypeScript.

 npm install -g typescript

Dans le terminal, exécutez la commande suivante pour installer les dépendances du projet.

npm install

Dans le terminal, exécutez la commande suivante pour compiler les fichiers TypeScript en JavaScript. Les fichiers de sortie sont placés dans le répertoire dist.

tsc

Dans le terminal, exécutez la commande suivante pour exécuter l'exemple de code.

node ./dist/client.js

Vérifiez le résultat. Appuyez sur Ctrl+F dans le terminal et recherchez statusCode. Une réponse contenant "statusCode": 200 indique que l'opération a réussi.

Ouvrez VS Code. Cliquez sur File > Open Folder et créez ou sélectionnez un dossier de projet, tel que tssdkproject.

Dans la barre de menus de VS Code, cliquez sur Terminal > New Terminal.

Obtenez le SDK.

Accédez au SDK Center. Sélectionnez un produit cloud, tel qu'ECS. Définissez SDK Version sur V2.0 et Language sur TypeScript.

Sélectionnez la version d'API 2014-05-26. Node.js >= 8.x est requis. Dans la section d'installation, exécutez la commande d'installation NPM : npm install --save @alicloud/ecs20140526@4.1.7.

Installez le SDK.

Copiez la commande d'installation dans le terminal et appuyez sur Entrée pour l'exécuter.

Créez un fichier. À côté du nom du projet, cliquez sur l'icône Nouveau fichier et saisissez un nom de fichier, par exemple ecsDescribeRegions.js.

Initialisez le client.

Initialisez un client ECS avant d'appeler toute API ECS.

// Import the ECS client and the OpenAPI client.
const ecs20140526 = require('@alicloud/ecs20140526');
const openapiclient = require('@alicloud/openapi-client');

/**
 * Initialize the ECS client configuration.
 * This configuration uses the Access Key ID and Access Key Secret from environment variables for authentication and sets the endpoint to ecs.cn-hangzhou.aliyuncs.com.
 */
const ecsconfig = new openapiclient.Config();
ecsconfig.accessKeyId = process.env.ALIBABA_CLOUD_ACCESS_KEY_ID; // Get the Access Key ID from environment variables.
ecsconfig.accessKeySecret = process.env.ALIBABA_CLOUD_ACCESS_KEY_SECRET; // Get the Access Key Secret from environment variables.
ecsconfig.endpoint = 'ecs.cn-hangzhou.aliyuncs.com'; // Set the endpoint for the ECS service.

// Create a client instance for ECS API version 20140526.
const ecs20140526client = new ecs20140526.default(ecsconfig);

Appelez l'API. Consultez la documentation de l'API pour l'API cible. L'exemple suivant appelle l'API DescribeRegions d'ECS.

// Import the ECS client and the OpenAPI client.
const ecs20140526 = require('@alicloud/ecs20140526');
const openapiclient = require('@alicloud/openapi-client');

/**
 * Initialize the ECS client configuration.
 * This configuration uses the Access Key ID and Access Key Secret from environment variables for authentication and sets the server-side endpoint to ecs.cn-hangzhou.aliyuncs.com.
 */
const ecsconfig = new openapiclient.Config();
ecsconfig.accessKeyId = process.env.ALIBABA_CLOUD_ACCESS_KEY_ID; // Use the Access Key ID from environment variables.
ecsconfig.accessKeySecret = process.env.ALIBABA_CLOUD_ACCESS_KEY_SECRET; // Use the Access Key Secret from environment variables.
ecsconfig.endpoint = 'ecs.cn-hangzhou.aliyuncs.com'; // Set the endpoint for the ECS service.

// Create a client instance for ECS API version 20140526.
const ecs20140526client = new ecs20140526.default(ecsconfig);
const describeRegionsRequest = new ecs20140526.DescribeRegionsRequest();
// Initiate a request to query all regions.
ecs20140526client.describeRegions(describeRegionsRequest).then((res)=>{
    console.log(res);
})

Gérez les exceptions.

Le SDK Node.js V2.0 génère deux types d'exceptions : les exceptions métier (erreurs de service) et les exceptions réseau (générées après le nombre maximal de tentatives). L'exemple de code ne fait pas la distinction entre elles car les classes d'exception ne peuvent pas être importées depuis des modules externes.

// Import the ECS client and the OpenAPI client.
const ecs20140526 = require('@alicloud/ecs20140526');
const openapiclient = require('@alicloud/openapi-client');

/**
 * Initialize the ECS client configuration.
 * This configuration uses the Access Key ID and Access Key Secret from environment variables for authentication and sets the server-side endpoint to ecs.cn-hangzhou.aliyuncs.com.
 */
const ecsconfig = new openapiclient.Config();
ecsconfig.accessKeyId = process.env.ALIBABA_CLOUD_ACCESS_KEY_ID; // Use the Access Key ID from environment variables.
ecsconfig.accessKeySecret = process.env.ALIBABA_CLOUD_ACCESS_KEY_SECRET; // Use the Access Key Secret from environment variables.
ecsconfig.endpoint = 'ecs.cn-hangzhou.aliyuncs.com'; // Set the endpoint for the ECS service.

// Create a client instance for ECS API version 20140526.
const ecs20140526client = new ecs20140526.default(ecsconfig);
const describeRegionsRequest = new ecs20140526.DescribeRegionsRequest();
// Initiate a request to query all regions.
ecs20140526client.describeRegions(describeRegionsRequest).then((res) => {
    console.log(res);
}).catch((err) => {
    console.log(err.message);
    throw err;
});

Exécutez l'exemple de code.

1. Si Code Runner est installé, cliquez avec le bouton droit dans l'éditeur et sélectionnez Run Code.

2. Exécutez le fichier avec la commande node, par exemple node .\ecsDescribeRegions.js.

   Le code complet du fichier ecsDescribeRegions.js est le suivant.

   // import the sdk
   const ecs20140526 = require('@alicloud/ecs20140526');
   const openapiclient = require('@alicloud/openapi-client');
   
   /**
    * init the client Config
    * set accessKeyId, accessKeySecret,  endpoint
    */
   const ecsconfig = new openapiclient.Config();
   ecsconfig.accessKeyId = process.env.ALIBABA_CLOUD_ACCESS_KEY_ID;
   ecsconfig.accessKeySecret = process.env.ALIBABA_CLOUD_ACCESS_KEY_SECRET;
   ecsconfig.endpoint = 'ecs.cn-hangzhou.aliyuncs.com';
   
   // create an ECS client
   const ecs20140526client = new ecs20140526.default(ecsconfig);
   const describeRegionsRequest = new ecs20140526.DescribeRegionsRequest();
   // invoke the describeRegions to get the regions
   ecs20140526client.describeRegions(describeRegionsRequest).then((res) => {
       console.log(res);
   }).catch((err) => {
       console.log(err.message);
       throw err;
   });
   

   Exemple de sortie du terminal après l'exécution :

   PS D:\ide\nodejsprojects\tssdkproject> node .\ecsDescribeRegions.js
   DescribeRegionsResponse {
     headers: {
       date: 'Wed, 22 May 2024 10:16:52 GMT',
       'content-type': 'application/json;charset=utf-8',
       'content-length': '3326',
       connection: 'keep-alive',
       'keep-alive': 'timeout=25',
       vary: 'Accept-Encoding',
       'access-control-allow-origin': '*',
       'access-control-expose-headers': '*',
       'x-acs-request-id': 'AC778D54-5FCE-52A9-A8B8-F59B84C83A22',
       'x-acs-trace-id': '1ba239a3bb30f7938e40cb9b43877234',
       etag: '2eJeo4u9ETUTqRZPYxeavA2'
     },
     statusCode: 200,
     body: DescribeRegionsResponseBody {
       regions: DescribeRegionsResponseBodyRegions { region: [Array] },
       requestId: 'B77D422C-C519-55E2-A4D5-87925423F7F1'
     }
   }
   

3. Cliquez sur Run and Debug dans la barre latérale ou appuyez sur Ctrl+Shift+D, puis cliquez sur Run and Debug pour exécuter le fichier actif.

   // import the sdk
   const ecs20140526 = require('@alicloud/ecs20140526');
   const openapiclient = require('@alicloud/openapi-client');
   
   /**
    * init the client Config
    * set accessKeyId, accessKeySecret, endpoint
    */
   const ecsconfig = new openapiclient.Config();
   ecsconfig.accessKeyId = process.env.ALIBABA_CLOUD_ACCESS_KEY_ID;
   ecsconfig.accessKeySecret = process.env.ALIBABA_CLOUD_ACCESS_KEY_SECRET;
   ecsconfig.endpoint = 'ecs.cn-hangzhou.aliyuncs.com';
   
   // create an ECS client
   const ecs20140526client = new ecs20140526.default(ecsconfig);
   const describeRegionsRequest = new ecs20140526.DescribeRegionsRequest();
   // invoke the describeRegions to get the regions
   ecs20140526client.describeRegions(describeRegionsRequest).then((res) => {
       console.log(res);
   }).catch((err) => {
       console.log(err.message);
       throw err;
   });
   

(Facultatif) Copiez l'exemple de code depuis OpenAPI Portal dans un fichier et exécutez-le. Génération automatique de code SDK.