Node.js V2.0 SDK泛化调用 - 阿里云SDK

阿里云SDK不仅支持使用云产品SDK提供的特化调用方式调用OpenAPI，还支持使用核心SDK提供的泛化调用方式调用OpenAPI，两种方式的不同请参见泛化调用与特化调用。本文将从获取API信息、安装SDK和代码示例来为您介绍如何使用泛化调用。

获取API信息

访问API文档选择云产品，例如选择云服务器ECS。

单击云服务器名称下面的获取元数据，在元数据中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

以调用容器服务查询集群列表信息为例，展示如何使用泛化调用。

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();