Queries the extended parameters of a published Thing Specification Language (TSL) model.

Limits

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

Note Resource Access Management (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 the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes QueryThingModelExtendConfigPublished

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

ProductKey String Yes a1BwAGV****

The product key.

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 public instances. However, this parameter is required for Enterprise Edition instances.

ModelVersion String No v1.0.0

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

FunctionBlockId String No BatteryModule

The identifier of a TSL-based custom 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 API operation. For more information, see Common request 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.

Data Struct

The data returned if the call succeeds.

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.

For more information, see Data structure of ThingModelJson.

ErrorMessage String A system exception has 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 succeeds.

  • true: The call succeeded.
  • false: The call failed.

Examples

Sample requests

http(s)://iot.cn-shanghai.aliyuncs.com/? Action=QueryThingModelExtendConfigPublished
&ProductKey=a1BwAGV****
&<Common request parameters>

Sample success responses

XML format

<QueryThingModelExtendConfigPublishedResponse>
  <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>
</QueryThingModelExtendConfigPublishedResponse>

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.