Alibaba Cloud SDK:Node.js 向け Alibaba Cloud SDK V1.0 と統合する

前提条件

Node.js 8.x 以降がインストールされている。

SDK をインストールする

Node.js 向け Alibaba Cloud SDK V1.0 は、CommonRequest を使用する汎用呼び出しのみをサポートしています。呼び出しメソッドは API 呼び出しプロセスを簡素化し、@alicloud/pop-core 依存関係を統合することで実装できます。次のコマンドを実行して、SDK の依存関係をインストールできます。

npm install @alicloud/pop-core

SDK を使用する

Node.js 向け Alibaba Cloud SDK V1.0 を使用して、リモートプロシージャコール ( RPC ) またはリソース指向アーキテクチャ ( ROA ) スタイルで API 操作を呼び出すことができます。RPC スタイルの API 操作と ROA スタイルの API 操作を呼び出す手順は異なります。このセクションでは、手順について説明します。次の例では、Elastic Compute Service ( ECS ) の RPC スタイルのDescribeInstances API 操作が呼び出され、Container Service for Kubernetes ( ACK ) の ROA スタイルのDescribeClustersV1 API 操作が呼び出されます。

// RPC クライアントを初期化する方法。
const Core = require('@alicloud/pop-core');
var client = new Core({
  // 必須。コードランタイム環境で ALIBABA_CLOUD_ACCESS_KEY_ID 環境変数が設定されていることを確認してください。
  accessKeyId: process.env['ALIBABA_CLOUD_ACCESS_KEY_ID'],
  // 必須。コードランタイム環境で次の環境変数が設定されていることを確認してください: ALIBABA_CLOUD_ACCESS_KEY_SECRET。
  accessKeySecret: process.env['ALIBABA_CLOUD_ACCESS_KEY_SECRET'],
  // http(s)://クラウドサービスエンドポイントの形式のドメイン名。HTTPS を使用することをお勧めします。たとえば、ECS のエンドポイントは http://ecs-cn-hangzhou.aliyuncs.com です。
  endpoint: 'https://ecs.cn-hangzhou.aliyuncs.com',
  // クラウドサービス API のバージョン。例として、ECS API のバージョン番号は 2014-05-26 です。
  apiVersion: '2014-05-26'
});

// ROA クライアントを初期化する方法。
var ROAClient = require('@alicloud/pop-core').ROAClient;
var client = new ROAClient({
  // 必須。コードランタイム環境で ALIBABA_CLOUD_ACCESS_KEY_ID 環境変数が設定されていることを確認してください。
  accessKeyId: process.env['ALIBABA_CLOUD_ACCESS_KEY_ID'],
  // 必須。コードランタイム環境で次の環境変数が設定されていることを確認してください: ALIBABA_CLOUD_ACCESS_KEY_SECRET。
  accessKeySecret: process.env['ALIBABA_CLOUD_ACCESS_KEY_SECRET'],
  // http(s)://クラウドサービスエンドポイントの形式のドメイン名。HTTPS を使用することをお勧めします。たとえば、ECS のエンドポイントは http://cs.cn-chengdu.aliyuncs.com です。
  endpoint: 'https://cs.cn-chengdu.aliyuncs.com',
  // クラウドサービス API のバージョン。例として、ECS API のバージョン番号は 2014-05-26 です。
  apiVersion: '2015-12-15'
});

// API 操作の名前。
var action = 'DescribeInstances'
// リクエストパラメーター。
var params = {
  "RegionId": "cn-hangzhou",
  "InstanceIds": "[\"i-bp67************\", \"i-7xva************\", … \"i-7xvc************\"]"
}
// ランタイムパラメーター。
var requestOption = {
  method: 'POST',
  formatParams: false,
};

// リクエストメソッド。
const method = "GET"
// URI パラメーター。
const uriPattern = '/api/v1/clusters';
// クエリパラメーター。
var queryParams = {
  "cluster_type": "Kubernetes",
  "name": "cluster-demo"
};
// リクエスト本文。JSON 文字列です。例: `{"nodepool_info":{"name":"nodepool-test","type":"ess"}}`;
const body = "";
// カスタムリクエストヘッダー。
const headers = {
  "Content-Type": "application/json"
};
// ランタイムパラメーター。
const options = {
  timeout: 3000, // デフォルト 3000 ms
};

// リクエストを開始します。
client.request(action, params, requestOption).then((result) => {
  console.log(JSON.stringify(result));
}, (ex) => {
  console.log(ex);
})

// リクエストを開始します。
roaClient.request(method, uriPattern, queryParams, body, headers, options)
  .then((response) => {
    console.log('ROA Response:', response);
  })
  .catch((error) => {
    console.error('ROA Error:', error);
  });

// RPC クライアントを初期化する方法。
const Core = require('@alicloud/pop-core');

var client = new Core({
  // 環境変数 ALIBABA_CLOUD_ACCESS_KEY_ID および ALIBABA_CLOUD_ACCESS_KEY_SECRET が設定されていることを確認してください。
  accessKeyId: process.env['ALIBABA_CLOUD_ACCESS_KEY_ID'],
  accessKeySecret: process.env['ALIBABA_CLOUD_ACCESS_KEY_SECRET'],
  // http(s)://クラウドサービスエンドポイントの形式のドメイン名。HTTPS を使用することをお勧めします。たとえば、ECS のエンドポイントは http://ecs-cn-hangzhou.aliyuncs.com です。
  endpoint: 'https://ecs.cn-hangzhou.aliyuncs.com',
  // クラウドサービス API のバージョン。例として、ECS API のバージョン番号は 2014-05-26 です。
  apiVersion: '2014-05-26'
});

// API 操作の名前
var action = 'DescribeInstances'

// リクエストパラメーター。
var params = {
  "RegionId": "cn-hangzhou",
  "InstanceIds": "[\"i-bp67acfmxazb4p****\", \"i-bp67acfmxazb4p****\", … \"i-bp67acfmxazb4p****\"]"
}

// ランタイムパラメーター。
var requestOption = {
  method: 'POST',
  formatParams: false,
};

// リクエストを送信します。
client.request(action, params, requestOption).then((result) => {
  console.log(JSON.stringify(result));
}, (ex) => {
  console.log(ex);
})

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

// ROA クライアントを初期化する方法。
var ROAClient = require('@alicloud/pop-core').ROAClient;
var client = new ROAClient({
  // 必須。コードランタイム環境で ALIBABA_CLOUD_ACCESS_KEY_ID 環境変数が設定されていることを確認してください。
  accessKeyId: process.env['ALIBABA_CLOUD_ACCESS_KEY_ID'],
  // 必須。コードランタイム環境で次の環境変数が設定されていることを確認してください: ALIBABA_CLOUD_ACCESS_KEY_SECRET。
  accessKeySecret: process.env['ALIBABA_CLOUD_ACCESS_KEY_SECRET'],
  // http(s)://クラウドサービスエンドポイントの形式のドメイン名。HTTPS を使用することをお勧めします。たとえば、ECS のエンドポイントは http://cs.cn-chengdu.aliyuncs.com です。
  endpoint: 'https://cs.cn-chengdu.aliyuncs.com',
  // クラウドサービス API のバージョン。例として、ECS API のバージョン番号は 2014-05-26 です。
  apiVersion: '2015-12-15'
});

// リクエストメソッド。
const method = "GET"
// URI パラメーター。
const uriPattern = '/api/v1/clusters';
// クエリパラメーター。
var queryParams = {
  "cluster_type": "Kubernetes",
  "name": "cluster-demo"
};
// リクエスト本文。JSON 文字列です。例: `{"nodepool_info":{"name":"nodepool-test","type":"ess"}}`;
const body = "";
// カスタムリクエストヘッダー。
const headers = {
  "Content-Type": "application/json"
};
// ランタイムパラメーター。
const options = {
  timeout: 3000, // デフォルト 3000 ms
};

// リクエストを送信します。
roaClient.request(method, uriPattern, queryParams, body, headers, options)
  .then((response) => {
    console.log('ROA Response:', response);
  })
  .catch((error) => {
    console.error('ROA Error:', error);
  });

関連情報

• RPC および ROA スタイルの詳細については、「API スタイル」をご参照ください。

• プロキシ設定やタイムアウト設定などの SDK の詳細設定については、「詳細設定」をご参照ください。

• AccessKey ペアの作成方法については、「AccessKey ペアを作成する」をご参照ください。