物接入IoT Hub

    参数定义

    DeviceListRequest参数列表

    参数名称 参数类型 说明
    devices List<String> 需要进行操作的设备名称列表

    DeviceListResponse参数列表

    参数名称 参数类型 说明
    devices List<String> 需要进行操作的设备名称列表

    DeviceProfile参数列表

    参数名称 参数类型 说明
    DeviceBasicInfo中对应项 DeviceBasicInfo 继承DeviceBasicInfo,描述注册基本信息以及模型使用信息
    attributes JsonNode json对象,存储设备自定义的相关属性
    device DeviceAttributes DeviceAttributes对象,描述设备属性相关信息

    DeviceProfileResponse参数列表

    参数名称 参数类型 说明
    DeviceBasicInfo中对应项 DeviceBasicInfo 继承DeviceBasicInfo,描述注册基本信息以及模型使用信息
    attributes JsonNode json对象,存储设备自定义的相关属性
    device DeviceAttributes DeviceAttributes对象,描述设备属性相关信息

    DeviceBasicInfo参数列表

    参数名称 参数类型 说明
    name String 设备名称
    description String 设备描述
    createTime long 设备创建时间(以毫秒为单位)
    state String 设备状态
    lastActiveTime long 设备最后一次的活跃时间(以毫秒为单位)
    schemaId String 设备采用模型Id
    schemaName String 设备采用模型名称
    favourite boolean 是否收藏,默认false

    DeviceAttributes参数列表

    参数名称 参数类型 说明
    reported JsonNode json对象,存储设备属性实际值
    desired JsonNode json对象,对出设备属性的期望值
    profileVersion Integer 设备属性版本号
    lastUpdatedTime JsonNode 与reported和desired属性一一对应,相应的属性值为更新的时间戳,以long值表示,单位为毫秒

    DeviceViewResponse参数列表

    参数名称 参数类型 说明
    DeviceBasicInfo中对应项 DeviceBasicInfo 继承DeviceBasicInfo,描述注册基本信息以及模型使用信息
    view DeviceViewAttributes DeviceViewAttributes对象,描述按照模板合并后对应的属性信息

    DeviceViewAttributes参数列表

    参数名称 参数类型 说明
    profileVersion Integer 设备属性版本号
    properties JsonNode json数组,每个数组元素都是一个模板中对应的属性

    DeviceAccessDetailResponse参数列表

    参数名称 参数类型 说明
    tcpEndpoint String tcp协议的物接入endpoint
    sslEndpoint String 支持ssl的物接入endpoint
    username String endpointName/thingName
    key String 物接入Thing密钥

    SchemaProperty参数列表

    参数名称 参数类型 说明
    name String 属性名称
    displayName String 属性显示名称
    unit String 数据单位
    defaultValue String 数据默认值
    type String 属性数据类型,string ¦ number ¦ bool ¦ object
    object类型说明:object类型的数据格式与Json object相同,其定义为:一个无序的“‘名称/值’对”集合。一个对象以“{”(左括号)开始,“}”(右括号)结束。每个“名称”后跟一个“:”(冒号);“‘名称/值’ 对”之间使用“,”(逗号)分隔。格式举例如下:

    正确的格式

    {
        "key1": "value1",
        "key2": 123
    }
     
    {
        "key1": "value1",
        "key2": [1, 3, 4],       # value 可以是Array
        "key3" : {
            "key4": "value4"     # 支持嵌套
        }
    } 

    错误的格式

    [1, 3, 5]            # 直接是一个 Array,Object 类型必须在 {} 里面 
    "hello world"        # 直接是一个 字符串
    12.34                # 直接是一个 数字 

    Schema参数列表

    参数名称 参数类型 说明
    id String 模板ID
    name String 模板名称
    description String 模板说明
    createTime long 模板创建时间(以毫秒为单位)
    lastUpdatedTime long 模板更新时间(以毫秒为单位)
    properties List<SchemaProperty> 模板属性列表
    上一篇
    权限管理
    下一篇
    更新历史