Copies a Thing Specification Language (TSL) model from a source product to a destination product.

Usage notes

  • If a destination product is published, you must call the CancelReleaseProduct operation to unpublish the product before you can copy a TSL model.
  • The categories of the source product and destination product must be the same. The product category is indicated by the CategoryKey parameter. You can call the QueryProduct operation and view the CategoryKey parameter of a product in the returned result.
  • You must specify the version of the TSL model that you want to copy by using the SourceModelVersion parameter in the request. Otherwise, the CopyThingModel operation fails.

QPS limits

Each Alibaba Cloud account can run up to five queries per second (QPS).

Note The 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 CopyThingModel

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

SourceProductKey String Yes a1BwAGV****

The ProductKey of the source 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.

TargetProductKey String Yes a1BwwG0****

The ProductKey of the destination 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. On the Overview page in the IoT Platform console, you can view the ID of the instance.

Important
  • If your instance has an ID, you must specify this parameter. Otherwise, the call fails.
  • If the Overview page or instance ID is not displayed in the IoT Platform console, ignore this parameter.

For more information, see Overview.

ResourceGroupId String No rg-acfm4l5tcwd****

The ID of the resource group.

Note You do not need to configure this parameter.
SourceModelVersion String No V1.0.0

The version of the TSL model that you want to copy.

You can call the ListThingModelVersion operation to view the TSL model versions of a product.

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 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=CopyThingModel
&ProductKeySource=a1rYuVF****
&ProductKeyTarget=a1bPo9p****
&SourceModelVersion=v1.0.0
&<Common request parameters>

Sample success responses

XML format

<CopyThingModelResponse>
  <RequestId>9E76053E-26ED-4AB4-AE58-8AFC3F1E7E8E</RequestId>
  <Success>true</Success>
</CopyThingModelResponse>

JSON format

{
  "RequestId": "9E76053E-26ED-4AB4-AE58-8AFC3F1E7E8E",
  "Success": true
}