设备数据转储接入指南

更新时间:2018-07-25 09:50:05

创建设备数据云产品流转规则

定义描述

path 版本 描述
/industry/ruleAction/create 1.0.2 创建设备数据云产品转储规则

请求参数

名称
类型
必要
描述
productKey
String
产品Key
deviceName
String
设备名称
ruleType
String
规则类型,
ONS or DATAHUB
configure
String
​云产品配置参数
accessKeyId
String
阿里云账号accessKeyId
accessSecret
String
阿里云账号accessSecret

请求示例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.2"
    },
    "params": {
        "productKey": "您的产品Key",
        "deviceName": "您的设备名称",
        "ruleType": "ONS or DATAHUB",
        "configure": "参考如下:",
        "accessKeyId": "阿里云账号ak",
        "accessSecret": "阿里云账号secret"
    }
}

DataHub configure参数参考:

{
    "schemaVals": [
        {
            "name": "devicename",
            "value": "${items.devicename.value}",
            "type": "STRING"
        },
        {
            "name": "msgtime",
            "value": "${items.msgtime.value}",
            "type": "TIMESTAMP"
        }
    ],
    "role": {
        "roleArn": "acs:ram::31193008:role/aliyuniotaccessingdatahubrole",
        "roleName": "AliyunIOTAccessingDataHubRole",
        "roleId": "302701665740923801"
    },
    "projectName": "iot_datahub_stream",
    "topicName": "device_message"
}

ONS configure参数参考:

{
    "topicName":"industry_ons_topic_demo_2",
    "regionId":"cn-qingdao-publictest"
}

正常返回示例

{
    "message": "success",
    "code": "200"
}

修改设备数据云产品流转规则

定义描述

path 版本 描述
/industry/ruleAction/update 1.0.2 修改设备数据云产品转储规则

请求参数

名称
类型
必要
描述
productKey
String
产品Key
deviceName
String
设备名称
ruleType
String
规则类型,
ONS or DATAHUB
configure
String
​云产品配置参数
accessKeyId
String
阿里云账号accessKeyId
accessSecret
String
阿里云账号accessSecret

请求示例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.2"
    },
    "params": {
        "productKey": "您的产品Key",
        "deviceName": "您的设备名称",
        "ruleType": "ONS or DATAHUB",
        "configure": "参考如下:",
        "accessKeyId": "阿里云账号ak",
        "accessSecret": "阿里云账号secret"
    }
}

DataHub configure参数参考:

{
    "schemaVals": [
        {
            "name": "devicename",
            "value": "${items.devicename.value}",
            "type": "STRING"
        },
        {
            "name": "msgtime",
            "value": "${items.msgtime.value}",
            "type": "TIMESTAMP"
        }
    ],
    "role": {
        "roleArn": "acs:ram::31193008:role/aliyuniotaccessingdatahubrole",
        "roleName": "AliyunIOTAccessingDataHubRole",
        "roleId": "302701665740923801"
    },
    "projectName": "iot_datahub_stream",
    "topicName": "device_message"
}

ONS configure参数参考:

{
    "topicName":"industry_ons_topic_demo_2",
    "regionId":"cn-qingdao-publictest"
}

正常返回示例

{
    "message": "success",
    "code": "200"
}

查询设备数据云产品流转规则

定义描述

path 版本 描述
/industry/ruleAction/query 1.0.2 查询设备数据云产品转储规则

请求参数

名称
类型
必要
描述
productKey
String
产品Key
deviceName
String
设备名称
ruleType
String
规则类型,
ONS or DATAHUB

请求示例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.2"
    },
    "params": {
        "productKey": "您的产品Key",
        "deviceName": "您的设备名称",
        "ruleType": "ONS or DATAHUB"
    }
}

正常返回示例

{
    "code": 200,
    "data": {
        "ruleActionStarted": false,
        "configure": "{\"uid\":\"1371643086916874\",\"endPoint\":\"http://onsaddr-internal.aliyun.com:8080/rocketmq/nsaddr4client-internal\",\"regionName\":\"cn-shanghai\",\"topic\":\"industry-ons-demo-topic\"}",
        "productKey": "NKLZw6DaF1T",
        "deviceName": "industry_device2"
    },
    "id": "ea45a2a9-a494-4c5a-919b-aca81e0239eb"
}

启动 or 停止设备数据流转规则

定义描述

path 版本 描述
/industry/ruleAction/control 1.0.2 启动 or 停止设备数据流转规则

请求参数

名称
类型
必要
描述
productKey
String
产品Key
deviceName
String
设备名称
ruleType
String
规则类型,
ONS or DATAHUB
isRuleActionStarted
Boolean
​true or false
accessKeyId
String
阿里云账号accessKeyId
accessSecret
String
阿里云账号accessSecret

请求示例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.2"
    },
    "params": {
        "productKey": "您的产品Key",
        "deviceName": "您的设备名称",
        "ruleType": "ONS or DATAHUB",
        "isRuleActionStarted": true or false,
        "accessKeyId": "阿里云账号ak",
        "accessSecret": "阿里云账号secret"
    }
}

正常返回示例

{
    "message": "success",
    "code": "200"
}

删除设备数据流转规则

定义描述

path 版本 描述
/industry/ruleAction/delete 1.0.2 删除设备数据流转规则

请求参数

名称
类型
必要
描述
productKey
String
产品Key
deviceName
String
设备名称
ruleType
String
规则类型,
ONS or DATAHUB
accessKeyId
String
阿里云账号accessKeyId
accessSecret
String
阿里云账号accessSecret

请求示例

{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "1.0.2"
    },
    "params": {
        "productKey": "您的产品Key",
        "deviceName": "您的设备名称",
        "ruleType": "ONS or DATAHUB",
        "accessKeyId": "阿里云账号ak",
        "accessSecret": "阿里云账号secret"
    }
}

正常返回示例

{
    "message": "success",
    "code": "200"
}

results matching ""

    No results matching ""