文档

.NET SDK使用说明

更新时间:

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

安装SDK

  1. 安装.NET开发环境。

    阿里云.NET SDK支持的开发环境如下:

    • .NET Framework 4.5及以上版本。

    • .NET Standard 2.0及以上版本。

    • C# 4.0及以上版本。

    • Visual Studio 2010及以上版本。

  2. 安装SDK核心库OpenAPI。

    • 通过.NET CLI工具来安装。

      以下命令默认安装此软件包的新版本。如果要安装指定版本,请添加--version 指定版本号

      dotnet add package AlibabaCloud.OpenApiClient 
    • 通过配置.csproj文件引入依赖后,再使用命令安装。

      1. 添加依赖。

        <PackageReference Include="AlibabaCloud.OpenApiClient" Version="0.0.13" />
      2. 通过以下命令安装。

        dotnet build
  3. 通过NuGet程序包管理器安装IoT .NET SDK。具体内容,请参见NuGet包

    • 使用Visual Studio的安装方式:

      1. 在Visual Studio的解决方案资源管理器中,右键单击您的项目后,在菜单中选择管理NuGet程序包

      2. NuGet 管理面板中,单击浏览

      3. 在选项卡中,输入AlibabaCloud.SDK,然后在列表中选择Authors为aliyun-openapi-sdk的AlibabaCloud.SDK.Iot20180120。SDK说明,请参见AlibabaCloud.SDK.Iot20180120

      4. 单击安装

    • 其他安装方式:

      • 通过dotnet命令行安装。更多版本信息,请参见物联网平台SDK中心

        # 安装新版本
        dotnet add package AlibabaCloud.SDK.Iot20180120
        
        # 指定sdk版本,以3.0.9版本为例
        dotnet add package AlibabaCloud.SDK.Iot20180120 --version 3.0.9
      • 使用包管理安装。

        # 安装新版本
        Install-Package AlibabaCloud.SDK.Iot20180120
        
        # 指定sdk版本,以3.0.9版本为例
        Install-Package AlibabaCloud.SDK.Iot20180120 -Version 3.0.9

    .NET SDK源码信息,请参见alibabacloud-csharp-sdk

初始化SDK

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

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

    后续调用API的RequestResponse参数从AlibabaCloud.SDK.Iot20180120.Models中获取。

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

AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
// 您的AccessKey ID。
config.AccessKeyId = Environment.GetEnvironmentVariable("ACCESS_KEY_ID");
// 您的AccessKey Secret。
config.AccessKeySecret = Environment.GetEnvironmentVariable("ACCESS_KEY_SECRET");
// 您的可用区ID。
config.RegionId = "cn-shanghai";
AlibabaCloud.SDK.Iot20180120.Client client = new AlibabaCloud.SDK.Iot20180120.Client(config);

参数

说明

AccessKeyId

您阿里云账号的AccessKey ID

您可在阿里云官网控制台AccessKey管理中创建或查看您的AccessKey。

AccessKeySecret

您阿里云账号的AccessKey Secret

RegionId

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

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

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

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

发起调用

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

调用步骤

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

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

  3. 通过对象实例request,使用request.${请求参数的名称}方法,设置AIP所需的请求参数值。

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

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

    例如:response.body.RequestId用于获取阿里云为API请求生成的唯一标识符,其中RequestId为API的通用返回参数。通用返回参数还包含SuccessErrorMessageCode

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

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

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

重要

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

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

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

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

AlibabaCloud.SDK.Iot20180120.Models.PubRequest request = new AlibabaCloud.SDK.Iot20180120.Models.PubRequest
{
    // 物联网平台实例ID。
    IotInstanceId = "${iotInstanceId}",
    // 产品ProductKey。
    ProductKey = "${productKey}",
    // 要发送的消息主体,hello world Base64 String。
    MessageContent = Convert.ToBase64String(Encoding.Default.GetBytes("Hello World.")),
    // 要接收消息的设备的自定义Topic。
    TopicFullName = "/${productKey}/${deviceName}/user/get",
    // 指定消息的发送方式,支持QoS0和QoS1。
    Qos = 0,
};
//通过client对象获得对应request的响应对象response。
try
{
    AlibabaCloud.SDK.Iot20180120.Models.PubResponse response = client.Pub(request);
    Console.WriteLine("publish message result: " + response.Body.Success);
    Console.WriteLine(response.Body.Code);
    Console.WriteLine(response.Body.ErrorMessage);
}
catch (TeaException error)
{
    Console.WriteLine(error.Code);
    Console.WriteLine(error.Message);
}
catch (Exception _error)
{
    Console.WriteLine(_error.Message);
    Console.WriteLine(_error.StackTrace);
}

完整代码示例

说明

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

using System;
using System.Collections;
using System.Collections.Generic;
using System.IO;
using System.Text;
using System.Threading.Tasks;

using Tea;
using Tea.Utils;

namespace AlibabaCloud.SDK.Sample
{
    public class Sample
    {
        /**
         * 使用AK&SK初始化Client。
         * @param accessKeyId 
         * @param accessKeySecret
         * @param regionId
         * @return Client
         * @throws Exception
         */
        public static AlibabaCloud.SDK.Iot20180120.Client CreateClient()
        {
            AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
            // 您的AccessKey ID。
            config.AccessKeyId = Environment.GetEnvironmentVariable("ACCESS_KEY_ID");
            // 您的AccessKey Secret。
            config.AccessKeySecret = Environment.GetEnvironmentVariable("ACCESS_KEY_SECRET");
            // 您的可用区ID。
            config.RegionId = "cn-shanghai";
            return new AlibabaCloud.SDK.Iot20180120.Client(config);
        }


        public static void Main(string[] args)
        {
            try
            {
                AlibabaCloud.SDK.Iot20180120.Client client = CreateClient("${accessKey}", "${accessKeySecret}");
                AlibabaCloud.SDK.Iot20180120.Models.PubRequest request = new AlibabaCloud.SDK.Iot20180120.Models.PubRequest
                {
                    // 物联网平台实例ID。
                    IotInstanceId = "${iotInstanceId}",
                    // 产品ProductKey。
                    ProductKey = "${productKey}",
                    // 要发送的消息主体,hello world Base64 String。
                    MessageContent = Convert.ToBase64String(Encoding.Default.GetBytes("Hello World.")),
                    // 要接收消息的设备的自定义Topic。
                    TopicFullName = "/${productKey}/${deviceName}/user/get",
                    // 指定消息的发送方式,支持QoS0和QoS1。
                    Qos = 0,
                };
                AlibabaCloud.SDK.Iot20180120.Models.PubResponse response = client.Pub(request);
                Console.WriteLine("publish message result: " + response.Body.Success);
                Console.WriteLine(response.Body.Code);
                Console.WriteLine(response.Body.ErrorMessage);
            }
            catch (TeaException error)
            {
                Console.WriteLine(error.Code);
                Console.WriteLine(error.Message);
            }
            catch (Exception _error)
            {
                Console.WriteLine(_error.Message);
                Console.WriteLine(_error.StackTrace);
            }
        }
    }
}

附录:示例代码

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

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

  • 本页导读 (1)
文档反馈