Alibaba Cloud SDK:FAQ sur le SDK pour Python

Comment gérer les erreurs liées à l'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 : AttributeError: 'NoneType' object has no attribute 'get_access_key_id'.

• Alibaba Cloud SDK V1.0 : Error:MissingParameter The input parameter "AccessKeyId" that is mandatory for processing this request is not supplied.

Solutions :

1. Exécutez les commandes suivantes pour vérifier la configuration des variables d'environnement ALIBABA_CLOUD_ACCESS_KEY_ID et ALIBABA_CLOUD_ACCESS_KEY_SECRET.

   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. Sinon, configurez-les 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 :

    config = open_api_models.Config(
               access_key_id=os.environ['yourAccessKeyID'],
               access_key_secret=os.environ['yourAccessKeySecret']
           )

   Exemple de requête correcte :

    config = open_api_models.Config(
              access_key_id=os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID'],
              access_key_secret=os.environ['ALIBABA_CLOUD_ACCESS_KEY_SECRET']
           )

   Remarque

   os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID'] et os.environ("ALIBABA_CLOUD_ACCESS_KEY_SECRET") indiquent que l'AccessKey ID et l'AccessKey secret proviennent des variables d'environnement ALIBABA_CLOUD_ACCESS_KEY_ID et ALIBABA_CLOUD_ACCESS_KEY_SECRET.

   Important

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

Que faire en cas d'échec de l'installation du SDK ?

• Assurez-vous qu'une version valide de Python est installée, par exemple Python 3.x.

• Ajoutez l'option --upgrade lors de l'installation du SDK via pip pour garantir l'installation de la dernière version.

pip install --upgrade <SDK_NAME>  

• En cas de problèmes de permissions pendant l'installation, notamment dans le répertoire système des bibliothèques Python, utilisez l'option --user pour installer le SDK dans le répertoire utilisateur.

pip install --user <SDK_NAME>  

• Si plusieurs versions de Python sont installées sur votre machine, installez le SDK dans la version Python utilisée. Par exemple, utilisez python3 au lieu de python dans le code et exécutez des commandes pip3.

Que faire si l'importation d'un module échoue et que l'erreur ModuleNotFoundError s'affiche ?

Assurez-vous que le SDK est correctement installé, puis tentez d'importer un module dans l'environnement Python.

• Démarrez l'interpréteur Python.

python

• Importez un module.

import <SDK_NAME> 

L'absence d'erreur confirme que le SDK est correctement installé. Si l'erreur ModuleNotFoundError ou ImportError s'affiche, réinstallez le SDK.

pip install <SDK_NAME>

Que faire si le message d'erreur « AttributeError: 'CredentialModel' object has no attribute 'provider_name' » s'affiche ?

Que faire si le message d'erreur suivant s'affiche : code: 400, The input parameter"AccesskeyId" that is mandatory for processing this request is not supplied ?

• Ce message d'erreur apparaît lorsqu'une requête envoyée à la passerelle ne contient pas d'AccessKey ID.

• Vérifiez la configuration de votre AccessKey ID lorsque vous utilisez l'exemple de code complet téléchargé depuis OpenAPI Explorer. Configurez votre AccessKey ID et votre AccessKey secret lors de l'appel de la méthode main.

Dans l'onglet SDK Sample d'OpenAPI Explorer, localisez accessKeyId et accessKeySecret dans la méthode main et remplacez les valeurs d'espace réservé par votre AccessKey.

Que faire si le message d'erreur suivant s'affiche : Tea.exceptions.TeaException: Error: SignatureDoesNotMatch.MissingHeader code: 400, The specified signed header "accept;connection;content-type;host;user-agent;x-acs-action;x-acs-content-sha256;x-acs-date;x-acs-signature-nonce;x-acs-version" is not found ?

Cette erreur survient lorsque l'en-tête Connection est défini sur close pour implémenter des connexions éphémères lors de l'appel d'un service en mode auto-signé. La méthode de signature V3 étant incompatible avec ce paramètre, une erreur se produit.

Corrigez cette erreur en utilisant le paramètre suivant : config.signature_algorithm = 'v2'.

Que faire si le message d'erreur suivant s'affiche : Tea.exceptions.TeaException: Connection aborted ?

Ce message indique que l'intervalle entre les requêtes dépasse la limite autorisée. Le serveur maintient une connexion persistante pendant seulement 30 secondes, tandis que le client tente de la conserver indéfiniment. Le serveur ferme donc la connexion après 30 secondes. Toute requête initiée par le client après ce délai échoue.

• Définissez l'en-tête Connection sur close pour utiliser des connexions éphémères.

• Configurez un mécanisme de nouvelle tentative pour garantir qu'un appel soit initié dans les 30 secondes.

Que faire si un appel d'API expire et que le message « requests.exceptions.Timeout » ou « requests.exceptions.ConnectionError » s'affiche ?

L'expiration d'un appel d'API peut résulter de divers facteurs. La section suivante décrit les causes courantes et les solutions correspondantes.

Problèmes de connexion réseau

Cause : La requête n'atteint pas le 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.

Solutions :

Exécutez 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 tester la connectivité entre votre hôte local et l'endpoint de l'API Short Message Service (SMS).

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

• Si une réponse est obtenue, spécifiez un délai d'attente approprié pour éviter les échecs de requête dus à des configurations de temporisation inadéquates. Pour plus d'informations, consultez Configurer un délai d'attente. Exemple de code :

• # The timeout period takes effect only for requests that use RuntimeOptions.
  runtimeOptions = RuntimeOptions(
      connect_timeout=5000  # Configure the timeout period for connection requests. Unit: milliseconds.
  )

Cause 2 : Temps de traitement de la requête prolongé

Cause : Le temps nécessaire au traitement de la requête API dépasse le délai de lecture spécifié.

Solution : Augmentez le délai d'attente pour la réponse de l'API. Pour plus d'informations, consultez Configurer un délai d'attente. Vous pouvez par exemple configurer le paramètre de délai de lecture pour prolonger cette durée. Exemple de code :

# The timeout period takes effect only for requests that use RuntimeOptions.
runtimeOptions = RuntimeOptions(
    read_timeout=10000,  # Configure the timeout period for read requests. Unit: milliseconds.
)

Que faire si le message « -bash: python3: command not found » apparaît sous Linux ?

Si Python est déjà installé, ce message d'erreur peut indiquer une mauvaise configuration des liens symboliques.

• Exécutez la commande which python3 pip3 pour vérifier la présence de liens symboliques dans le système. Le cas échéant, supprimez-les.

rm -rf /usr/bin/python3 /usr/bin/pip3

• Recréez les liens symboliques. Localisez le répertoire d'installation de Python, accédez au répertoire bin, puis identifiez pip3.12 et python3.12. Exécutez les commandes suivantes pour créer les liens symboliques :

sudo ln -s /usr/local/python3/bin/python3.12 /usr/bin/python3
sudo ln -s /usr/local/python3/bin/pip3.12 /usr/bin/pip3

Que faire si l'erreur « Invalid parameters » ou « MissingRequiredParameter » s'affiche lors d'un appel d'API ?

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

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

• Vérifiez que tous les paramètres obligatoires, tels que PhoneNumbers et SignName, sont spécifiés dans l'objet de requête construit. Dans cet exemple, l'objet SendSmsRequest est utilisé.

• Confirmez que tous les paramètres requis sont bien renseignés conformément à la référence de l'API.

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

• Avant d'envoyer une requête API, le SDK vérifie automatiquement les paramètres. Si un ou plusieurs paramètres obligatoires manquent, une erreur telle que MissingRequiredParameter s'affiche. Par exemple, l'absence du paramètre PhoneNumbers déclenche l'erreur « MissingPhoneNumbers: code: 400 ». Renseignez alors le paramètre en suivant le message d'erreur.

L'appel de l'API sans le paramètre de numéro de téléphone renvoie une erreur MissingPhoneNumbers: code: 400 dans la console.

send_sms_request = dysmsapi_20170525_models.SendSmsRequest(
            # The mobile numbers to which you want to send a text message.
            phone_numbers='<YOUR_VALUE>',
            # The name of the SMS signature.
            sign_name='<YOUR_VALUE>',
            # The code of the SMS template.
            template_code='<YOUR_VALUE>',
            # The variables of the SMS template. Specify the value in the JSON format. Example: {"code":"1234","name":"1234","time":"1234"}.
            template_param='{"code":"1234","name":"1234","time":"1234"}'
        )

Que faire si un appel d'API échoue et que l'erreur « Tea.exceptions.UnretryableException » s'affiche ?

Assurez-vous que la région sélectionnée prend en charge le service appelé. Pour le service SMS par exemple, vous trouverez les endpoints du service sur sa page produit dans OpenAPI Explorer. Utilisez l'endpoint correspondant à votre région.

Cliquez sur l'onglet Service Area List de la page d'accueil du produit. Utilisez les colonnes Region ID et Service Address pour trouver l'endpoint correct pour chaque région. Par exemple, l'endpoint pour le service SMS dans les régions de Chine continentale est dysmsapi.aliyuncs.com.

Que faire si le message d'erreur suivant s'affiche : File "/usr/local/python3/lib/python3.6/site-packages/alibabacloud_slb20140515/client.py", line 4, in <module> from Tea.core import TeaCore ModuleNotFoundError: No module named 'Tea' ?

Ce message d'erreur résulte d'une version obsolète de pip. Les dépendances installées sont alors incomplètes ou certaines dépendances spécifiques ont été supprimées. Mettez à jour pip et exécutez la commande pip install <Installation package> pour corriger cette erreur. Par exemple, exécutez pip install alibabacloud-tea pour installer le module Tea.

Question 13 : Que faire si le message d'erreur suivant s'affiche : Command "python setup.py egg_info" failed with error code 1 in xxx ?

Cette erreur survient lorsque la version de Python ou de pip est obsolète, ou lorsque les bibliothèques ou packages requis ne sont pas installés. Le SDK ne fonctionne alors pas comme prévu.

Solutions :

1. Vérifiez les versions SSL/TLS : Assurez-vous que l'environnement Python sur l'appareil local prend en charge la version SSL/TLS utilisée par le serveur pour la communication. Dans certains cas, le serveur ne prend en charge que TLS 1.2.

   import ssl
   import urllib3
   # Create an SSL context that uses TLS 1.2.
   ssl_context = ssl.create_urllib3_context(ssl.OP_NO_SSLv2, ssl.OP_NO_SSLv3, ssl.OP_NO_TLSv1, ssl.OP_NO_TLSv1_1)
   # Initialize the urllib3 pool manager.
   http = urllib3.PoolManager(context=ssl_context)
   # Send the request.
   response = http.request('GET', 'https://ocr-api.cn-hangzhou.aliyuncs.com/?Country=Vietnam')
             

2. Vérifiez les problèmes liés à l'environnement Python :

   1. Assurez-vous que le module ssl et la version de la bibliothèque urllib3 sont compatibles avec la version de Python.

   2. Utilisez un environnement virtuel pour réinstaller Python et ses dépendances.

   python -m venv myenv
   source myenv/bin/activate
   pip install requests urllib3 pyOpenSSL

3. Vérifiez l'absence d'erreurs de configuration réseau.

   1. Assurez-vous que le pare-feu de l'appareil local autorise le trafic vers le port HTTPS (port 443).

   2. Si vous utilisez un serveur proxy, assurez-vous qu'il est configuré correctement.

   import requests
   # Use a proxy
   proxies = {
       'http': 'http://your-proxy-server:port',
       'https': 'https://your-proxy-server:port'
   }
   response = requests.get(
       'https://ocr-api.cn-hangzhou.aliyuncs.com/?Country=Vietnam',
       proxies=proxies
   )

4. Mettez à jour les bibliothèques requests et urllib3 pour résoudre le problème.

   pip install --upgrade requests urllib3

5. Si le problème persiste après la mise à jour, il peut provenir du certificat de l'environnement. Configurez les paramètres suivants pour ignorer le certificat et ajuster le délai d'attente :

   # Ignore certificate verification.
   runtimeOptions = RuntimeOptions(
    ignore_ssl=True # Ignores SSL certificate verification. Verification is enabled by default.
   )
   # Adjust the timeout.
   runtimeOptions = RuntimeOptions(
       read_timeout=xxx,  # Read timeout in milliseconds (ms)
       connect_timeout=xxx  # Connection timeout in milliseconds (ms)
   )

6. Si le problème persiste après la désactivation de la vérification du certificat SSL, définissez la variable d'environnement PYTHONHTTPSVERIFY sur 0 pour désactiver la vérification du certificat SSL.

   export PYTHONHTTPSVERIFY=0  # Disable HTTPS verification.

7. Vérifiez le certificat SSL sur la machine locale : Assurez-vous que le certificat SSL sur la machine locale est à jour et complet. Vous pouvez utiliser un outil tel que certbot pour mettre à jour et installer des certificats.

   sudo certbot certonly --standalone --rsa-key-size 4096 --agree-tos --email yo**@email.com