Queries the Thing Specification Language (TSL) model versions of a specified product.

Usage notes

You can manage TSL models by version. After you import a TSL model by calling the ImportThingModelTsl operation, copy a TSL model by calling the CopyThingModel operation, or edit a TSL model, you must publish the TSL model by calling the PublishThingModel operation. Then, the TSL model can be used. Each time a TSL model of a product is published, a new version is generated.

Limits

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

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

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 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.

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
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 is successful.

ModelVersions Array of ModelVersion

The list of TSL model versions. The versions are displayed in descending order based on the release time. The first version is the current version.

Description String Add a light property

The description of the TSL model version.

GmtCreate Long 1579235657535

The timestamp when the TSL model version was published. The time is displayed in UTC. Unit: milliseconds.

ModelVersion String V1.0.0

The version number of the TSL model.

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=ListThingModelVersion
&ProductKey=a1rYuVF****
&<Common request parameters>

Sample success responses

XML format 

<ListThingModelVersionResponse>
  <Data>
        <ModelVersions>
              <ModelVersion>V3.0.0</ModelVersion>
              <GmtCreate>1579235682421</GmtCreate>
              <Description>new properties</Description>
        </ModelVersions>
        <ModelVersions>
              <ModelVersion>V2.0.0</ModelVersion>
              <GmtCreate>1579235657535</GmtCreate>
              <Description>new properties</Description>
        </ModelVersions>
        <ModelVersions>
              <ModelVersion>V1.0.0</ModelVersion>
              <GmtCreate>1579235637994</GmtCreate>
              <Description>Lighting</Description>
        </ModelVersions>
  </Data>
  <RequestId>9BA34AE5-2D94-4BDE-BD78-E7D3FC7985BC</RequestId>
  <Success>true</Success>
</ListThingModelVersionResponse>

JSON format 

{
  "Data": {
    "ModelVersions": [
      {
        "ModelVersion": "V3.0.0",
        "GmtCreate": 1579235682421,
        "Description": "new properties"
      },
      {
        "ModelVersion": "V2.0.0",
        "GmtCreate": 1579235657535,
        "Description": "new properties"
      },
      {
        "ModelVersion": "V1.0.0",
        "GmtCreate": 1579235637994,
        "Description": "Lighting"
      }
    ]
  },
  "RequestId": "9BA34AE5-2D94-4BDE-BD78-E7D3FC7985BC",
  "Success": true
}

Error codes

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