文档

Node.js SDK使用说明

更新时间:

物联网平台提供TypeScript语言的云端SDK供开发人员使用。本文介绍云端Node.js SDK的安装和配置,及使用Node.js SDK调用云端API的示例。

安装SDK

  1. 安装Node.js开发环境。

    物联网平台云端升级版Node.js SDK基于Node.js环境构建,需要安装Node.js 8.x及以上版本。

  2. 安装SDK核心库OpenAPI。

    您可使用npm管理依赖库,通过以下命令安装依赖并写入文件package.json。

    npm install @alicloud/openapi-client -S
  3. 安装IoT Node.js SDK。

    执行以下npm命令进行安装,例如安装3.0.8版本SDK。

    npm install --save @alicloud/iot20180120@3.0.8

    Node.js SDK源码信息,请参见alibabacloud-typescript-sdk

初始化SDK

  1. 创建Config对象config,存放SDK初始化信息(AccessKey IDAccessKey Secret、地域ID等)。

  2. 创建Client对象实例client,通过Iot(config)方法,加载config中的SDK信息,完成SDK客户端初始化。

以华东2(上海)地域及其服务接入地址为例,初始代码如下。实际场景设置中,需使用您的物联网平台服务所在地域。

import Iot, * as $Iot from '@alicloud/iot20180120';
import OpenApi, * as $OpenApi from '@alicloud/openapi-client';
let config = new $OpenApi.Config({ });
// 您的AccessKey ID。
config.accessKeyId = process.env.ACCESS_KEY_ID;
// 您的AccessKey Secret。
config.accessKeySecret = process.env.ACCESS_KEY_SECRET;
// 您的可用区ID。
config.regionId = "cn-shanghai";
let client = new Iot(config);

参数

说明

regionId

您的物联网平台服务的地域ID,用于拼接服务接入地址,格式为:iot.${RegionId}.aliyuncs.com。

您可在物联网平台控制台左上方,查看当前服务所在地域。

地域ID的表达方法,请参见支持的地域

SDK客户端的HTTP请求配置、代理配置、超时机制、重试机制等配置方式,请参见阿里云升级版Node.js SDK使用指南

发起调用

物联网平台云端SDK为每个API封装两个类,分别命名为${API名称}+"Request"${API名称}+"Response",分别用于承载API的调用请求和调用结果。

调用步骤

  1. 已完成SDK客户端初始化。具体内容,请参见初始化SDK

  2. 创建对应API的调用请求,生成${API名称}+"Request"类对象实例request

  3. 通过对象实例request,设置API所需的请求参数值。

  4. 创建${API名称}+"Response"类的对象实例response承载响应结果:使用Client对象实例client${API名称}(request)方法,获取API对应request的响应结果,包含服务端响应的bodyheaders

  5. 通过对象实例responsebody成员对象,使用response.body.${返回参数的名称}方法,可获取对应返回参数的值。

    例如:response.body.success用于获取是否调用成功的标识,其中Success为API的通用返回参数。通用返回参数还包含RequestIdErrorMessageCode

  6. 使用catch()方法处理异常报错。

物联网平台云端API,请参见API列表。有关request中请求参数说明,及response中返回参数说明,请参见对应API文档。

本文以调用Pub接口发布消息到Topic为例。请求参数信息,请参见Pub

重要

以下代码中${iotInstanceId}为实例ID值。您可在物联网平台控制台的实例概览页面,查看当前实例的ID值

  • 若有ID值,必须传入该ID值,否则调用API会失败。

  • 若无实例概览页面或ID值,则无需传入ID值。您需删除IotInstanceId相关的请求代码,或传入空值"",否则调用API会失败。

实例的详细说明,请参见实例概述。购买实例方法,请参见购买企业版实例。常见问题,请参见物联网平台实例相关问题

try {
    let client = Client.createClient("${accessKey}", "${accessKeySecret}");
    let request = new $Iot.PubRequest({
        // 物联网平台实例ID。
        iotInstanceId: "${iotInstanceId}",
        // 产品ProductKey。
        productKey: "${productKey}",
        // 要发送的消息主体,需通过Base64编码。
        messageContent: "eyJ0ZXN0IjoidGFzayBwdWIgYnJvYWRjYXN0In0=",
        // 要接收消息的设备的自定义Topic。
        topicFullName: "/${productKey}/${deviceName}/user/get",
        // 指定消息的发送方式,支持QoS0和QoS1。
        qos: 0,
    });
    let response = await client.pub(request);
    Console.log(Util.toJSONString($tea.toMap(response)));
} catch (error) {
    Console.log(error.message);
}

完整代码示例

说明

实际场景中,请参照上文的参数说明,替换对应参数值。

import Iot, * as $Iot from '@alicloud/iot20180120';
import Util from '@alicloud/tea-util';
import Env from '@alicloud/darabonba-env';
import OpenApi, * as $OpenApi from '@alicloud/openapi-client';
import Console from '@alicloud/tea-console';
import * as $tea from '@alicloud/tea-typescript';


export default class Client {
  /**
   * 使用AK&SK初始化账号Client。
   * @param accessKeyId
   * @param accessKeySecret
   * @param regionId
   * @return Client
   * @throws Exception
   */
  static createClient(): Iot {
    let config = new $OpenApi.Config({ });
    // 您的AccessKey ID。
    config.accessKeyId = process.env.ACCESS_KEY_ID;
    // 您的AccessKey Secret
    config.accessKeySecret = process.env.ACCESS_KEY_SECRET;
    // 您的可用区ID。
    config.regionId = "cn-shanghai";
    return new Iot(config);
   }


  static async main(args: string[]): Promise<void> {
    try {
      let client = Client.createClient("${accessKey}", "${accessKeySecret}");
      let request = new $Iot.PubRequest({
        // 物联网平台实例ID。
        iotInstanceId: "${iotInstanceId}",
        // 产品ProductKey。
        productKey: "${productKey}",
        // 要发送的消息主体,hello world Base64 String。
        messageContent: "eyJ0ZXN0IjoidGFzayBwdWIgYnJvYWRjYXN0In0=",
        // 要接收消息的设备的自定义Topic。
        topicFullName: "/${productKey}/${deviceName}/user/get",
        // 指定消息的发送方式,支持QoS0和QoS1。
        qos: 0,
      });
      let response = await client.pub(request);
      Console.log(response.body.success);
      Console.log(response.body.requestId);
    } catch (error) {
      Console.log(error.message);
    }    
  }
}

Client.main(process.argv.slice(2));

附录:示例代码

前往物联网平台云端SDK示例中心查看或下载API调用的示例代码。示例代码中包含Java、Python、PHP、Node.js、Go、C++和.NET等版本SDK示例。

阿里云OpenAPI开发者门户提供API在线调试工具。在API调试页面,您可以快速检索和体验调用API。系统会根据您输入的参数同步生成各语言SDK的代码示例。各语言SDK代码示例显示在页面右侧SDK示例页签下供您参考。在调用结果页签下,可查看API调用的真实请求URL和JSON格式的返回结果。

  • 本页导读 (1)