Publishes the Thing specification Language (TSL) model of 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 PublishThingModel

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

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.
ModelVersion String No v1.0.0

The version number of the TSL model.

The version number must be 1 to 16 characters in length and can contain letters, digits, and periods (.).

Description String No Second version

The description of the TSL model version.

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=PublishThingModel
&ProductKeySource=a1rYuVF****
&ModelVersion=V1.0.0
&<Common request parameters>

Sample success responses

XML format

<PublishThingModelResponse>
  <RequestId>5252CC6E-9E4B-4DB1-B1D8-7EEA190A5B3E</RequestId>
  <Success>true</Success>
</PublishThingModelResponse>

JSON format

{
  "RequestId": "5252CC6E-9E4B-4DB1-B1D8-7EEA190A5B3E",
  "Success": true
}

Error codes

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