All Products
Search

This Product

    IoT Platform:PublishThingModel

    Document Center

    IoT Platform:PublishThingModel

    最終更新日:Sep 15, 2023

    Publishes the Thing Specification Language (TSL) model of a product.

    Usage notes

    If a product is published, you must call the CancelReleaseProduct operation to unpublish the product before you call this operation.

    QPS limits

    You can call this API operation up to five times per second per account.

    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

    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 Products 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 instance ID. You can view the instance ID on the Overview tab of the IoT Platform console.

    Important

    • If the instance has an ID, you must specify this parameter. If you do not specify this parameter, the request fails.

    • If the Overview page or instance ID is not displayed in the IoT Platform console, you do not need to specify this parameter.

    For more information about instances, see Overview.

    ResourceGroupId

    String

    No

    rg-acfm4l5tcwd****

    The resource group ID.

    Important

    IoT Platform supports resource group management only by instance. The ResourceGroupId parameter is invalid. You do not need to 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 request failed. For more information about error codes, see Error codes.

    ErrorMessage

    String

    A system exception occurred.

    The error message returned if the request failed.

    RequestId

    String

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

    The request ID.

    Success

    Boolean

    true

    Indicates whether the request was successful. Valid values:

    • true

    • false

    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, see Service error codes.