调用该接口为指定产品提交数据解析脚本。

使用说明

  • 数据解析脚本用于将设备上报的自定义格式数据转换为JSON结构体。脚本类型支持JavaScript、Python 2.7、PHP 7.2,更多信息,请参见提交数据解析脚本
  • 如果在企业版实例中调用该接口,请求参数IotInstanceId必须填写。否则,调用接口会失败。
  • 单阿里云账号调用该接口的每秒请求数(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。
  • 公共实例:无需传入此参数。

调用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
  }