Submits a data parsing script for a specified product.

Usage notes

  • A data parsing script is used to convert the custom-formatted data to JSON data after the data is reported by a device. You can write a script in JavaScript, Python 2.7, and PHP 7.2. For more information, see Submit scripts for data parsing.
  • Each Alibaba Cloud account can run a maximum of 10 queries per second (QPS).
    Note Resource Access Management (RAM) users share the quota of the Alibaba Cloud account.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes CreateThingScript

The operation that you want to perform. Set the value to CreateThingScript.

ProductKey String Yes a1Q5XoY****

The ProductKey of the product.

You can view the ProductKey on the Product Details page of the IoT Platform console. You can also obtain the ProductKey by calling the QueryProductList operation.

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

The payload of the script. The value cannot be empty.

For more information about script examples, see What is data parsing.

ScriptType String Yes JavaScript

The language of the script. Valid values:

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

The instance ID. This parameter is not required for the public instance but required for the enterprise instances.

In addition to the preceding operation-specific request parameters, you must specify common request parameters when you call this API operation. For more information about common request parameters, see Common request parameters.

Response parameters

Parameter Type Example Description
Code String iot.system.SystemException

The error code that is returned if the call fails. For more information, see Error codes.

ErrorMessage String A system exception has occurred.

The error message that is returned if the call fails.

RequestId String BB71E443-4447-4024-A000-EDE09922891E

The globally unique ID that Alibaba Cloud generated for the request.

Success Boolean true

Indicates whether the call was successful.

  • true: The call was successful.
  • false: The call failed.

Examples

Sample requests

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

Sample success responses

XML format

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

JSON format

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

Error codes

For a list of error codes, visit the API Error Center.