调用该接口根据产品Key来获取物的TSL功能模板,包含属性、事件、服务的定义。

路径 /thing/tsl/getByProducyKey
版本号 1.0.4
协议 HTTP,HTTPS
请求方法 POST
是否需要用户身份鉴权
超时时间 3000

请求参数

名称 类型 是否必选 示例值 描述
productKey String 产品的Key,设备证书信息之一。创建产品时,生活物联网平台为该产品颁发的全局唯一标识。
deviceName String 设备的名称,设备证书信息之一。在注册设备时,自定义的或系统生成的设备名称,具备产品维度内的唯一性。

返回数据

名称 类型 示例值 描述
data String

物的模板JSON对象。

示例

请求示例

{
	"id": "1509086454180",
	"version": "1.0",
	"request":{
		"apiVer": "1.0.4",
		"iotToken": "token"
	},
	"params":{
		"productKey": "value0",
		"deviceName": "value1"
	}
}

正常返回示例

JSON 格式

{
 "code": 200,
    "data": {
        "schema": "http://aliyun/iot/thing/desc/schema",
        "profile": {
            "productKey": "xxxxxxx",
            "deviceName": "xxxxxxxxxxxxxxxx"
        },
        "link": "/sys/a1xxxck/YzqEnxxxxpjjo/thing/",
        "services": [
            {
                "outputData": [

                ],
                "identifier": "ToggleLightSwitch",
                "inputData": [

                ],
                "method": "thing.service.ToggleLightSwitch",
                "name": "翻转主灯开关",
                "required": false,
                "callType": "async"
            }
        ],
        "properties": [
            {
                "identifier": "LightSwitch",
                "dataType": {
                    "specs": {
                        "0": "关闭",
                        "1": "开启"
                    },
                    "type": "bool"
                },
                "name": "主灯开关",
                "accessMode": "rw",
                "required": true
            }
        ],
        "events": [
            {
                "outputData": [
                    {
                        "identifier": "ErrorCode",
                        "dataType": {
                            "specs": {
                                "0": "正常"
                            },
                            "type": "enum"
                        },
                        "name": "故障代码"
                    }
                ],
                "identifier": "Error",
                "method": "thing.event.Error.post",
                "name": "故障上报",
                "type": "info",
                "required": true
            }
        ]
    },
    "message": "success",
    "localizedMsg": null
}

异常返回示例

JSON 格式

{}