RRpc - IoT Platform

使用說明

調用該介面後，如果裝置端未在設定的逾時時間（Timeout）內做出反饋，即使裝置收到了訊息，雲端也視訊息為發送失敗。

QPS限制

單個阿里雲帳號調用該介面的每秒請求數（QPS）最大限制為1000。

說明

單個阿里雲帳號下的所有RAM使用者共用該阿里雲帳號的配額。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	RRpc	系統規定參數。取值：RRpc。
ProductKey	String	是	aldfeSe****	要發送訊息產品的ProductKey。
DeviceName	String	是	device1	要接收訊息的裝置名稱。
RequestBase64Byte	String	是	dGhpcyBpcyBhbiBleGFtcGxl	要發送的訊息內容。您需要將訊息原文轉換成位元據，並進行Base64編碼，從而產生訊息內容。說明物聯網平台會先對訊息內容進行Base64解碼，再將解碼後的對應訊息發送給裝置。裝置端無需進行Base64解碼。
Timeout	Integer	是	1000	等待裝置回複訊息的時間，單位是毫秒，取值範圍是1,000 ~8,000。
IotInstanceId	String	否	iot_instc_pu***_c-v64********	執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面，查看當前執行個體的ID。重要若有ID值，必須傳入該ID值，否則調用會失敗。若無執行個體概覽頁面或ID值，則無需傳入。執行個體的更多資訊，請參見執行個體概述。
Topic	String	否	/a1uZfYb**/A_Vol**/user/update	使用自訂的RRPC相關Topic。需要裝置端配合使用，請參見裝置端開發自訂Topic。不傳入此參數，則使用系統預設的RRPC Topic。
ContentType	String	否	240	使用JT/T 808協議通訊時，服務端向指定裝置發送訊息的類型。可取值： 0：GNSS模組詳細定位元據。 11：道路運輸證IC卡資訊。 65：串口1透傳。 66：串口2透傳。 240~255：使用者自訂透傳。物聯網平台支援的JT/T 808協議詳細使用說明，請參見JT/T 808協議雲網關概述。

調用API時，除了本文介紹的該API的特有請求參數，還需傳入公用請求參數。公用請求參數說明，請參見公用參數文檔。

返回資料

名稱	類型	樣本值	描述
Code	String	iot.system.SystemException	調用失敗時，返回的錯誤碼。更多資訊，請參見錯誤碼。
ErrorMessage	String	系統異常	調用失敗時，返回的出錯資訊。
MessageId	Long	889455942124347392	成功發送請求訊息後，雲端產生的訊息ID，用於標識該訊息。
PayloadBase64Byte	String	d29ybGQgaGVsbG8=	裝置返回結果Base64編碼後的值。
RequestId	String	41C4265E-F05D-4E2E-AB09-E031F501AF7F	阿里雲為該請求產生的唯一識別碼。
RrpcCode	String	SUCCESS	調用成功時，產生的調用返回碼，標識請求狀態。取值： UNKNOWN：系統異常。 SUCCESS：成功。 TIMEOUT：裝置響應逾時。 OFFLINE：裝置離線。 HALFCONN：裝置離線（裝置串連斷開，但是斷開時間未超過一個心跳周期）。
Success	Boolean	true	是否調用成功。 true：調用成功。 false：調用失敗。

樣本

請求樣本

https://iot.cn-shanghai.aliyuncs.com/?Action=RRpc
&ProductKey=aldfeSe****
&DeviceName=device1
&RequestBase64Byte=dGhpcyBpcyBhbiBleGFtcGxl
&Timeout=1000
&<公用請求參數>

正常返回樣本

XML格式

<?xml version='1.0' encoding='UTF-8'?>
  <RRpcResponse>
      <RequestId>41C4265E-F05D-4E2E-AB09-E031F501AF7F<RequestId/>
      <Success>true</Success>
      <RrpcCode>SUCCESS</RrpcCode>
      <PayloadBase64Byte>d29ybGQgaGVsbG8=</PayloadBase64Byte>
      <MessageId>889455942124347392</MessageId>
  </RRpcResponse>

JSON格式

{
      "RrpcCode":"SUCCESS",
      "PayloadBase64Byte":"d29ybGQgaGVsbG8=",
      "MessageId":889455942124347392,
      "RequestId":"41C4265E-F05D-4E2E-AB09-E031F501AF7F",
      "Success":true
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。