調用該接口批量調用設備服務。

使用說明

目前只支持異步調用該接口。

調用服務到設備端后,設備會返回調用結果給接口的調用方。設備端響應邏輯及響應結果,需您在設備端完成開發。設備返回結果的數據格式必須符合標準的Alink協議,Alink JSON格式如下:


{
	"id": "58***89",
	"code": 200,
	"data": {},
	"message": "success",
	"localizedMsg": "localizedMsg"
}
說明
  • id為物聯網平臺生成的唯一ID,設備從服務調用請求中獲取,并原文返回。
  • code為整型數字,會返回給接口調用方,用于判斷服務調用結果。
  • data為調用設備服務的結果數據,會返回給接口調用方。數據必須為JSON格式,由用戶自行定義返回內容。
  • messagelocalizedMsg根據業務需要進行返回。

    例如物聯網平臺的設備接入C Link SDK提供了物模型使用示例,詳細內容,請參見調用服務

QPS限制

單個阿里云賬號調用該接口的每秒請求數(QPS)最大限制為10。

說明 RAM用戶共享該阿里云賬號配額。

調試

您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。

請求參數

名稱 類型 是否必選 示例值 描述
Action String InvokeThingsService

系統規定參數。取值:InvokeThingsService。

Args String {"param1":1}

要啟用服務的入參信息,數據格式為JSON String,例如Args={"param1":1}

若此參數為空時,需傳入Args={}

重要 物模型功能定義數據類型為float或double時,對應參數值(即使值為整數)至少攜帶一位小數位。例如10.0、11.1。
DeviceName.N RepeatList device1

要調用服務的設備的名稱列表。最多支持傳入100個設備名稱。

Identifier String Set

服務的標識符。

設備的服務Identifier的查看方式:

  • 登錄物聯網平臺控制臺,在設備所屬產品的功能定義中查看。
  • 調用接口QueryThingModel,從返回的物模型信息中查看。
說明 如果是自定義(非默認)模塊testFb下服務testService,則參數值為testFb:testService
ProductKey String a1BwAGV****

要調用服務的設備所隸屬的產品ProductKey

IotInstanceId String iot_instc_pu****_c*-v64********

實例ID。您可在物聯網平臺控制臺的實例概覽頁面,查看當前實例的ID

重要
  • 若有ID值,必須傳入該ID值,否則調用會失敗。
  • 若無實例概覽頁面或ID值,則無需傳入。

實例的更多信息,請參見實例概述

Qos Integer 1

指定調用本接口時,消息的發送方式。取值:

  • 0(默認):最多發送一次。
  • 1:最少發送一次。如果QoS=1消息未接收到PUBACK消息,會在設備重連時,重新推送給設備。

調用API時,除了本文介紹的該API的特有請求參數,還需傳入公共請求參數。更多信息,請參見 公共參數文檔

返回數據

名稱 類型 示例值 描述
Code String iot.system.SystemException

調用失敗時,返回的錯誤碼。更多信息,請參見錯誤碼

ErrorMessage String 系統異常

調用失敗時,返回的出錯信息。

RequestId String E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565

阿里云為該請求生成的唯一標識符。

Success Boolean true

表示是否調用成功。

  • true:調用成功,但不代表調用的服務執行成功。執行情況,以設備端日志為準。
  • false:調用失敗。

示例

請求示例

https://iot.cn-shanghai.aliyuncs.com/?Action=InvokeThingsService
&Args=%7B%20%20%20%20%20%22walk%22%3A%22a~z%22%2C%20%20%20%20%20%22city%22%3A%22shanghai%22%20%7D
&DeviceName.1=1102andriod02
&DeviceName.2=1102android01
&Identifier=TimeReset
&ProductKey=a1hWjHD****
&<公共請求參數>

正常返回示例

XML格式

<InvokeThingsServiceResponse>
  <RequestId>059C3274-6197-4BEC-95E4-49A076330E57</RequestId>
  <Success>true</Success>
</InvokeThingsServiceResponse>

JSON格式

{
  "RequestId": "059C3274-6197-4BEC-95E4-49A076330E57",
  "Success": true
}