物的核心模型服务

更新时间：2018-03-15 20:34:06

获取物的属性timeline数据

定义描述

请求参数

返回参数

示例

请求示例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.0",
        "iotToken": "token"
    },
    "params": {
        "iotId": "D95D242941CE821ECCE4F31A2697",
        "identifier": "xxxx",
        "start": 1517217645000,
        "end": 1517217645000,
        "pageSize": 10,
        "ordered": true
    }
}

正常返回示例

{
  "code": 200,
  "message": "success",
  "localizedMsg": null,
  "data": {
    "items": [
      {
        "iotid": "xqxyZjSKzCwaGdlvbv0O0010851c00",
        "data": 1.23,
        "modifytime": 1511812747287,
        "property": "LightVolt",
        "batchId": "2fc766c5e7064554933ed1f3e4b61803",
        "group": null,
        "timestamp": 1511812747245
      },
      {
        "iotid": "xqxyZjSKzCwaGdlvbv0O0010851c00",
        "data": 1.24,
        "modifytime": 1511812747288,
        "property": "LightVolt",
        "batchId": "2fc766c5e7064554933ed1f3e4b61803",
        "group": null,
        "timestamp": 1511812747245
      }
    ],
    "timestamp": 1511812747245
  }
}

错误码

获取物的事件timeline数据

定义描述

请求参数

返回参数

示例

请求示例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.0",
        "iotToken": "token"
    },
    "params": {
        "iotId": "D95D242941CE821ECCE4F31A2697",
        "identifier": "xxxx",
        "eventType": "xxxx",
        "start": 1517217645000,
        "end": 1517217645000,
        "pageSize": 10,
        "ordered": true
    }
}

正常返回示例

{
    "code": 200,
    "message": "success",
    "localizedMsg": "",
    "data": {
        "items": [
            {
                "eventCode": "Error",
                "iotId": "YzqEnI5DY03rxLS2pjjo0010840500",
                "eventName": "故障上报",
                "eventType": "info",
                "eventBody": {
                    "ErrorCode": 0
                },
                "batchId": "5ebc6a9c7d15459f823edde6d28c8fb3",
                "timestamp": 1516342985261
            },
            {
                "eventCode": "Error",
                "iotId": "YzqEnI5DY03rxLS2pjjo0010840500",
                "eventName": "故障上报",
                "eventType": "info",
                "eventBody": {
                    "ErrorCode": 0
                },
                "batchId": "4a0b5a7ac85e470684438d5ff77456f1",
                "timestamp": 1516342995305
            }
        ],
        "timestamp": 1516343075699
    }
}

错误码

设置物的属性

定义描述

请求参数

返回参数

示例

请求示例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.0",
        "iotToken": "token"
    },
    "params": {
        "iotId": "D95D242941CE821ECCE4F31A2697",
        "items": {}
    }
}

正常返回示例

{
  "code": 200,
  "data": null,
  "message": "success",
  "localizedMsg": ""
}

错误码

获取物的事件

定义描述

请求参数

返回参数

示例

请求示例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.0",
        "iotToken": "token"
    },
    "params": {
        "iotId": "D95D242941CE821ECCE4F31A2697"
    }
}

正常返回示例

{
    "code": 200,
    "data": [
        {
            "identifier": "Error",
            "time": 1517420842314,
            "type": "info",
            "value": {
                "Shrink5": 12,
                "Shrink20": {
                    "testKey2": "val2",
                    "testKey": "val"
                }
            }
        }
    ],
    "message": "success",
    "localizedMsg": null
}

错误码

获取物的模板

定义描述

请求参数

返回参数

示例

请求示例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.0",
        "iotToken": "token"
    },
    "params": {
        "iotId": "D95D242941CE821ECCE4F31A2697"
    }
}

正常返回示例

{"code":200,"data":{"schema":"http://aliyun/iot/thing/desc/schema","profile":{"productKey":"a1xqv8AGpck","deviceName":"YzqEnI5DY03rxLS2pjjo"},"link":"/sys/a1xqv8AGpck/YzqEnI5DY03rxLS2pjjo/thing/","services":[{"outputData":[],"identifier":"set","inputData":[{"identifier":"LightSwitch","dataType":{"specs":{"0":"关闭","1":"开启"},"type":"bool"},"name":"主灯开关"},{"identifier":"ColorTemperature","dataType":{"specs":{"unit":"K","min":"2700","unitName":"开尔文","max":"6500"},"type":"int"},"name":"冷暖色温"},{"identifier":"Brightness","dataType":{"specs":{"unit":"%","min":"0","unitName":"百分比","max":"100"},"type":"int"},"name":"明暗度"},{"identifier":"HSVColor","dataType":{"specs":[{"identifier":"Hue","dataType":{"specs":{"unit":"°","min":"0","unitName":"度","max":"360"},"type":"int"},"name":"色调"},{"identifier":"Saturation","dataType":{"specs":{"unit":"%","min":"0","unitName":"百分比","max":"100"},"type":"int"},"name":"饱和度"},{"identifier":"Value","dataType":{"specs":{"unit":"%","min":"0","unitName":"百分比","max":"100"},"type":"int"},"name":"明度"}],"type":"struct"},"name":"HSV调色"},{"identifier":"HSLColor","dataType":{"specs":[{"identifier":"Hue","dataType":{"specs":{"unit":"°","min":"0","unitName":"度","max":"360"},"type":"int"},"name":"色调"},{"identifier":"Saturation","dataType":{"specs":{"unit":"%","min":"0","unitName":"百分比","max":"100"},"type":"int"},"name":"饱和度"},{"identifier":"Lightness","dataType":{"specs":{"unit":"%","min":"0","unitName":"百分比","max":"100"},"type":"int"},"name":"亮度"}],"type":"struct"},"name":"HSL调色"},{"identifier":"RGBColor","dataType":{"specs":[{"identifier":"Red","dataType":{"specs":{"min":"0","unitName":"无","max":"255"},"type":"int"},"name":"红色"},{"identifier":"Green","dataType":{"specs":{"min":"0","unitName":"无","max":"255"},"type":"int"},"name":"绿色"},{"identifier":"Blue","dataType":{"specs":{"min":"0","unitName":"无","max":"255"},"type":"int"},"name":"蓝色"}],"type":"struct"},"name":"RGB调色"},{"identifier":"NightLightSwitch","dataType":{"specs":{"0":"关闭","1":"开启"},"type":"bool"},"name":"夜灯开关"},{"identifier":"WorkMode","dataType":{"specs":{"0":"手动","1":"阅读","2":"影院","3":"夜灯","4":"生活","5":"柔和"},"type":"enum"},"name":"工作模式"}],"method":"thing.service.property.set","name":"set","required":true,"callType":"sync","desc":"属性设置"},{"outputData":[{"identifier":"LightSwitch","dataType":{"specs":{"0":"关闭","1":"开启"},"type":"bool"},"name":"主灯开关"},{"identifier":"ColorTemperature","dataType":{"specs":{"unit":"K","min":"2700","unitName":"开尔文","max":"6500"},"type":"int"},"name":"冷暖色温"},{"identifier":"Brightness","dataType":{"specs":{"unit":"%","min":"0","unitName":"百分比","max":"100"},"type":"int"},"name":"明暗度"},{"identifier":"HSVColor","dataType":{"specs":[{"identifier":"Hue","dataType":{"specs":{"unit":"°","min":"0","unitName":"度","max":"360"},"type":"int"},"name":"色调"},{"identifier":"Saturation","dataType":{"specs":{"unit":"%","min":"0","unitName":"百分比","max":"100"},"type":"int"},"name":"饱和度"},{"identifier":"Value","dataType":{"specs":{"unit":"%","min":"0","unitName":"百分比","max":"100"},"type":"int"},"name":"明度"}],"type":"struct"},"name":"HSV调色"},{"identifier":"HSLColor","dataType":{"specs":[{"identifier":"Hue","dataType":{"specs":{"unit":"°","min":"0","unitName":"度","max":"360"},"type":"int"},"name":"色调"},{"identifier":"Saturation","dataType":{"specs":{"unit":"%","min":"0","unitName":"百分比","max":"100"},"type":"int"},"name":"饱和度"},{"identifier":"Lightness","dataType":{"specs":{"unit":"%","min":"0","unitName":"百分比","max":"100"},"type":"int"},"name":"亮度"}],"type":"struct"},"name":"HSL调色"},{"identifier":"RGBColor","dataType":{"specs":[{"identifier":"Red","dataType":{"specs":{"min":"0","unitName":"无","max":"255"},"type":"int"},"name":"红色"},{"identifier":"Green","dataType":{"specs":{"min":"0","unitName":"无","max":"255"},"type":"int"},"name":"绿色"},{"identifier":"Blue","dataType":{"specs":{"min":"0","unitName":"无","max":"255"},"type":"int"},"name":"蓝色"}],"type":"struct"},"name":"RGB调色"},{"identifier":"NightLightSwitch","dataType":{"specs":{"0":"关闭","1":"开启"},"type":"bool"},"name":"夜灯开关"},{"identifier":"WorkMode","dataType":{"specs":{"0":"手动","1":"阅读","2":"影院","3":"夜灯","4":"生活","5":"柔和"},"type":"enum"},"name":"工作模式"}],"identifier":"get","inputData":["LightSwitch","ColorTemperature","Brightness","HSVColor","HSLColor","RGBColor","NightLightSwitch","WorkMode"],"method":"thing.service.property.get","name":"get","required":true,"callType":"sync","desc":"属性获取"},{"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},{"identifier":"ColorTemperature","dataType":{"specs":{"unit":"K","min":"2700","unitName":"开尔文","max":"6500"},"type":"int"},"name":"冷暖色温","accessMode":"rw","required":false},{"identifier":"Brightness","dataType":{"specs":{"unit":"%","min":"0","unitName":"百分比","max":"100"},"type":"int"},"name":"明暗度","accessMode":"rw","required":false},{"identifier":"HSVColor","dataType":{"specs":[{"identifier":"Hue","dataType":{"specs":{"unit":"°","min":"0","unitName":"度","max":"360"},"type":"int"},"name":"色调"},{"identifier":"Saturation","dataType":{"specs":{"unit":"%","min":"0","unitName":"百分比","max":"100"},"type":"int"},"name":"饱和度"},{"identifier":"Value","dataType":{"specs":{"unit":"%","min":"0","unitName":"百分比","max":"100"},"type":"int"},"name":"明度"}],"type":"struct"},"name":"HSV调色","accessMode":"rw","required":false},{"identifier":"HSLColor","dataType":{"specs":[{"identifier":"Hue","dataType":{"specs":{"unit":"°","min":"0","unitName":"度","max":"360"},"type":"int"},"name":"色调"},{"identifier":"Saturation","dataType":{"specs":{"unit":"%","min":"0","unitName":"百分比","max":"100"},"type":"int"},"name":"饱和度"},{"identifier":"Lightness","dataType":{"specs":{"unit":"%","min":"0","unitName":"百分比","max":"100"},"type":"int"},"name":"亮度"}],"type":"struct"},"name":"HSL调色","accessMode":"rw","required":false},{"identifier":"RGBColor","dataType":{"specs":[{"identifier":"Red","dataType":{"specs":{"min":"0","unitName":"无","max":"255"},"type":"int"},"name":"红色"},{"identifier":"Green","dataType":{"specs":{"min":"0","unitName":"无","max":"255"},"type":"int"},"name":"绿色"},{"identifier":"Blue","dataType":{"specs":{"min":"0","unitName":"无","max":"255"},"type":"int"},"name":"蓝色"}],"type":"struct"},"name":"RGB调色","accessMode":"rw","required":false},{"identifier":"NightLightSwitch","dataType":{"specs":{"0":"关闭","1":"开启"},"type":"bool"},"name":"夜灯开关","accessMode":"rw","required":false},{"identifier":"WorkMode","dataType":{"specs":{"0":"手动","1":"阅读","2":"影院","3":"夜灯","4":"生活","5":"柔和"},"type":"enum"},"name":"工作模式","accessMode":"rw","required":false}],"events":[{"outputData":[{"identifier":"LightSwitch","dataType":{"specs":{"0":"关闭","1":"开启"},"type":"bool"},"name":"主灯开关"},{"identifier":"ColorTemperature","dataType":{"specs":{"unit":"K","min":"2700","unitName":"开尔文","max":"6500"},"type":"int"},"name":"冷暖色温"},{"identifier":"Brightness","dataType":{"specs":{"unit":"%","min":"0","unitName":"百分比","max":"100"},"type":"int"},"name":"明暗度"},{"identifier":"HSVColor","dataType":{"specs":[{"identifier":"Hue","dataType":{"specs":{"unit":"°","min":"0","unitName":"度","max":"360"},"type":"int"},"name":"色调"},{"identifier":"Saturation","dataType":{"specs":{"unit":"%","min":"0","unitName":"百分比","max":"100"},"type":"int"},"name":"饱和度"},{"identifier":"Value","dataType":{"specs":{"unit":"%","min":"0","unitName":"百分比","max":"100"},"type":"int"},"name":"明度"}],"type":"struct"},"name":"HSV调色"},{"identifier":"HSLColor","dataType":{"specs":[{"identifier":"Hue","dataType":{"specs":{"unit":"°","min":"0","unitName":"度","max":"360"},"type":"int"},"name":"色调"},{"identifier":"Saturation","dataType":{"specs":{"unit":"%","min":"0","unitName":"百分比","max":"100"},"type":"int"},"name":"饱和度"},{"identifier":"Lightness","dataType":{"specs":{"unit":"%","min":"0","unitName":"百分比","max":"100"},"type":"int"},"name":"亮度"}],"type":"struct"},"name":"HSL调色"},{"identifier":"RGBColor","dataType":{"specs":[{"identifier":"Red","dataType":{"specs":{"min":"0","unitName":"无","max":"255"},"type":"int"},"name":"红色"},{"identifier":"Green","dataType":{"specs":{"min":"0","unitName":"无","max":"255"},"type":"int"},"name":"绿色"},{"identifier":"Blue","dataType":{"specs":{"min":"0","unitName":"无","max":"255"},"type":"int"},"name":"蓝色"}],"type":"struct"},"name":"RGB调色"},{"identifier":"NightLightSwitch","dataType":{"specs":{"0":"关闭","1":"开启"},"type":"bool"},"name":"夜灯开关"},{"identifier":"WorkMode","dataType":{"specs":{"0":"手动","1":"阅读","2":"影院","3":"夜灯","4":"生活","5":"柔和"},"type":"enum"},"name":"工作模式"}],"identifier":"post","method":"thing.event.property.post","name":"post","type":"info","required":true,"desc":"属性上报"},{"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,"class":"com.aliyun.iotx.common.base.service.IoTxResult"}

错误码

获取物的属性

定义描述

请求参数

返回参数

示例

请求示例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.0",
        "iotToken": "token"
    },
    "params": {
        "iotId": "D95D242941CE821ECCE4F31A2697"
    }
}

正常返回示例

{
  "code": 200,
  "data": {
    "_sys_device_mid": {
      "time": 1516356290173,
      "value": "example.demo.module-id"
    },
    "WorkMode": {
      "time": 1516347450295,
      "value": 0
    },
    "_sys_device_pid": {
      "time": 1516356290173,
      "value": "example.demo.partner-id"
    }
  },
  "message": "success",
  "localizedMsg": null
}

错误码

触发物的服务

定义描述

请求参数

返回参数

示例

请求示例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.0",
        "iotToken": "token"
    },
    "params": {
        "iotId": "D95D242941CE821ECCE4F31A2697",
        "identifier": "xxxx",
        "args": {}
    }
}

正常返回示例

{
  "code": 200,
  "data": null,
  "message": "success",
  "localizedMsg": ""
}

错误码

获取物的连接状态

定义描述

请求参数

返回参数

示例

请求示例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.0",
        "iotToken": "token"
    },
    "params": {
        "iotId": "D95D242941CE821ECCE4F31A2697"
    }
}

正常返回示例

{
  "code": 200,
  "data": {
    "time": 1517923297000,
    "status": 3
  },
  "message": "success",
  "localizedMsg": null,
}

错误码