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

How do I handle AccessKey errors?

Problem: The following error message is returned after running code. The error message indicates that the AccessKey pair is not correctly configured.

• 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. Run the following commands to check whether the ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET environment variables are configured.

   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%

   If a valid AccessKey pair is returned, the environment variables are properly configured. If no AccessKey pair or an invalid AccessKey pair is returned, configure the environment variables as required. For more information, see Configure environment variables in Linux, macOS, and Windows.

2. Check for errors related to the AccessKey pair in the code.

   Sample error request:

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

   Sample success request:

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

   Note

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

   indicate that the AccessKey ID and AccessKey secret are obtained from the ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET environment variables.

   Important

   To prevent security risks, do not write the AccessKey pair in the online code.

What do I do if the "tsc: Fail to recognize the tsc command as the name of a cmdlet, a function, a script, or a executable program..." error message is returned after I run a tsc command?

What do I do if the API request times out and the "Error: connect ETIMEDOUT" message is returned?

Common causes and solutions:

An API call timeout may be caused by multiple factors. The following section describes the common causes and the corresponding solutions:

Cause 1: Network connection issues

Cause: The request cannot reach the server because the network connection between the client and server fails or the network is unstable.

Solution:

Run the ping or curl command to test the connectivity between the on-premises host and the endpoint of the cloud service. For example, run the ping dysmsapi.aliyuncs.com or curl -v https://dysmsapi.aliyuncs.com command to test the connectivity between your on-premises host and the endpoint of the Short Message Service (SMS) API.

• If the command times out or does not receive a response, check for blocking policies on your on-premises firewall or routers.

• If a response is returned, we recommend that you specify a proper timeout period to prevent request failures caused by improper timeout configurations. For more information, see Configure a timeout period. Sample 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: Extended period of time for processing the request

Description: The duration for processing the API request exceeds the specified read timeout period.

Solution: Configure the timeout period to adapt to the extended API response time. For more information, see Configure a timeout period. For example, you can configure the read timeout parameter to extend the read timeout period. Sample 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,
        });

What do I do if the "MissingRequiredParameter" error is reported when I call an API operation?

In this example, the SendSms operation of the Short Message Service (SMS) service is called.

• Log on to OpenAPI Explorer. Go to the API debugging page of the Alibaba Cloud service that you want to call. Find the API operation that you want to call.

• Check whether all required parameters such as phoneNumbers and signName are specified in the constructed request object. In this example, the SendSmsRequest object is used.

• Verify that all the required parameters are specified based on the API reference.

• Make sure that the values of the required parameters are valid. For example, check whether mobile numbers are specified in valid formats.

• Before the SDK sends an API request, the SDK automatically verifies the parameters. If one or more required parameters are not specified, an error such as MissingRequiredParameter is reported. For example, if the phoneNumbers parameter is not specified, the "MissingPhoneNumbers: code: 400" error is reported. In this case, specify the parameter based on the error message.

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

What do I do if I fail to call an API operation because the operation is not supported in the specified region and the "getaddrinfo ENOTFOUND" message is returned?

Make sure that the region that you select supports the service that you want to access. Find the endpoint of the service on the product homepage in OpenAPI Explorer. The following figure shows how to find the endpoint of the SMS service.

How do I handle the errors reported by the npm install command?

Make sure that Node.js and npm are correctly installed. For more information, see Install Node.js on Windows.

How do I resolve a version conflict of a dependency package?

• Run the npm ls command to view the dependency tree and make sure that no version conflicts occur.

• Delete the node_modules directory and the package-lock.json file and reinstall dependencies.

 rm -rf node_modules package-lock.json
 npm install