全部產品
Search
文件中心

IoT Platform:.NET SDK使用說明

更新時間:Jun 30, 2024

物聯網平台提供.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格式的返回結果。