Alibaba Cloud SDK:FAQ sur Alibaba Cloud SDK for Node.js

Comment gérer les erreurs liées aux AccessKey ?

Problème : le message d'erreur suivant s'affiche après l'exécution du code, indiquant que la paire d'AccessKey est mal configurée.

• Alibaba Cloud SDK V2.0 for Node.js : Cannot read properties of undefined (reading 'getCredential').

• Alibaba Cloud SDK V1.0 for Node.js : AssertionError [ERR_ASSERTION]: must pass "config.accessKeyId".

Solutions :

1. Exécutez les commandes suivantes pour vérifier si les variables d'environnement ALIBABA_CLOUD_ACCESS_KEY_ID et ALIBABA_CLOUD_ACCESS_KEY_SECRET sont configurées.

   Linux/macOS

   echo $ALIBABA_CLOUD_ACCESS_KEY_ID
   echo $ALIBABA_CLOUD_ACCESS_KEY_SECRET

   Windows

   echo %ALIBABA_CLOUD_ACCESS_KEY_ID%
   echo %ALIBABA_CLOUD_ACCESS_KEY_SECRET%

   Si une paire d'AccessKey valide s'affiche, les variables d'environnement sont correctement configurées. En l'absence de réponse ou si la paire retournée est invalide, configurez les variables d'environnement selon vos besoins. Pour plus d'informations, consultez Configurer les variables d'environnement sous Linux, macOS et Windows.

2. Vérifiez la présence d'erreurs liées à la paire d'AccessKey dans le code.

   Exemple de requête incorrecte :

    let config = new OpenApi.Config({
         accessKeyId: process.env['yourAccessKeyID'],
         accessKeySecret: process.env['yourAccessKeySecret'],
       });

   Exemple de requête correcte :

   let config = new OpenApi.Config({
         accessKeyId: process.env['ALIBABA_CLOUD_ACCESS_KEY_ID'],
         accessKeySecret: process.env['ALIBABA_CLOUD_ACCESS_KEY_SECRET'],
       });

   Remarque

   Les expressions process.env['ALIBABA_CLOUD_ACCESS_KEY_ID'] et process.env['ALIBABA_CLOUD_ACCESS_KEY_SECRET'] récupèrent les valeurs depuis leurs variables d'environnement respectives.

   Important

   Pour éviter tout risque de sécurité, ne saisissez jamais la paire d'AccessKey directement dans le code de production.

Que faire si l'exécution d'une commande tsc retourne l'erreur « tsc: Fail to recognize the tsc command as the name of a cmdlet, a function, a script, or a executable program... » ?

PS C:\Users\issuser\Downloads\69351a7d-c9ef-417c-8986-a371cd208ece-TypeScript> tsc
tsc : The term 'tsc' is not recognized as the name of a cmdlet, function, script file, or operable program. Check the spelling of the name, or if a path was included, verify that the path is correct and try again.
At line:1 char:1
+ tsc
+ ~~~
    + CategoryInfo          : ObjectNotFound: (tsc:String) [], CommandNotFoundException
    + FullyQualifiedErrorId : CommandNotFoundException

Que faire si la requête API expire et que le message « Error: connect ETIMEDOUT » s'affiche ?

Causes fréquentes et solutions :

L'expiration d'un appel API peut résulter de plusieurs facteurs. Cette section détaille les causes les plus courantes ainsi que les solutions correspondantes :

Cause 1 : Problèmes de connexion réseau

Cause : la requête ne parvient pas au serveur en raison d'une défaillance de la connexion réseau entre le client et le serveur, ou d'une instabilité du réseau.

Solution :

Utilisez la commande ping ou curl pour tester la connectivité entre votre hôte local et l'endpoint du service cloud. Par exemple, exécutez ping dysmsapi.aliyuncs.com ou curl -v https://dysmsapi.aliyuncs.com pour vérifier la connexion entre votre machine locale et l'endpoint de l'API Short Message Service (SMS).

• Si la commande expire ou ne reçoit aucune réponse, vérifiez les règles de blocage sur votre pare-feu local ou vos routeurs.

• Si une réponse est obtenue, définissez un délai d'expiration approprié pour éviter que des requêtes n'échouent à cause d'une configuration inadéquate. Pour plus d'informations, consultez Configurer un délai d'expiration. Exemple de code :

  JavaScript

  // Create a RuntimeOptions instance and specify runtime parameters. 
      const runtime = new RuntimeOptions({
          // Configure a timeout period for connection requests.
          connectTimeout: 10000,
      });

  TypeScript

  // Create a RuntimeOptions instance and specify runtime parameters. 
          const runtime = new $Util.RuntimeOptions({
              // Configure a timeout period for connection requests.
              connectTimeout: 10000,
          });

Cause 2 : Temps de traitement de la requête trop long

Description : la durée de traitement de la requête API dépasse le délai de lecture spécifié.

Solution : ajustez le délai d'expiration pour tenir compte du temps de réponse prolongé de l'API. Pour plus d'informations, consultez Configurer un délai d'expiration. Vous pouvez notamment augmenter le paramètre de délai de lecture pour allonger cette durée. Exemple de code :

// Create a RuntimeOptions instance and specify runtime parameters. 
    const runtime = new RuntimeOptions({
        // Configure a timeout period for read requests.
        readTimeout: 10000,
    });

// Create a RuntimeOptions instance and specify runtime parameters. 
        const runtime = new $Util.RuntimeOptions({
            // Configure a timeout period for read requests.
            readTimeout: 10000,
        });

Que faire si le message « MissingRequiredParameter » apparaît lors de l'appel d'une opération API ?

Cet exemple illustre l'appel de l'opération SendSms du service Short Message Service (SMS).

• Accédez à la page API Debugging d'OpenAPI Explorer, puis sélectionnez le produit et l'API concernés.

• Assurez-vous que tous les paramètres obligatoires, tels que phoneNumbers et signName, sont bien renseignés dans l'objet de requête construit. Dans cet exemple, il s'agit de l'objet SendSmsRequest.

• Vérifiez que tous les paramètres requis sont spécifiés en vous référant à la documentation de l'API.

• Confirmez que les valeurs des paramètres obligatoires sont valides. Vérifiez par exemple que les numéros de téléphone mobile respectent les formats attendus.

• Avant d'envoyer une requête API, le SDK valide automatiquement les paramètres. Si un ou plusieurs paramètres obligatoires manquent, une erreur telle que MissingRequiredParameter est signalée. Par exemple, si le paramètre phoneNumbers est absent, l'erreur « MissingPhoneNumbers: code: 400 » s'affiche. Dans ce cas, renseignez le paramètre en suivant les indications du message d'erreur.

let sendSmsRequest = new Dysmsapi20170525.SendSmsRequest({
      phoneNumbers: '<YOUR_VALUE>',
      signName: '<YOUR_VALUE>',
      templateCode: '<YOUR_VALUE>',
    });

let sendSmsRequest = new $Dysmsapi20170525.SendSmsRequest({
      phoneNumbers: "<YOUR_VALUE>",
      signName: "<YOUR_VALUE>",
      templateCode: "<YOUR_VALUE>",
    });

Que faire si un appel API échoue car l'opération n'est pas prise en charge dans la région spécifiée et que le message « getaddrinfo ENOTFOUND » est retourné ?

Assurez-vous que le service appelé est disponible dans la région sélectionnée. Vous trouverez l'endpoint correct dans OpenAPI Explorer. Veillez à utiliser l'endpoint approprié.

Dans la barre de navigation supérieure d'OpenAPI Explorer, sélectionnez Short Message Service. Sur la page d'accueil du produit, accédez à l'onglet Service area list. Le format de l'endpoint est [product_code].[region_id].aliyuncs.com. Le tableau répertorie chaque ID de région (tel que cn-beijing, cn-hangzhou et cn-shanghai) ainsi que son endpoint de service correspondant (par exemple dysmsapi.aliyuncs.com).

Comment traiter les erreurs signalées par la commande npm install ?

Assurez-vous que Node.js et npm sont correctement installés. Pour plus d'informations, consultez Installer Node.js sous Windows.

Comment résoudre un conflit de versions d'un package de dépendances ?

• Exécutez la commande npm ls pour afficher l'arborescence des dépendances et vous assurer qu'aucun conflit de versions n'existe.

• Supprimez le répertoire node_modules ainsi que le fichier package-lock.json, puis réinstallez les dépendances.

 rm -rf node_modules package-lock.json
 npm install