Queries the extended Thing Specification Language (TSL) information of a specified product.

Limits

Each Alibaba Cloud account can run a maximum of 20 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 QueryThingModelExtendConfig

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

ProductKey String Yes a1T27vz****

The ProductKey of the product.

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.

ModelVersion String No v1.0.0

The version number of the TSL model.

You can call the ListThingModelVersion operation to view the version numbers of the TSL model for a product.

If you do not specify this parameter, the last published TSL version is returned.

FunctionBlockId String No BatteryModule

The identifier of the custom TSL module. Each identifier is unique in a product.

If you do not specify this parameter, the system exports the data of 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, see Common request parameters.

Response parameters

Parameter Type Example Description
ErrorMessage String A system exception occurred.

The error message returned if the call fails.

Data Struct

The data returned if the call is successful.

Configuration String {\"profile\":{\"productKey\":\"a114x******\"},\"properties\":[{\"originalDataType\":{\"specs\":{\"registerCount\":1,\"reverseRegister\":0,\"swap16\":0},\"type\":\"bool\"},\"identifier\":\"WakeUpData\",\"registerAddress\":\"0x04\",\"scaling\":1,\"writeFunctionCode\":0,\"operateType\":\"inputStatus\",\"pollingTime\":1000,\"trigger\":1}]}

The information of the extended TSL parameters. For more information about the definition of extended parameters, see CreateThingModel.

Code String iot.system.SystemException

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

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=QueryThingModelExtendConfig
&ProductKey=a1T27vz****
&<Common request parameters>

Sample success responses

XML format

<QueryThingModelExtendConfigResponse>
    <Data>
        <Configuration>{"profile":{"productKey":"a114x******"},"properties":[{"originalDataType":{"specs":{"registerCount":1,"reverseRegister":0,"swap16":0},"type":"bool"},"identifier":"WakeUpData","registerAddress":"0x04","scaling":1,"writeFunctionCode":0,"operateType":"inputStatus","pollingTime":1000,"trigger":1}]}</Configuration>
    </Data>
    <RequestId>6DDF9D04-24C3-40D8-B490-2A528E59EA67</RequestId>
    <Success>true</Success>
</QueryThingModelExtendConfigResponse>

JSON format

{
   "Data": {
      "Configuration": "{\"profile\":{\"productKey\":\"a114x******\"},\"properties\":[{\"originalDataType\":{\"specs\":{\"registerCount\":1,\"reverseRegister\":0,\"swap16\":0},\"type\":\"bool\"},\"identifier\":\"WakeUpData\",\"registerAddress\":\"0x04\",\"scaling\":1,\"writeFunctionCode\":0,\"operateType\":\"inputStatus\",\"pollingTime\":1000,\"trigger\":1}]}"
   },
   "RequestId": "6DDF9D04-24C3-40D8-B490-2A528E59EA67",
   "Success": true
}

Error codes

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