Alibaba Cloud SDK:Python SDK に関する FAQ

AccessKey エラーを処理するにはどうすればよいですか？

問題：コードを実行した後に次のエラーメッセージが返されます。エラーメッセージは、AccessKey ペアが正しく構成されていないことを示しています。

• 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.

解決策：

1. 次のコマンドを実行して、ALIBABA_CLOUD_ACCESS_KEY_ID および 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%

   有効な AccessKey ペアが返された場合、環境変数は正しく構成されています。 AccessKey ペアが返されない場合、または無効な AccessKey ペアが返された場合は、必要に応じて環境変数を構成します。 詳細については、「Linux、macOS、および Windows で環境変数を構成する」をご参照ください。

2. コードで AccessKey ペアに関連するエラーを確認します。

   エラーリクエストの例：

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

   成功リクエストの例：

    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']
           )

   説明

   os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID'] および os.environ("ALIBABA_CLOUD_ACCESS_KEY_SECRET") は、AccessKey ID と AccessKey シークレットが ALIBABA_CLOUD_ACCESS_KEY_ID および ALIBABA_CLOUD_ACCESS_KEY_SECRET 環境変数から取得されることを指定します。

   重要

   セキュリティリスクを防ぐため、オンラインコードに AccessKey ペアを書き込まないでください。

SDK のインストールに失敗した場合はどうすればよいですか？

• Python 3.x など、有効な Python バージョンがインストールされていることを確認します。

• pip コマンドを実行して SDK をインストールするときに、--upgrade オプションを追加します。これにより、最新バージョンがインストールされます。

pip install --upgrade <SDK_NAME>  

• インストールプロセス中に、Python ライブラリのシステムディレクトリに SDK をインストールする場合など、権限の問題が発生した場合は、--user オプションを使用して、システムディレクトリではなくユーザーディレクトリに SDK をインストールできます。

pip install --user <SDK_NAME>  

• PC に複数のバージョンの Python がインストールされている場合は、使用する Python バージョンに SDK をインストールしてください。たとえば、コードでは python の代わりに python3 を使用し、pip3 コマンドを実行します。

モジュールのインポートに失敗し、ModuleNotFoundError エラーが報告された場合はどうすればよいですか？

SDK が正しくインストールされていることを確認します。次に、Python 環境でモジュールをインポートしてみてください。

• Python インタープリターを起動します。

python

• モジュールをインポートします。

import <SDK_NAME> 

エラーが発生しない場合は、SDK は正しくインストールされています。ModuleNotFoundError または ImportError エラーが発生した場合は、SDK が正しくインストールされていません。

pip install <SDK_NAME>

「AttributeError: 'CredentialModel' object has no attribute 'provider_name'」エラーメッセージが返された場合はどうすればよいですか？

次のエラーメッセージが返された場合はどうすればよいですか？ code: 400, The input parameter"AccesskeyId" that is mandatory for processing this request is not supplied?

• このエラーメッセージは、ゲートウェイに送信されたリクエストに AccessKey ID が含まれていないために返されます。

• [OpenAPI Explorer] からダウンロードした完全なサンプルコードを使用する際に、AccessKey ID が正しく構成されているかどうかを確認します。main メソッドを呼び出すときに、AccessKey ID と AccessKey シークレットを構成します。

次のエラーメッセージが返された場合はどうすればよいですか？ 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?

このエラーメッセージは、自己署名モードでサービスを呼び出すときに、Connection ヘッダーが close に設定されて短命接続が実装されているために返されます。ただし、署名メソッド V3 はこの設定と互換性がないため、エラーが発生します。

次の設定を使用することで、このエラーを修正できます：config.signature_algorithm = 'v2'。

次のエラーメッセージが返された場合はどうすればよいですか？ Tea.exceptions.TeaException: Connection aborted?

このエラーメッセージは、リクエスト間隔が想定よりも長いために返されます。サーバーは永続的接続を 30 秒間だけ維持しますが、クライアントは接続を永続的に維持します。この場合、サーバーは 30 秒後に接続を閉じます。クライアントが 30 秒後にリクエストを開始すると、リクエストの失敗が発生します。

• Connection ヘッダーを close に設定して、短命接続を実装します。

• 呼び出しが 30 秒以内に行われるように、再試行メカニズムを構成します。

API 呼び出しがタイムアウトし、「requests.exceptions.Timeout」または「requests.exceptions.ConnectionError」エラーメッセージが返された場合はどうすればよいですか？

API 呼び出しのタイムアウトは、複数の要因によって発生する可能性があります。次のセクションでは、一般的な原因と対応する解決策について説明します。

ネットワーク接続の問題

原因：クライアントとサーバー間のネットワーク接続が失敗したか、ネットワークが不安定なため、リクエストがサーバーに到達できません。

解決策：

ping または curl コマンドを実行して、オンプレミスホストとクラウドサービスのエンドポイント間の接続をテストします。たとえば、ping dysmsapi.aliyuncs.com または curl -v https://dysmsapi.aliyuncs.com コマンドを実行して、オンプレミスホストとショートメッセージサービス (SMS) API のエンドポイント間の接続をテストします。

• コマンドがタイムアウトするか、応答を受信しない場合は、オンプレミスのファイアウォールまたはルーターのブロッキングポリシーを確認します。

• 応答が返された場合は、適切なタイムアウト期間を指定して、不適切なタイムアウト構成によるリクエストの失敗を防ぐことをお勧めします。詳細については、「タイムアウト期間を構成する」をご参照ください。サンプルコード：

• # タイムアウト期間は、RuntimeOptions を使用するリクエストに対してのみ有効です。
  runtimeOptions = RuntimeOptions(
      connect_timeout=5000  # 接続リクエストのタイムアウト期間を構成します。単位：ミリ秒。
  )

原因 2：リクエストの処理に時間がかかっている

原因：API リクエストの処理時間が、指定された読み取りタイムアウト期間を超えています。

解決策：API 応答のタイムアウト期間を延長します。詳細については、「タイムアウト期間を構成する」をご参照ください。たとえば、読み取りタイムアウトパラメーターを構成して、読み取りタイムアウト期間を延長できます。サンプルコード：

# タイムアウト期間は、RuntimeOptions を使用するリクエストに対してのみ有効です。
runtimeOptions = RuntimeOptions(
    read_timeout=10000,  # 読み取りリクエストのタイムアウト期間を構成します。単位：ミリ秒。
)

Linux で "-bash: python3: command not found" エラーメッセージが返された場合はどうすればよいですか？

Python をインストール済みの場合、シンボリックリンクが正しく構成されていないために、このエラーメッセージが返される可能性があります。

• which python3 pip3 コマンドを実行して、システムにシンボリックリンクが存在するかどうかを確認します。シンボリックリンクが存在する場合は、シンボリックリンクを削除します。

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

• シンボリックリンクを再作成します。Python のインストールディレクトリを見つけ、bin ディレクトリにアクセスし、pip3.12 と python3.12 を見つけます。次のコマンドを実行して、シンボリックリンクを作成します。

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

API 操作の呼び出し時に「無効なパラメーター」または「MissingRequiredParameter」エラーが報告された場合はどうすればよいですか？

この例では、ショートメッセージサービス（SMS）の SendSms 操作を使用します。

• OpenAPI Explorer] にログインします。[API デバッグ] ページに移動します。呼び出す API 操作を見つけます。

• 構築されたリクエストオブジェクトで、PhoneNumbers や SignName などのすべての必須パラメーターが指定されているかどうかを確認します。この例では、SendSmsRequest オブジェクトが使用されます。

• [API リファレンス] に基づいて、すべての必須パラメーターが指定されていることを確認します。

• 必須パラメーターの値が有効であることを確認します。たとえば、携帯電話番号が有効な形式で指定されているかどうかを確認します。

• SDK は、API リクエストを送信する前に、パラメーターを自動的に検証します。1 つ以上の必須パラメーターが指定されていない場合、MissingRequiredParameter などのエラーが報告されます。たとえば、PhoneNumbers パラメーターが指定されていない場合、「MissingPhoneNumbers: code: 400」エラーが報告されます。この場合は、エラーメッセージに基づいてパラメーターを指定します。

send_sms_request = dysmsapi_20170525_models.SendSmsRequest(
            # ショートメッセージを送信する携帯電話番号。 // 送信先の電話番号
            phone_numbers='<YOUR_VALUE>',
            # SMS 署名の名前。 // SMS署名名
            sign_name='<YOUR_VALUE>',
            # SMS テンプレートのコード。 // SMSテンプレートコード
            template_code='<YOUR_VALUE>',
            # SMS テンプレートの変数。JSON 形式で値を指定します。例：{"code":"1234","name":"1234","time":"1234"}。 // SMSテンプレートの変数。JSON形式で指定します。例: {"code":"1234","name":"1234","time":"1234"}
            template_param='{"code":"1234","name":"1234","time":"1234"}'
        )

API 操作の呼び出しに失敗し、「Tea.exceptions.UnretryableException」エラーが報告された場合はどうすればよいですか？

指定したリージョンで、呼び出そうとしているサービスがサポートされているかどうかを確認します。この例では、SMS を使用します。OpenAPI Explorer] の SMS のホームページにアクセスして、さまざまなリージョンの SMS のエンドポイントを表示できます。有効なエンドポイントを指定していることを確認します。

次のエラーメッセージが返された場合はどうすればよいですか: 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'?

このエラーメッセージは、pip のバージョンが古いため返されます。この場合、インストールされている依存関係が不完全であるか、特定の依存関係が削除されています。pip install <インストール パッケージ> コマンドを実行して pip を更新することで、このエラーを修正できます。たとえば、pip install alibabacloud-tea コマンドを実行して、Tea モジュールをインストールします。

質問 13：次のエラーメッセージが返された場合はどうすればよいですか？ Command "python setup.py egg_info" failed with error code 1 in xxx?

このエラーメッセージは、Python または pip のバージョンが古いか、必要なライブラリまたはパッケージがインストールされていないために返されます。その結果、SDK は期待どおりに動作しません。

解決策:

1. SSL/TLS バージョンを確認する: オンプレミス デバイスの Python 環境が、サーバーが通信に使用する SSL/TLS バージョンをサポートしていることを確認します。場合によっては、サーバーは TLS 1.2 のみをサポートしています。

   import ssl
   import urllib3
   
   # SSLコンテキストを作成し、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)
   
   # urllib3 プールマネージャーを初期化します。
   http = urllib3.PoolManager(context=ssl_context)
   
   # リクエストを送信します。
   response = http.request('GET', 'https://ocr-api.cn-hangzhou.aliyuncs.com/?Country=Vietnam')
   

2. Python 環境の問題を確認する:

   1. ssl モジュールと urllib3 ライブラリのバージョンが Python のバージョンと互換性があることを確認します。

   2. 仮想環境を使用して、Python と Python の依存関係を再インストールします:

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

3. ネットワーク構成エラーを確認します。

   1. オンプレミス デバイスのファイアウォールが HTTPS ポート (ポート 443) へのトラフィックを許可していることを確認します。

   2. プロキシを使用している場合は、プロキシ構成が正しいことを確認します。

   import requests
   
   # プロキシを使用します。
   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. requests ライブラリと urllib3 ライブラリを更新して、問題を解決します。

   pip install --upgrade requests urllib3

5. 更新後も問題が解決しない場合は、環境証明書が原因である可能性があります。証明書を無視し、タイムアウト期間を調整するために、次のパラメーターを構成します。

   # 証明書の検証を無効にします。
   runtimeOptions = RuntimeOptions(
    ignore_ssl=True # SSL 証明書の検証を無効にします。デフォルトでは、SSL 証明書の検証は有効になっています。
   )
   
   # タイムアウト期間を調整します。
   runtimeOptions = RuntimeOptions(
       read_timeout=xxx,  # 読み取りリクエストのタイムアウト期間。単位: ミリ秒。
       connect_timeout=xxx  # 接続リクエストのタイムアウト期間。単位: ミリ秒。
   )

6. SSL 証明書の検証を無効にしても問題が解決しない場合は、PYTHONHTTPSVERIFY 環境変数を 0 に設定して、SSL 証明書の検証を無効にします。

   export PYTHONHTTPSVERIFY=0  # HTTPS 検証を無効にします。

7. オンプレミス マシンの SSL 証明書を確認する: オンプレミス マシンの SSL 証明書が最新で完全であることを確認します。certbot などのツールを使用して、証明書を更新およびインストールできます。

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