Alibaba Cloud SDK:Integrate with Alibaba Cloud SDK V1.0 for Node.js

Prerequisites

Node.js 8.x or later is installed.

Install the SDK

Alibaba Cloud SDK V1.0 for Node.js supports only generic calls that use CommonRequest. The call method simplifies the API call process and can be implemented by integrating the @alicloud/pop-core dependencies. You can run the following command to install the SDK dependencies:

npm install @alicloud/pop-core

Use the SDK

You can use Alibaba Cloud SDK V1.0 for Node.js to call API operations in the remote procedure call (RPC) or resource-oriented architecture (ROA) style. The procedures for calling RPC-style API operations and ROA-style API operations are different. This section describes the procedures. In the following examples, the RPC-style DescribeInstances API operation of Elastic Compute Service (ECS) is called, and the ROA-style DescribeClustersV1 API operation of Container Service for Kubernetes (ACK) is called.

// The method for initializing the RPC client.
const Core = require('@alicloud/pop-core');
var client = new Core({
  // Required. Make sure that the ALIBABA_CLOUD_ACCESS_KEY_ID environment variable is configured in the code runtime environment 
  accessKeyId: process.env['ALIBABA_CLOUD_ACCESS_KEY_ID'],
  // Required. Make sure that the following environment variable is set in the code runtime environment: ALIBABA_CLOUD_ACCESS_KEY_SECRET. 
  accessKeySecret: process.env['ALIBABA_CLOUD_ACCESS_KEY_SECRET'],
  // The domain name in the format of http(s)://The cloud service endpoint. We recommend that you use HTTPS. For example, the endpoint of ECS is http://ecs-cn-hangzhou.aliyuncs.com.
  endpoint: 'https://ecs.cn-hangzhou.aliyuncs.com',
  // The version of the cloud service API. The example, the version number of the ECS API is 2014-05-26.
  apiVersion: '2014-05-26'
});

// The method for initializing the ROA client.
var ROAClient = require('@alicloud/pop-core').ROAClient;
var client = new ROAClient({
  // Required. Make sure that the ALIBABA_CLOUD_ACCESS_KEY_ID environment variable is configured in the code runtime environment 
  accessKeyId: process.env['ALIBABA_CLOUD_ACCESS_KEY_ID'],
  // Required. Make sure that the following environment variable is set in the code runtime environment: ALIBABA_CLOUD_ACCESS_KEY_SECRET. 
  accessKeySecret: process.env['ALIBABA_CLOUD_ACCESS_KEY_SECRET'],
  // The domain name in the format of http(s)://The cloud service endpoint. We recommend that you use HTTPS. For example, the endpoint of ECS is http://cs.cn-chengdu.aliyuncs.com.
  endpoint: 'https://cs.cn-chengdu.aliyuncs.com',
  // The version of the cloud service API. The example, the version number of the ECS API is 2014-05-26.
  apiVersion: '2015-12-15'
});

// The name of the API operation.
var action = 'DescribeInstances'
// The request parameters.
var params = {
  "RegionId": "cn-hangzhou",
  "InstanceIds": "[\"i-bp67************\", \"i-7xva************\", … \"i-7xvc************\"]"
}
// The runtime parameters.
var requestOption = {
  method: 'POST',
  formatParams: false,
};

// The request method.
const method = "GET"
// The URI parameters.
const uriPattern = '/api/v1/clusters';
// The query parameters.
var queryParams = {
  "cluster_type": "Kubernetes",
  "name": "cluster-demo"
};
// The request body, which is a JSON string. Example: `{"nodepool_info":{"name":"nodepool-test","type":"ess"}}`;
const body = "";
// Custom request headers.
const headers = {
  "Content-Type": "application/json"
};
// The runtime parameters.
const options = {
  timeout: 3000, // default 3000 ms
};

// Initiate a request.
client.request(action, params, requestOption).then((result) => {
  console.log(JSON.stringify(result));
}, (ex) => {
  console.log(ex);
})

// Initiate a request.
roaClient.request(method, uriPattern, queryParams, body, headers, options)
  .then((response) => {
    console.log('ROA Response:', response);
  })
  .catch((error) => {
    console.error('ROA Error:', error);
  });

// The method for initializing the RPC client.
const Core = require('@alicloud/pop-core');

var client = new Core({
  // Please ensure that the environment variables ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET are set.
  accessKeyId: process.env['ALIBABA_CLOUD_ACCESS_KEY_ID'],
  accessKeySecret: process.env['ALIBABA_CLOUD_ACCESS_KEY_SECRET'],
  // The domain name in the format of http(s)://The cloud service endpoint. We recommend that you use HTTPS. For example, the endpoint of ECS is http://ecs-cn-hangzhou.aliyuncs.com.
  endpoint: 'https://ecs.cn-hangzhou.aliyuncs.com',
  // The version of the cloud service API. The example, the version number of the ECS API is 2014-05-26.
  apiVersion: '2014-05-26'
});

// The name of the API operation
var action = 'DescribeInstances'

// The request parameters.
var params = {
  "RegionId": "cn-hangzhou",
  "InstanceIds": "[\"i-bp67acfmxazb4p****\", \"i-bp67acfmxazb4p****\", … \"i-bp67acfmxazb4p****\"]"
}

// The runtime parameters.
var requestOption = {
  method: 'POST',
  formatParams: false,
};

// Send the request.
client.request(action, params, requestOption).then((result) => {
  console.log(JSON.stringify(result));
}, (ex) => {
  console.log(ex);
})

const ROAClient = require('@alicloud/pop-core').ROAClient;

// The method for initializing the ROA client.
var ROAClient = require('@alicloud/pop-core').ROAClient;
var client = new ROAClient({
  // Required. Make sure that the ALIBABA_CLOUD_ACCESS_KEY_ID environment variable is configured in the code runtime environment 
  accessKeyId: process.env['ALIBABA_CLOUD_ACCESS_KEY_ID'],
  // Required. Make sure that the following environment variable is set in the code runtime environment: ALIBABA_CLOUD_ACCESS_KEY_SECRET. 
  accessKeySecret: process.env['ALIBABA_CLOUD_ACCESS_KEY_SECRET'],
  // The domain name in the format of http(s)://The cloud service endpoint. We recommend that you use HTTPS. For example, the endpoint of ECS is http://cs.cn-chengdu.aliyuncs.com.
  endpoint: 'https://cs.cn-chengdu.aliyuncs.com',
  // The version of the cloud service API. The example, the version number of the ECS API is 2014-05-26.
  apiVersion: '2015-12-15'
});

// The request method.
const method = "GET"
// The URI parameters.
const uriPattern = '/api/v1/clusters';
// The query parameters.
var queryParams = {
  "cluster_type": "Kubernetes",
  "name": "cluster-demo"
};
// The request body, which is a JSON string. Example: `{"nodepool_info":{"name":"nodepool-test","type":"ess"}}`;
const body = "";
// Custom request headers.
const headers = {
  "Content-Type": "application/json"
};
// The runtime parameters.
const options = {
  timeout: 3000, // default 3000 ms
};

// Send the request.
roaClient.request(method, uriPattern, queryParams, body, headers, options)
  .then((response) => {
    console.log('ROA Response:', response);
  })
  .catch((error) => {
    console.error('ROA Error:', error);
  });

References

• For more information about the RPC and ROA styles, see API styles.

• For more information about advanced SDK settings, such as proxy settings and timeout settings, see Advanced settings.

• For more information about how to create an AccessKey pair, see Create an AccessKey pair.