Queries 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 submitted 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 RAM users of an Alibaba Cloud account share the quota of the account.

Debugging

Alibaba Cloud provides OpenAPI Explorer to simplify API usage. 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 GetThingScript

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

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.

IotInstanceId String No iot-cn-0pp1n8t****

The ID of the instance. You can view the instance ID on the Overview page in the IoT Platform console.

Notice
  • If your instance has an ID, you must configure this parameter. If you do not set this parameter, the call fails.
  • If your instance has no Overview page or ID, you do not need to set this parameter.

For more information, see Overview.

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

Response parameters

Parameter Type Example Description
Code String iot.system.SystemException

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

Data Struct

The data returned if the call is successful.

ScriptType String JavaScript

The type of the script. Valid values:

  • JavaScript
  • Python_27: Python 2.7
  • PHP_72: PHP 7.2
ScriptUrl String http://***

The URL of the script payload.

ErrorMessage String A system exception occurred.

The error message returned if the call fails.

RequestId String BB71E443-4447-4024-A000-EDE09922891E

The ID of 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=GetThingScript
&ProductKey=a1Q5XoY****
&<Common request parameters>

Sample success responses

XML format 

<GetThingScriptResponse>
  <Data>
        <ScriptType>JavaScript</ScriptType>
        <ScriptUrl>http://***</ScriptUrl>
  </Data>
  <RequestId>6DDF9D04-24C3-40D8-B490-2A528E59EA67</RequestId>
  <Success>true</Success>
</GetThingScriptResponse>

JSON format 

{
   "Data": {
        "ScriptType": "JavaScript",
        "ScriptUrl":"http://***"
    },
   "RequestId": "6DDF9D04-24C3-40D8-B490-2A528E59EA67",
   "Success": true
}

Error codes

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