Updates a Thing Specification Language (TSL) feature of a specified product. You can also updates the extended information about the feature.

Limits

  • If a product is published, you must call the CancelReleaseProduct operation to unpublish the product before you call this operation.
  • When you call this operation, you can use the json-schema library to verify the input parameters in ThingModelJson. For more information, see Data structure of ThingModelJson.
  • You can call this operation to update only one feature. TSL features include properties, services, and events.
  • 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

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

ParameterTypeRequiredExampleDescription
ActionStringYesUpdateThingModel

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

ProductKeyStringYesa1BwAGV****

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.

IotInstanceIdStringNoiot-cn-0pp1n8t****

The ID of the instance. You can view the instance ID on the Overview page in the IoT Platform console.

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

IdentifierStringNoTemperature

The identifier of the feature.

You can call the GetThingModelTsl operation and view the identifier in the TslStr response parameter.

ThingModelJsonStringNo{ "properties":[ { "identifier": "SimCardType", "extendConfig":"{...}", "dataSpecs": { "max": "1", "dataType": "INT", "unit": "mmHg", "min": "0", "step": "1" }, "std": false, "custom": true, "dataType": "INT", "rwFlag": "READ_ONLY", "productKey": "a1Jw4i****", "required": false, "customFlag": true, "name": "SIM card type" } ] }

The updated details of the feature.

  • If you specify the Identifier parameter, you can define only the identifier of the feature.
  • If you do not specify the Identifier parameter, you can define a maximum of 50 input and output parameters for a service or event.

For more information about how to specify this parameter, see Data structure of ThingModelJson.

FunctionBlockIdStringNoBatteryModule

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

If you do not specify this parameter or the FunctionBlockName parameter, the system updates the features of the default module.

FunctionBlockNameStringNoBattery_Module

The name of the custom module. The name must be 4 to 30 characters in length, and can contain letters, digits, and underscores (_).

  • If you do not specify this parameter or the FunctionBlockId parameter, the system updates the features of the default module.
  • If you specify this parameter, the parameter must be used in combination with the FunctionBlockId parameter. You can modify the name of the specified custom module. The name corresponds to the value of the FunctionBlockId parameter.
Note You cannot modify the name 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

ParameterTypeExampleDescription
CodeStringiot.system.SystemException

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

ErrorMessageStringA system exception occurred.

The error message returned if the call fails.

RequestIdStringE55E50B7-40EE-4B6B-8BBE-D3ED55CCF565

The ID of the request.

SuccessBooleantrue

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=UpdateThingModel
&ProductKey=a1Jw4id****
&ThingModelJson={"properties":[{"identifier": "SimCardType","dataSpecs": {"max": "1", "dataType": "INT","unit": "mmHg","min": "0","step": "1"},"std": false,"custom": true,"dataType": "INT","rwFlag": "READ_ONLY","productKey": "a1Jw4id****","required": false,"customFlag": true, "name": "SIM card type"}]}
&Identifier=SimCardType
&<Common request parameters>

Sample success responses

XML format

<UpdateThingModelResponse>
  <RequestId>5573D217-8E3E-47AD-9331-2083B88E64B2</RequestId>
  <Success>true</Success>
</UpdateThingModelResponse>

JSON format

{
  "RequestId": "5573D217-8E3E-47AD-9331-2083B88E64B2",
  "Success": true
}

Error codes

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