Use Alibaba Cloud SDK for Node.js with an IDE

Go to the API Debugging page in the OpenAPI Portal. Select a cloud product and API. This example uses the ECS DescribeRegions API. Enter DescribeRegions in the search bar and click the API name.

On the Parameter Settings tab, enter the required parameters. The Document tab on the right provides the API description, notes, billing information, and parameter details.

The DescribeRegions API supports three parameters:

On the SDK Sample tab on the right, select a language. Click the Download Project button to download the complete SDK project to your local computer and decompress it.

Open VS Code. In the menu bar, click File > Open Folder. Select the decompressed folder.

In the VS Code menu bar, click Terminal > New Terminal.

In the Terminal, run the following command to install TypeScript.

 npm install -g typescript

In the Terminal, run the following command to install project dependencies.

npm install

In the Terminal, run the following command to compile TypeScript files into JavaScript. The output files are placed in the dist directory.

tsc

In the Terminal, run the following command to execute the sample code.

node ./dist/client.js

Verify the result. Press Ctrl+F in the Terminal and search for statusCode. A "statusCode": 200 response indicates success.

Open VS Code. Click File > Open Folder and create or select a project folder, such as tssdkproject.

In the VS Code menu bar, click Terminal > New Terminal.

Obtain the SDK.

Go to SDK Center. Select a cloud product, such as ECS. Set SDK Version to V2.0 and Language to TypeScript.

Install the SDK.

Copy the installation command into the Terminal and press Enter to run it.

Create a file. Next to the project name, click the New File icon and enter a file name, such as ecsDescribeRegions.js.

Initialize the client.

Initialize an ECS client before calling any ECS API.

// Import the ECS client and the OpenAPI client.
const ecs20140526 = require('@alicloud/ecs20140526');
const openapiclient = require('@alicloud/openapi-client');

/**
 * Initialize the ECS client configuration.
 * This configuration uses the Access Key ID and Access Key Secret from environment variables for authentication and sets the endpoint to ecs.cn-hangzhou.aliyuncs.com.
 */
const ecsconfig = new openapiclient.Config();
ecsconfig.accessKeyId = process.env.ALIBABA_CLOUD_ACCESS_KEY_ID; // Get the Access Key ID from environment variables.
ecsconfig.accessKeySecret = process.env.ALIBABA_CLOUD_ACCESS_KEY_SECRET; // Get the Access Key Secret from environment variables.
ecsconfig.endpoint = 'ecs.cn-hangzhou.aliyuncs.com'; // Set the endpoint for the ECS service.

// Create a client instance for ECS API version 20140526.
const ecs20140526client = new ecs20140526.default(ecsconfig);

Call the API. Review the API Documentation for the target API. The following example calls the `DescribeRegions` API of ECS.

// Import the ECS client and the OpenAPI client.
const ecs20140526 = require('@alicloud/ecs20140526');
const openapiclient = require('@alicloud/openapi-client');

/**
 * Initialize the ECS client configuration.
 * This configuration uses the Access Key ID and Access Key Secret from environment variables for authentication and sets the server-side endpoint to ecs.cn-hangzhou.aliyuncs.com.
 */
const ecsconfig = new openapiclient.Config();
ecsconfig.accessKeyId = process.env.ALIBABA_CLOUD_ACCESS_KEY_ID; // Use the Access Key ID from environment variables.
ecsconfig.accessKeySecret = process.env.ALIBABA_CLOUD_ACCESS_KEY_SECRET; // Use the Access Key Secret from environment variables.
ecsconfig.endpoint = 'ecs.cn-hangzhou.aliyuncs.com'; // Set the endpoint for the ECS service.

// Create a client instance for ECS API version 20140526.
const ecs20140526client = new ecs20140526.default(ecsconfig);
const describeRegionsRequest = new ecs20140526.DescribeRegionsRequest();
// Initiate a request to query all regions.
ecs20140526client.describeRegions(describeRegionsRequest).then((res)=>{
    console.log(res);
})

Handle exceptions.

The Node.js V2.0 SDK throws two types of exceptions: business exceptions (service errors) and network exceptions (thrown after max retries). The sample code does not differentiate between them because the exception classes cannot be imported from external modules.

// Import the ECS client and the OpenAPI client.
const ecs20140526 = require('@alicloud/ecs20140526');
const openapiclient = require('@alicloud/openapi-client');

/**
 * Initialize the ECS client configuration.
 * This configuration uses the Access Key ID and Access Key Secret from environment variables for authentication and sets the server-side endpoint to ecs.cn-hangzhou.aliyuncs.com.
 */
const ecsconfig = new openapiclient.Config();
ecsconfig.accessKeyId = process.env.ALIBABA_CLOUD_ACCESS_KEY_ID; // Use the Access Key ID from environment variables.
ecsconfig.accessKeySecret = process.env.ALIBABA_CLOUD_ACCESS_KEY_SECRET; // Use the Access Key Secret from environment variables.
ecsconfig.endpoint = 'ecs.cn-hangzhou.aliyuncs.com'; // Set the endpoint for the ECS service.

// Create a client instance for ECS API version 20140526.
const ecs20140526client = new ecs20140526.default(ecsconfig);
const describeRegionsRequest = new ecs20140526.DescribeRegionsRequest();
// Initiate a request to query all regions.
ecs20140526client.describeRegions(describeRegionsRequest).then((res) => {
    console.log(res);
}).catch((err) => {
    console.log(err.message);
    throw err;
});

Run the sample code.

1. If Code Runner is installed, right-click in the editor and select Run Code.

   

2. Run the file with the node command, for example, node .\ecsDescribeRegions.js.

   

3. Click Run and Debug in the sidebar or press Ctrl+Shift+D, then click Run and Debug to run the active file.

   

(Optional) Copy sample code from OpenAPI Portal into a file and run it. Automatic SDK code generation.