Alibaba Cloud SDK:Use Alibaba Cloud SDKs for Node.js in an IDE

Go to OpenAPI Explorer. Search for the API operation that you want to use. In this example, the DescribeRegions operation of Elastic Compute Service (ECS) is used. Enter DescribeRegions in the search box and click the operation name in the search results to go to the API debugging page.

On the Parameters tab in the middle column, specify the parameters based on your requirements. When you specify the parameters, read the information on the Document tab in the rightmost column. Make sure that you understand the usage notes of the operation and the description of each parameter. Pay attention to billing-related information.

In this example, the DescribeRegions operation supports three request parameters.

On the SDK Sample Code tab in the rightmost column, select a programming language and click Download Project to download the complete SDK project to your computer. Then, decompress the package.

Open VS Code, choose File > Open Folder in the top navigation bar, and then select the decompressed folder.

In the top navigation bar, choose Terminal > New Terminal. The TERMINAL window appears in the lower part of the console.

Run the following command in the terminal to install TypeScript:

 npm install -g typescript

Run the following command in the terminal to read the package.json file in the project, parse all the dependencies listed in the file, and download them to the node_modules directory of the project.

npm install

Run the following command in the terminal to compile the .ts TypeScript files into .js JavaScript files based on the tsconfig.json configuration file. The JavaScript files are usually stored in the specified output directory such as dist for subsequent running or deployment.

tsc

Run the following command in the terminal to run the sample code:

node ./dist/client.js

View the result. Click anywhere in the terminal and press Ctrl+F to search for statusCode. If "statusCode":200 is displayed, the call was successful.

Open VS Code. In the top navigation bar, choose File > Open Folder. Create and select a project folder or select an existing project folder. In this example, a folder named tssdkproject is created and selected.

In the top navigation bar, choose Terminal > New Terminal. The TERMINAL window appears in the lower part of the console.

Obtain the SDK.

Visit SDK Center and select the cloud service whose SDK you want to use. In this example, ECS is used. Select V2.0 as the SDK version and TypeScript as the programming language.

Install the SDK.

Copy the installation command to the terminal and press the Enter key.

Create a file Click the New File... icon to the right of the project name and enter a file name such as ecsDescribeRegions.js.

Initialize the client.

If you want to call the ECS API, you must initialize the ECS client first.

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

/**
 * Initialize the configurations of the ECS client.
 * Use the AccessKey ID and AccessKey secret configured in the environment variables to complete identity verification and set the endpoint to ecs.cn-hangzhou.aliyuncs.com.
 */
const ecsconfig = new openapiclient.Config();
ecsconfig.accessKeyId = process.env.ALIBABA_CLOUD_ACCESS_KEY_ID; // Obtain the AccessKey ID from the environment variables.
ecsconfig.accessKeySecret = process.env.ALIBABA_CLOUD_ACCESS_KEY_SECRET; // Obtain the AccessKey secret from the environment variables.
ecsconfig.endpoint = 'ecs.cn-hangzhou.aliyuncs.com'; // Specify the endpoint of ECS.

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

Call the API operation. Before you call an API operation, you must read the corresponding API documentation. In this example, the DescribeRegions operation of ECS is used.

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

/**
 * Initialize the configurations of the ECS client.
 * Use the AccessKey ID and AccessKey secret configured in the environment variables to complete identity verification and set the endpoint to ecs.cn-hangzhou.aliyuncs.com.
 */
const ecsconfig = new openapiclient.Config();
ecsconfig.accessKeyId = process.env.ALIBABA_CLOUD_ACCESS_KEY_ID; // Obtain the AccessKey ID from the environment variables.
ecsconfig.accessKeySecret = process.env.ALIBABA_CLOUD_ACCESS_KEY_SECRET; // Obtain the AccessKey secret from the environment variables.
ecsconfig.endpoint = 'ecs.cn-hangzhou.aliyuncs.com'; // Specify the endpoint of ECS.

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

Handle exceptions.

In V2.0 SDKs for Node.js, exceptions are divided into two types: exceptions that are caused by business errors and exceptions that are caused by network issues. An exception caused by network issues is thrown if the number of retries reaches the upper limit. Relevant external exception modules are not available to the two types of exceptions. Therefore, the two types of exceptions are not distinguished in the following sample code.

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

/**
 * Initialize the configurations of the ECS client.
 * Use the AccessKey ID and AccessKey secret configured in the environment variables to complete identity verification and set the endpoint to ecs.cn-hangzhou.aliyuncs.com.
 */
const ecsconfig = new openapiclient.Config();
ecsconfig.accessKeyId = process.env.ALIBABA_CLOUD_ACCESS_KEY_ID; // Obtain the AccessKey ID from the environment variables.
ecsconfig.accessKeySecret = process.env.ALIBABA_CLOUD_ACCESS_KEY_SECRET; // Obtain the AccessKey secret from the environment variables.
ecsconfig.endpoint = 'ecs.cn-hangzhou.aliyuncs.com'; // Specify the endpoint of ECS.

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

Run the SDK demo code.

1. If you have installed the Code Runner extension, right-click anywhere in the editor and select Run Code.

   

2. Run the code by using the node command in the terminal. Example: node .\ecsDescribeRegions.js.

   

3. Select the file you want to execute such as ecsDescribeRegions.js. Click the Run and Debug icon in the left-side navigation bar or press Ctrl+Shift+D. Then, click Run and Debug to run the code.

   

Optional. You can also copy the sample code provided in OpenAPI Explorer to a file to run the sample code. For more information about how to obtain the sample code, see Automatic generation of SDK examples.