Imports a Thing Specification Language (TSL) model to a specified product.

Limits

  • If a product is published, you must call the CancelReleaseProduct operation to unpublish the product before you call this operation.

Each Alibaba Cloud account can run a maximum of 5 queries per second (QPS).

Note RAM users of an Alibaba Cloud account share the quota of the 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 a sample code of the operation for different SDKs.

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 Product Details page of the IoT Platform console. You can also obtain the ProductKey by calling the QueryProductList operation.

IotInstanceId String No iot_instc_pu****_c*-v64********

The ID of the instance.

You do not need to specify this parameter.

ResourceGroupId String No rg-acfm4l5tcwd****

The ID of the resource group to which the instance belongs.

Note You cannot 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 edited. The value is a JSON string. The TSL model defines the properties, services, and events of the product.

The value of the TslStr parameter must conform to the standard TSL data format. For more information, see TSL data format.

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 that is used to store the TSL data 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 the FunctionBlockName parameter. If you do not specify this parameter, the system imports the default module.

FunctionBlockName String No Battery_Module

The name of the custom 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 the FunctionBlockId parameter. 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 returned if the call fails. For more information, see Error codes.

ErrorMessage String A system exception occurred.

The error message returned if the call fails.

RequestId String E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565

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

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, visit the API Error Center.