全部產品
Search
文件中心

IoT Platform:CreateThingScript

更新時間:Feb 14, 2025

調用該介面為指定產品提交資料解析指令碼。

使用說明

資料解析指令碼用於將裝置上報的自訂格式資料轉換為JSON結構體。指令碼類型支援JavaScript、Python 2.7、PHP 7.2,更多資訊,請參見提交資料解析指令碼

重要 若裝置資料格式為ICA標準資料格式(Alink JSON),不支援使用介面CreateThingScript。

QPS限制

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

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

調試

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

請求參數

名稱 類型 是否必選 樣本值 描述
Action String CreateThingScript

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

ProductKey String a1Q5XoY****

產品ProductKey

可以在物聯網平台控制台產品頁查看,或調用QueryProductList查看ProductKey的取值。

ScriptContent String "function protocolToRawData(jsonObj) {return rawdata; }function rawDataToProtocol(rawData) {return jsonObj; }"

指令碼內容。不允許為空白。

指令碼樣本的更多資訊,請參見什麼是資料解析

ScriptType String JavaScript

指令碼類型。取值:

  • JavaScript
  • Python_27:表示Python 2.7
  • PHP_72:表示PHP 7.2
IotInstanceId String iot-cn-0pp1n8t****

執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面,查看當前執行個體的ID

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

執行個體的更多資訊,請參見執行個體概述

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

返回資料

名稱 類型 樣本值 描述
Code String iot.system.SystemException

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

ErrorMessage String 系統異常

調用失敗時,返回的出錯資訊。

RequestId String BB71E443-4447-4024-A000-EDE09922891E

阿里雲為該請求產生的唯一識別碼。

Success Boolean true

是否調用成功。

  • true:調用成功。
  • false:調用失敗。

樣本

請求樣本

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=CreateThingScript
&ProductKey=a1Q5XoY****
&ScriptContent="function protocolToRawData(jsonObj) {return rawdata; }function rawDataToProtocol(rawData) {return jsonObj; }"
&ScriptType=JavaScript
&<公用請求參數>

正常返回樣本

XML格式

<CreateThingScriptResponse>
    <RequestId>BB71E443-4447-4024-A000-EDE09922891E</RequestId>
    <Success>true</Success>
</CreateThingScriptResponse>

JSON格式

{
      "RequestId":"BB71E443-4447-4024-A000-EDE09922891E",
      "Success":true
  }

錯誤碼

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