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 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
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 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. |
Data | Struct |
The data that is returned if the call is successful. |
|
ScriptType | String | JavaScript |
The language of the script. Valid values:
|
ScriptUrl | String | http://*** |
The URL of the script payload. |
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.
|
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.