Node.js V2.0 SDK泛化調用 - Alibaba Cloud SDK

阿里雲SDK不僅支援使用雲產品SDK提供的特化調用方式調用OpenAPI，還支援使用核心SDK提供的泛化調用方式調用OpenAPI，兩種方式的不同請參見泛化調用與特化調用。本文將從擷取API資訊、安裝SDK和程式碼範例來為您介紹如何使用泛化調用。

擷取API資訊

訪問API文檔選擇雲產品，例如選擇Elastic Compute Service。

單擊雲端服務器名稱下面的擷取中繼資料，在中繼資料中info.style查看雲產品支援的OpenAPI風格（RPC或者ROA）。
說明
該位置擷取的中繼資料中包含了雲產品的所有API資訊，如果您想要查看單個API的中繼資料，請查看步驟2。
選擇將要調用的API，單擊右上方擷取中繼資料。
在中繼資料中，定義了API支援的網路通訊協定、請求方式、參數及參數位置等資訊。如下圖所示的RunInstances中繼資料中：
- 支援的網路通訊協定有HTTP和HTTPS，建議使用HTTPS。
- 支援的請求方式有GET和POST，兩者請求方式調用結果無任何差異，但GET請求只支援 32 KB 以內的請求包，所以推薦使用POST請求。
- 支援的參數有RegionId、ImageId等，參數位置在query，表示參數是要拼接在請求URL後面，例如https://ecs.cn-beijing.aliyuncs.com/?ImageId=aliyun_2_1903_x64_20G_alibase_20231221.vhd&InstanceChargeType=PostPaid&InstanceType=ecs.e-c1m1.large&InternetChargeType=PayByTraffic&MinAmount=1&Password=test%401234&RegionId=cn-beijing&SecurityGroupId=sg-2zec0dm6qi66XXXXXXXX&SystemDisk.Category=cloud_essd&SystemDisk.Size=40&VSwitchId=vsw-2ze3aagwn397gXXXXXXXX。
說明
中繼資料中其他支援的內容對簽名無影響，這裡暫不詳細說明。更多中繼資料的資訊，請參見中繼資料使用指南。

安裝SDK

在Terminal中執行以下命令安裝核心SDK。

npm install @alicloud/openapi-client

範例程式碼

樣本：調用RPC風格的API

以調用ECS的DescribeRegions介面為例，展示如何使用泛化調用方式。

JavaScript樣本

const OpenApi = require('@alicloud/openapi-client');
const Util = require('@alicloud/tea-util');

class Client {
    static async main() {
        // 從環境變數中擷取阿里雲存取金鑰ID和密鑰Secret。
        let config = new OpenApi.Config({
            accessKeyId: process.env['ALIBABA_CLOUD_ACCESS_KEY_ID'],
            accessKeySecret: process.env['ALIBABA_CLOUD_ACCESS_KEY_SECRET'],
        });
        config.endpoint = `ecs-cn-hangzhou.aliyuncs.com`;
        let client = new OpenApi.default(config);
        let params = new OpenApi.Params({
            style: 'RPC', // API風格
            action: 'DescribeRegions', // API 名稱
            version: '2014-05-26', // API版本號碼
            protocol: 'HTTPS', // API協議
            method: 'POST', // 要求方法
            authType: 'AK',
            pathname: `/`, // 介面 PATH
            reqBodyType: 'json', // 介面請求體內容格式
            bodyType: 'json', // 介面響應體內容格式
        });
        let query = { 'InstanceChargeType': 'PrePaid' };
        let request = new OpenApi.OpenApiRequest({
            query: query,
        });
        let runtime = new Util.RuntimeOptions({});
        let response = await client.callApi(params, request, runtime);
        console.log(response.body.Regions);
    }
}

exports.Client = Client;
Client.main();

TypeScript樣本

import OpenApi, * as $OpenApi from '@alicloud/openapi-client';
import Util, * as $Util from '@alicloud/tea-util';

export default class Client {
  static async main(): Promise<void> {
    // 從環境變數中擷取阿里雲存取金鑰ID和密鑰Secret。
    let config = new $OpenApi.Config({
      accessKeyId: process.env['ALIBABA_CLOUD_ACCESS_KEY_ID'],
      accessKeySecret: process.env['ALIBABA_CLOUD_ACCESS_KEY_SECRET'],
    });
    // 設定API的服務存取點為ecs-cn-hangzhou.aliyuncs.com。
    config.endpoint = `ecs-cn-hangzhou.aliyuncs.com`;
    let client = new OpenApi(config);
    let params = new $OpenApi.Params({
      style: 'RPC', // API風格
      action: 'DescribeRegions', // API 名稱
      version: '2014-05-26', // API版本號碼
      protocol: 'HTTPS', // API協議
      method: 'POST', // 要求方法
      authType: 'AK',
      pathname: `/`, // 介面 PATH
      reqBodyType: 'json', // 介面請求體內容格式
      bodyType: 'json', // 介面響應體內容格式
    });
    // 設定查詢參數。
    let query: { [key: string]: any } = { "InstanceChargeType": "PrePaid" };
    // 建立API請求對象。
    let request = new $OpenApi.OpenApiRequest({
      query: query,
    });

    // 設定運行時參數
    let runtime = new $Util.RuntimeOptions({});
    // 傳回值為 Map 類型，可從 Map 中獲得三類資料：響應體 body、回應標頭 headers、HTTP 返回的狀態代碼 statusCode。
    let response = await client.callApi(params, request, runtime);
    console.log(response.body.Regions);
  }
}

Client.main();

樣本：調用RESTful（ROA）風格的API

以調用Container Service查詢叢集列表資訊為例，展示如何使用泛化調用。

JavaScript樣本

const OpenApi = require('@alicloud/openapi-client');
const OpenApiUtil = require('@alicloud/openapi-util');
const Util = require('@alicloud/tea-util');
const Tea = require('@alicloud/tea-typescript');

class Client {
    static async main() {
        // 從環境變數中擷取阿里雲存取金鑰ID和密鑰Secret。
        let config = new OpenApi.Config({
            accessKeyId: process.env['ALIBABA_CLOUD_ACCESS_KEY_ID'],
            accessKeySecret: process.env['ALIBABA_CLOUD_ACCESS_KEY_SECRET'],
        });
        config.endpoint = `cs.cn-qingdao.aliyuncs.com`;
        let client = new OpenApi.default(config);
        let params = new OpenApi.Params({
            // 介面名稱
            action: 'DescribeClustersV1',
            // 介面版本
            version: '2015-12-15',
            // 介面協議
            protocol: 'HTTPS',
            // 介面 HTTP 方法
            method: 'GET',
            authType: 'AK',
            style: 'ROA',
            // 介面 PATH
            pathname: `/api/v1/clusters`,
            // 介面請求體內容格式
            reqBodyType: 'json',
            // 介面響應體內容格式
            bodyType: 'json',
        });
        // query params
        let queries = {};
        queries['name'] = 'cluster-demo';
        let request = new OpenApi.OpenApiRequest({
            query: OpenApiUtil.default.query(queries),
        });
        // runtime options
        let runtime = new Util.RuntimeOptions({});
        // 傳回值為 Map 類型，可從 Map 中獲得三類資料：響應體 body、回應標頭 headers、HTTP 返回的狀態代碼 statusCode。
        let response = await client.callApi(params, request, runtime);
        console.log(response.body);
    }
}

exports.Client = Client;
Client.main();

TypeScript樣本

import OpenApi, * as $OpenApi from '@alicloud/openapi-client';
import OpenApiUtil from '@alicloud/openapi-util';
import Util, * as $Util from '@alicloud/tea-util';
import * as $tea from '@alicloud/tea-typescript';

export default class Client {
  static async main(): Promise<void> {
    let config = new $OpenApi.Config({
      accessKeyId: process.env['ALIBABA_CLOUD_ACCESS_KEY_ID'],
      accessKeySecret: process.env['ALIBABA_CLOUD_ACCESS_KEY_SECRET'],
    });
    config.endpoint = `cs.cn-qingdao.aliyuncs.com`;
    let client = new OpenApi(config);
    let params = new $OpenApi.Params({
      // 介面名稱
      action: "DescribeClustersV1",
      // 介面版本
      version: "2015-12-15",
      // 介面協議
      protocol: "HTTPS",
      // 介面 HTTP 方法
      method: "GET",
      authType: "AK",
      style: "ROA",
      // 介面 PATH
      pathname: `/api/v1/clusters`,
      // 介面請求體內容格式
      reqBodyType: "json",
      // 介面響應體內容格式
      bodyType: "json",
    });
    // query params
    let queries: { [key: string]: any } = { "name": "cluster-demo" };
    let request = new $OpenApi.OpenApiRequest({
      query: OpenApiUtil.query(queries),
    });
    // runtime options
    let runtime = new $Util.RuntimeOptions({});
    // 傳回值為 Map 類型，可從 Map 中獲得三類資料：響應體 body、回應標頭 headers、HTTP 返回的狀態代碼 statusCode。
    let response = await client.callApi(params, request, runtime);
    console.log(response.body);
  }
}

Client.main();