文档

.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. 通过NuGet程序包管理器安装SDK。

    以使用Visual Studio为例。

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

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

    3. 在选项卡中,输入aliyun-net-sdk,然后在列表中选择Authors为Alibaba Cloud的aliyun-net-sdk-iot

    4. 单击安装

初始化SDK

以调用华东2(上海)地域的API为例,初始化代码如下。

首先创建IClientProfile对象clientProfile,存放SDK初始化信息,然后创建DefaultAcsClient对象实例client,通过DefaultAcsClient(clientProfile)方法,加载SDK信息,完成SDK客户端初始化。

using Aliyun.Acs.Core;
using Aliyun.Acs.Core.Exceptions;
using Aliyun.Acs.Core.Profile;

string accessKeyId = Environment.GetEnvironmentVariable("ALIYUN_ACCESS_KEY_ID");
string accessKeySecret = Environment.GetEnvironmentVariable("ALIYUN_ACCESS_KEY_SECRET");

IClientProfile clientProfile = DefaultProfile.GetProfile("cn-shanghai", accessKeyId, accessKeySecret);
DefaultAcsClient client = new DefaultAcsClient(clientProfile);

其中,clientProfile 用于存放SDK初始化信息:

发起调用

物联网平台云端SDK为每个API封装两个类,分别命名为${API名称}+"Request"${API名称}+"Response"

  • ${API名称}+"Request":用于API的调用请求。通过该类的对象实例request,使用request.${请求参数的名称}方法,设置请求参数值。

  • ${API名称}+"Response":使用DefaultAcsClient对象实例client的GetAcsResponse(request)方法,承载API的调用结果。通过该类的对象实例response,使用response.${返回参数的名称}的方法,可获取对应返回参数的值。

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

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

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

重要

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

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

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

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

PubRequest request = new PubRequest();
request.IotInstanceId = "<iotInstanceId>"; 
request.ProductKey = "<productKey>";
request.TopicFullName = "/<productKey>/<deviceName>/get";
byte[] payload = Encoding.Default.GetBytes("Hello World.");
String payloadStr = Convert.ToBase64String(payload);
request.MessageContent = payloadStr;
request.Qos = 0;
try
{
   PubResponse response = client.GetAcsResponse(request);
   Console.WriteLine("publish message result: " + response.Success);
   Console.WriteLine(response.ErrorMessage);
}
catch (ServerException e)
{
   Console.WriteLine(e.ErrorCode);
   Console.WriteLine(e.ErrorMessage);
}
catch (ClientException e)
{
   Console.WriteLine(e.ErrorCode);
   Console.WriteLine(e.ErrorMessage);
}

附录:示例代码

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

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