Imports a Thing Specification Language (TSL) model to a product.
Usage notes
If the product for which you want to call the ImportThingModelTsl operation has been published, you must call the CancelReleaseProduct operation to unpublish the product before you call the ImportThingModelTsl operation.
QPS limits
You can call this operation up to five times per second per account.
The Resource Access Management (RAM) users of an Alibaba Cloud account share the quota of the account.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
Action | String | Yes | ImportThingModelTsl | The operation that you want to perform. Set the value to ImportThingModelTsl. |
ProductKey | String | Yes | a1BwAGV**** | The ProductKey of the product. You can view the ProductKey on the Products page of the IoT Platform console. You can also call the QueryProductList operation to query the ProductKey. |
IotInstanceId | String | No | iot_instc_pu****_c*-v64******** | The instance ID. You can view the instance ID on the Overview tab of the IoT Platform console. Important
For more information about instances, see Overview. |
ResourceGroupId | String | No | rg-acfm4l5tcwd**** | The resource group ID. Important IoT Platform supports only resource management by instance. The ResourceGroupId parameter is discontinued. You do not need to specify this parameter. |
TslStr | String | No | {"schema":"https://iotx-tsl.oss-ap-southeast-1.aliyuncs.com/schema.json","profile":{"productKey":"a14TeW****"},"properties":[]} | The TSL model to be imported. The value is a JSON string. The TSL model defines the properties, services, and events of the product. The value of TslStr must conform to the standard TSL data format. For more information, see What is a TSL model? Note To import a TSL model, you must specify the TslStr parameter. |
TslUrl | String | No | https://iotx-pop-dsl.oss-cn-shanghai.aliyuncs.com/thing/a14TeWI****/model.json?Expires=1581947119... | The URI of the TSL model file stored in Object Storage Service (OSS). Note This parameter does not take effect. To import a TSL model, you must specify the TslStr parameter. |
FunctionBlockId | String | No | BatteryModule | The identifier of the custom TSL module. Each identifier is unique in a product. The identifier must be 1 to 30 characters in length, and can contain letters, digits, and underscores (_). This parameter must be used in combination with FunctionBlockName. If you do not specify this parameter, the system imports the default module. |
FunctionBlockName | String | No | BatteryModule | The name of the custom TSL module. The name must be 4 to 30 characters in length, and can contain letters, digits, and underscores (_). This parameter must be used in combination with FunctionBlockId. If you do not specify this parameter, the system imports the default module. |
In addition to the preceding operation-specific request parameters, you must specify common request parameters when you call this operation. For more information about common request parameters, see Common parameters.
Response parameters
Parameter | Type | Example | Description |
Code | String | iot.system.SystemException | The error code that is returned if the request failed. For more information, see Error codes. |
ErrorMessage | String | A system exception occurred. | The error message that is returned if the request failed. |
RequestId | String | E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565 | The request ID. |
Success | Boolean | true | Indicates whether the request was successful. Valid values:
|
Examples
Sample requests
https://iot.cn-shanghai.aliyuncs.com/?Action=ImportThingModelTsl
&ProductKey=a1lWSUw****
&TslStr={\"profile\":{\"productKey\": \"a1bPo9p****\"},\"services\":[],\"properties\":[],\"events\":[]}
&<Common request parameters>Sample success responses
XML format
<ImportThingModelTslResponse>
<RequestId>9E76053E-26ED-4AB4-AE58-8AFC3F1E7E8E</RequestId>
<Success>true</Success>
</ImportThingModelTslResponse>JSON format
{
"RequestId": "9E76053E-26ED-4AB4-AE58-8AFC3F1E7E8E",
"Success": true
}Error codes
For a list of error codes, see Service error codes.