Queries the information about the extended Thing Specification Language (TSL) parameters of a product.
QPS limits
You can call this API operation up to 20 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 | 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 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 | 123*** | The resource group ID. Important IoT Platform supports resource group management only by instance. The ResourceGroupId parameter is invalid. You do not need to specify this parameter. |
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 latest published 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 default module is queried. |
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 |
ErrorMessage | String | A system exception occurred. | The error message returned if the request failed. |
Data | Struct | The data returned if the request was 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 about the extended TSL parameters. For more information about the definition of extended parameters, see the description of extendConfig in the CreateThingModel topic. |
Code | String | iot.system.SystemException | The error code returned if the request failed. For more information about error codes, see Error codes. |
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=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, see Service error codes.