CreateDataSourceItem - IoT Platform

使用說明

調用該介面前，請先建立資料來源，具體操作，請參見建立資料來源的步驟1~步驟6；然後在物聯網平台控制台對應執行個體下規則引擎 > 雲產品流轉頁面的資料來源頁簽，查看資料來源ID。

QPS限制

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

說明 RAM使用者共用阿里雲帳號配額。

調試

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

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	CreateDataSourceItem	系統規定參數。取值：CreateDataSourceItem。
DataSourceId	Long	是	1002	資料來源ID。
Topic	String	是	/as/mqtt/status/gy***z/+	應用到規則引擎的具體Topic，格式一般為：`/${productKey}/${deviceName}/topicShortName`。其中，`${productKey}`是裝置所屬產品的ProductKey，`${deviceName}`是具體裝置的名稱，`topicShortName`是Topic剩餘部分。基礎通訊Topic或物模型通訊Topic的格式一般為：`/${productKey}/${deviceName}/topicShortName`。其中，`${deviceName}`可以使用萬用字元`+`代替，表示產品下所有裝置名稱。`topicShortName`取值如下： `/thing/event/property/post` 裝置上報的屬性訊息。 `/thing/event/${tsl.event.identifier}/post`裝置上報的事件訊息，`${}`中是產品物模型中事件identifier。 `/thing/lifecycle` 裝置生命週期變更訊息。 `/thing/downlink/reply/message`裝置響應雲端指令的結果訊息。 `/thing/list/found`網關上報發現子裝置訊息。 `/thing/topo/lifecycle`裝置拓撲關係變更訊息。 `/thing/event/property/history/post`裝置歷史屬性上報訊息。 `/thing/event/${tsl.event.identifier}/history/post`裝置歷史事件上報訊息，`${}`中是產品物模型中事件identifier。 `/ota/upgrade`裝置OTA升級狀態通知訊息。 `/ota/version/post`裝置OTA模組版本號碼上報訊息。 `/thing/deviceinfo/update`裝置標籤變更訊息。 OTA升級批次狀態通知Topic也屬於基礎通訊Topic,格式為：`/${productKey}/${packageId}/${jobId}/ota/job/status`。其中，`${packageId}`是升級包ID，`${jobId}`是升級批次ID。自訂訊息Topic為：`/${productKey}/${deviceName}/user/#`，如：`/${productKey}/${deviceName}/user/get`。調用QueryProductTopic介面，可以查看產品下的所有自訂Topic類。指定自訂Topic時，可以使用萬用字元`+`和`#`。 `${deviceName}`可以使用萬用字元`+`代替，表示產品下所有裝置；之後欄位可以用`/user/#`，`#`表示`/user`層級之後的所有層級名稱。裝置狀態變化通知Topic為：`/as/mqtt/status/${productKey}/${deviceName}`。可以直接使用萬用字元`+`，表示產品下所有裝置的狀態變化通知。使用萬用字元，請參見Topic類中的萬用字元。 Topic資料格式的詳細說明，請參見資料格式。
IotInstanceId	String	否	iot-0pp1n8t***	執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面，查看當前執行個體的ID。重要若有ID值，必須傳入該ID值，否則調用會失敗。若無執行個體概覽頁面或ID值，則無需傳入。執行個體的更多資訊，請參見執行個體概述。

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

返回資料

名稱	類型	樣本值	描述
Code	String	iot.system.SystemException	調用失敗時，返回的錯誤碼。更多資訊，請參見錯誤碼。
ErrorMessage	String	系統異常	調用失敗時，返回的出錯資訊。
RequestId	String	E4C0FF92-2A86-41DB-92D3-73B60310D25E	阿里雲為該請求產生的唯一識別碼。
Success	Boolean	true	表示是否調用成功。 true：調用成功。 false：調用失敗。

樣本

請求樣本

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=CreateDataSourceItem
&DataSourceId=1002
&Topic=/as/mqtt/status/gy***z/+
&<公用請求參數>

正常返回樣本

XML格式

<CreateDataSourceItemResponse>
  <RequestId>E4C0FF92-2A86-41DB-92D3-73B60310D25E</RequestId>
  <Success>true</Success>
</CreateDataSourceItemResponse>

JSON格式

{
    "RequestId": "E4C0FF92-2A86-41DB-92D3-73B60310D25E",
    "Success": true
}

錯誤碼

HttpCode	錯誤碼	錯誤資訊	描述
400	iot.prod.NotExistedProduct	The specified product does not exist.	指定的產品不存在。
400	iot.system.SystemException	An internal error occurred. Try again later.	系統異常。
400	iot.common.InvalidFormattedParameter	The parameter format is invalid.	參數格式錯誤。

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