Alibaba Cloud SDK:Node.js 向け Alibaba Cloud SDK に関するよくある質問

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

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

• Node.js 向け Alibaba Cloud SDK V2.0：未定義のプロパティを読み取ることができません (reading 'getCredential')。

• Node.js 向け Alibaba Cloud SDK V1.0：AssertionError [ERR_ASSERTION]: "config.accessKeyId" を渡す必要があります。

解決策：

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 ペアに関連するエラーを確認します。

   エラーリクエストの例：

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

   成功リクエストの例：

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

   説明

   process.env['ALIBABA_CLOUD_ACCESS_KEY_ID'] と process.env['ALIBABA_CLOUD_ACCESS_KEY_SECRET']

   は、AccessKey ID と AccessKey シークレットが ALIBABA_CLOUD_ACCESS_KEY_ID 環境変数と ALIBABA_CLOUD_ACCESS_KEY_SECRET 環境変数から取得されることを示しています。

   重要

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

tsc コマンドを実行した後に「tsc: Fail to recognize the tsc command as the name of a cmdlet, a function, a script, or a executable program...」というエラーメッセージが返された場合はどうすればよいですか？

API リクエストがタイムアウトし、「Error: connect ETIMEDOUT」メッセージが返された場合はどうすればよいですか？

一般的な原因と解決策：

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

原因 1：ネットワーク接続の問題

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

解決策：

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

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

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

  JavaScript

  // RuntimeOptions インスタンスを作成し、ランタイムパラメータを指定します。
      const runtime = new RuntimeOptions({
          // 接続リクエストのタイムアウト期間を構成します。
          connectTimeout: 10000,
      });

  TypeScript

  // RuntimeOptions インスタンスを作成し、ランタイムパラメータを指定します。
          const runtime = new $Util.RuntimeOptions({
              // 接続リクエストのタイムアウト期間を構成します。
              connectTimeout: 10000,
          });

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

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

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

// RuntimeOptions インスタンスを作成し、ランタイムパラメータを指定します。
    const runtime = new RuntimeOptions({
        // 読み取りリクエストのタイムアウト期間を構成します。
        readTimeout: 10000,
    });

// RuntimeOptions インスタンスを作成し、ランタイムパラメータを指定します。
        const runtime = new $Util.RuntimeOptions({
            // 読み取りリクエストのタイムアウト期間を構成します。
            readTimeout: 10000,
        });

API 操作を呼び出したときに「MissingRequiredParameter」エラーが報告された場合はどうすればよいですか？

この例では、ショートメッセージサービス (SMS) サービスの SendSms 操作が呼び出されます。

• OpenAPI Explorer にログオンします。 呼び出す Alibaba Cloud サービスの API デバッグページに移動します。 呼び出す API 操作を見つけます。

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

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

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

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

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>",
    });

指定したリージョンで API 操作がサポートされていないため API 操作の呼び出しに失敗し、「getaddrinfo ENOTFOUND」メッセージが返された場合はどうすればよいですか？

選択したリージョンで、アクセスするサービスがサポートされていることを確認します。 OpenAPI Explorer の製品ホームページでサービスのエンドポイントを見つけます。次の図は、SMS サービスのエンドポイントを見つける方法を示しています。

npm install コマンドによって報告されたエラーを処理するにはどうすればよいですか？

Node.js と npm が正しくインストールされていることを確認します。 詳細については、「Windows に Node.js をインストールする」をご参照ください。

依存関係パッケージのバージョン競合を解決するにはどうすればよいですか？

• npm ls コマンドを実行して依存関係ツリーを表示し、バージョン競合が発生していないことを確認します。

• node_modules ディレクトリと package-lock.json ファイルを削除し、依存関係を再インストールします。

 rm -rf node_modules package-lock.json
 npm install