Alibaba Cloud SDK:Python SDK に関するよくある質問

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")` は、`ALIBABA_CLOUD_ACCESS_KEY_ID` と `ALIBABA_CLOUD_ACCESS_KEY_SECRET` 環境変数から AccessKey ID と AccessKey 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 Secret を構成します。

OpenAPI Explorer の [SDK サンプル] タブで、`main` メソッド内の `accessKeyId` と `accessKeySecret` を見つけ、プレースホルダーの値を実際の 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 コマンドを実行して、オンプレミスホストと Short Message Service (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 オペレーションを呼び出す際に「Invalid parameters」または「MissingRequiredParameter」エラーが報告された場合はどうすればよいですか？

この例では、Short Message Service (SMS) の SendSms オペレーションを使用します。

• OpenAPI Explorer の API デバッグ ページに移動し、クラウドプロダクトと API を選択します。

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

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

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

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

電話番号パラメーターなしで API を呼び出すと、コンソールに MissingPhoneNumbers: code: 400 エラーが返されます。

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

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

選択したリージョンが呼び出しているサービスをサポートしていることを確認してください。SMS を例にとると、OpenAPI Explorer の製品ページでサービスのエンドポイントを見つけることができます。ご利用のリージョンに適したエンドポイントを使用してください。

製品ホームページの [サービスエリアリスト] タブをクリックします。[リージョン ID] と [サービスアドレス] 列を使用して、各リージョンの正しいエンドポイントを見つけます。たとえば、中国本土リージョンの SMS のエンドポイントは `dysmsapi.aliyuncs.com` です。

「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 を更新し、pip install <Installation package> コマンドを実行してこのエラーを修正できます。たとえば、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
   # TLS 1.2 を使用する SSL コンテキストを作成します。
   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 -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 証明書検証を無視します。デフォルトでは検証が有効です。
   )
   # タイムアウトを調整します。
   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