物接入IoT Hub

    参数定义

    DeviceFormatRuleRequest

    参数名 参数类型 说明 示例
    name String 规则名称,默认为空 规则名称1
    sources List<DeviceRuleSource> 必须,需要存储的数据的属性和其条件
    destinations List<DeviceRuleDestination> 必须,处理后的消息写往的目的地数组(TSDB, KAFKA,另一个MQTT主题)目前只支持TSDB [{"kind": "TSDB","value": "test.tsdb.iot.gz.baidubce.com"}]
    format DeviceRuleFormat 必须,转存TSDB数据的格式定义

    DeviceRuleRequest

    参数名 参数类型 说明 示例
    name String 规则名称,默认为空 规则名称1
    sources List<DeviceRuleSource> 必须,需要存储的数据的属性和其条件
    destinations List<DeviceRuleDestination> 必须,处理后的消息写往的目的地数组(TSDB, KAFKA,另一个MQTT主题)目前只支持TSDB [{"kind": "TSDB","value": "test.tsdb.iot.gz.baidubce.com"}]

    DeviceRuleSource

    参数名 参数类型 说明 示例
    description String 非必须,默认为空,条件的描述信息,最长255个字符,默认为空 规则名称1
    name String 必须,对应的模版的属性名称 temperature
    type String 必须,属性数据类型,对应于Schema的数据类型,string,number,bool, object (与TSDB的数据类型的对应类型分别为:String, Double, Long, String) string
    value String 非必需,默认为空,条件对应的阀值 37
    condition String 非必需,默认为空(即表示没有约束条件),约束条件运算符 >=

    约束条件运算符包括:

    运算符 描述
    > 大于
    >= 大于等于
    < 小于
    <= 小于等于
    = 等于
    <> 不等于
    * 表示有数据即存储,此属性数据都会存到TSDB里,此时条件对应的阀值也无效
    为空,即表示没有约束条件,此项数据不作转发处理,此时条件对应的阀值也无效

    DeviceRuleDestination

    参数名 类型 说明 示例
    kind String 必须,目的地类型,可能取值:MQTT, KAFKA, TSDB, BOS, 目前仅限TSDB TSDB
    value String 必须,对于TSDB: value是目的地TSDB数据库的访问域名(也即 endpoint,e.g. test.tsdb.iot.gz.baidubce.com)
    对于MQTT: value是目的地MQTT主题
    对于KAFKA: value是目的地KAFKA主题
    对于BOS: value是目的地BOS的bucket, 如bos://mybucket
    对于MQTT_DYNAMIC: value是一个SQL SELECT子句,用于从原始消息里面选择字段作为目的地主题,如:dest.topic

    DeviceRuleFormat

    参数名 类型 说明 示例
    mode String 必需,存储tsdb的模式, 可选取值:metric,field;
    metric表示多metric模式,每个属性作为metric存入tsdb
    field 表示多field模式,每个属性作为field存入tsdb
    metric
    metric String 必需,自定义metric的名字,仅在field模式下生效
    metric模式下:metric名字为对应的属性名
    newMetricName
    tags Map<k, v> 非必需,自定义tags,仅在field模式下生效,若不填,则默认为设备的 deviceName
    metric模式下:tags为 desc(属性的displayName),deviceName, schemaName
    注:key的限制是 字母、数字、下划线,1-100个字符;value的限制只有1-200个字符的限制
    { "tag1": "aaa", "tag2": "bbb"}

    DeviceRuleResponse

    参数名 类型 说明 示例
    id String 规则对应的id 63d92c1de2bd46e0b257c6df67b4a7e9
    deviceName String 对应的设备名称 myDevicename
    name String 规则名称 规则名称1
    sources List<DeviceRuleSourceDetail> 规则的具体约束条件
    destinations List<DeviceRuleDestinationDetail> 处理后的消息写往的目的地数组(TSDB, KAFKA,另一个MQTT主题)目前只支持TSDB [ { "kind": "TSDB", "value": "test.tsdb.iot.gz.baidubce.com" }]
    enable Boolean 条件默认开启 true
    createTime Long 创建时间 1494904250
    updateTime Long 更新时间 1494904250

    DeviceFormatRuleResponse

    参数名 类型 说明 示例
    id String 规则对应的id 63d92c1de2bd46e0b257c6df67b4a7e9
    deviceName String 对应的设备名称 myDevicename
    name String 规则名称 规则名称1
    sources List 规则的具体约束条件
    destinations List 处理后的消息写往的目的地数组(TSDB, KAFKA,另一个MQTT主题)目前只支持TSDB [{"kind": "TSDB","value": "test.tsdb.iot.gz.baidubce.com"}]
    format DeviceRuleFormat 转存TSDB数据的格式定义 {"mode": "metric"}
    enable Boolean 条件默认开启 true
    createTime Long 创建时间 1494904250
    updateTime Long 更新时间 1494904250

    DeviceRuleSourceDetail

    参数名 类型 说明 示例
    description String 条件的描述信息,最长255个字符 规则名称1
    name String 对应的模版的属性名称 temperature
    type String 属性数据类型,对应于Schema的数据类型,string,number,bool,object string
    displayName String 对应的Schema的属性显示名称 温度
    unit String 对应的Schema的数据单位 Mpa
    defaultValue String 对应的Schema的数据默认值 200
    value String 条件对应的阀值 37
    lastSaveTime Long 最后一次存储时间,没有则为0 1494904250
    condition String 约束条件运算符 >=

    约束条件运算符包括:

    运算符 描述
    > 大于
    >= 大于等于
    < 小于
    <= 小于等于
    = 等于
    <> 不等于
    * 表示有数据即存储,此属性数据都会存到TSDB里,此时条件对应的阀值也无效
    为空,即表示没有约束条件,此项数据不作转发处理,此时条件对应的阀值也无效

    DeviceRuleDestinationDetail

    参数名 类型 说明 示例
    id String 规则目的地的uuid 6653da99bf9a4e35ba4f997e000a699f
    kind String 目的地类型,可能取值:MQTT, KAFKA, TSDB, BOS, 目前仅限TSDB TSDB
    value String 对于TSDB: value是目的地TSDB数据库的访问域名(也即 endpoint,e.g. test.tsdb.iot.gz.baidubce.com
    对于MQTT: value是目的地MQTT主题
    对于KAFKA: value是目的地KAFKA主题
    对于BOS: value是目的地BOS的bucket, 如bos://mybucket
    对于MQTT_DYNAMIC: value是一个SQL SELECT子句,用于从原始消息里面选择字段作为目的地主题,如:dest.topic
    一篇
    修改带TSDB格式的规则
    一篇
    OTA升级服务