物联网平台提供.NET语言的云端SDK供开发人员使用。本文介绍云端.NET SDK的安装和配置,及使用.NET SDK调用云端API的示例。
安装SDK
初始化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;
IClientProfile clientProfile = DefaultProfile.GetProfile("cn-shanghai", "<your-access-key-id>", "<your-access-key-secret>");
DefaultAcsClient client = new DefaultAcsClient(clientProfile);
其中,clientProfile 用于存放SDK初始化信息:
cn-shanghai
:您的物联网平台服务的地域代码。您可在物联网平台控制台左上方,查看当前服务所在地域。
地域代码的表达方法,请参见支持的地域。
<your-access-key-id>
和<your-access-key-secret>
:您阿里云账号的AccessKey ID和AccessKey Secret。您可在阿里云官网控制台AccessKey管理中创建或查看您的AccessKey。
发起调用
${API名称}+"Request"
和${API名称}+"Response"
。
${API名称}+"Request"
:用于API的调用请求。通过该类的对象实例request
,使用request.${请求参数的名称}
方法,设置请求参数值。${API名称}+"Response"
:使用DefaultAcsClient对象实例client的GetAcsResponse(request)
方法,承载API的调用结果。通过该类的对象实例response
,使用response.${返回参数的名称}
的方法,可获取对应返回参数的值。例如:
response.Success()
用于获取是否调用成功的标识,其中Success为API的通用返回参数。通用返回参数还包含RequestId、ErrorMessage和Code。
物联网平台云端API,请参见API列表。有关request
中请求参数说明,及response
中返回参数说明,请参见对应API文档。
本文以调用Pub接口发布消息到Topic为例。请求参数信息,请参见Pub。
- 若有ID值,必须传入该ID值,否则调用API会失败。
- 若无实例概览页面或ID值,则无需传入。
实例的详细内容,请参见实例概述。
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示例代码。示例代码中包含Java、Python、PHP、.NET和Go版本SDK示例。
阿里云提供API在线调试工具OpenAPI Explorer。在OpenAPI Explorer页面,您可以快速检索和试验调用API。系统可根据您输入的参数同步生成各语言SDK的示例代码。各语言SDK示例代码显示在页面右侧示例代码页签下。在调试结果页签下,查看API调用的真实请求URL和JSON格式的返回结果。