物联网服务产品云端API文档

物联服务云端API列表

项目管理相关接口

接口 描述
项目列表 查询所有项目列表
创建项目 创建项目
项目详情 查询指定项目详情
修改项目 修改指定项目

产品管理相关接口

接口 描述
产品列表 查询项目下所有产品列表
产品详情 查询指定产品详情
产品功能定义详情 查询指定产品物模型(功能定义列表)
创建产品 创建产品
修改产品 修改产品
删除产品 删除产品
产品发布 产品发布
创建产品标签 创建产品标签
修改产品标签 修改产品标签
删除产品标签 删除产品标签
创建产品功能 创建产品功能
修改产品功能 修改产品功能
删除产品功能 删除产品功能

设备管理相关接口

接口 描述
创建设备 添加设备
指定产品设备列表 查询指定产品下所有设备列表
设备详情 查询指定设备详情
修改设备 修改指定设备
删除设备 删除指定设备
查询指定设备状态 查询指定设备的运行状态(在线/离线和激活/未激活)
指定产品下所有设备状态 批量查询同一产品下指定设备的运行状态
子设备所属网关 根据子设备信息查询对应的网关设备信息
指定设备标签列表 查询指定设备的标签列表
创建设备标签 为指定设备设置标签
删除设备标签 删除设备下的指定标签
网关下子设备列表 查询指定设备的拓扑关系(网关设备下子设备列表)
网关绑定子设备 添加子设备到网关
网关解绑子设备 从网关中移除子设备
自定义主题发布 自定义主题发布

设备影子相关接口

接口 描述
查询设备影子 查询指定设备的影子信息
更新设备影子 更新指定设备的影子信息

功能详细说明

公共请求参数

请求结构

1.通信协议

浪潮云API的所有接口均通过HTTPS进行通信,提供高安全性的通信通道。

2.请求规则

https:// + 请求域名 + ? +最终请求参数串

3.服务地址

目前支持的域名列表为:

地域 域名
华北三 iot.cn-north-3.inspurcloudapi.com
4.请求方法

GET,PUT,POST,DELETE,PATCH均可。

5.字符编码

浪潮云API的请求及返回结果均使用UTF-8字符集进行编码。

公共参数

1.公共请求头
名称 参数类型 是否必须 说明
Authorization String 用户token,用于鉴权,格式为“Bearer + 空格 + 通过GetToken接口获取的token”
2.公共请求参数
名称 参数类型 是否必须 说明
Timestamp String 当前 UNIX 时间戳,可记录发起 API 请求的时间。
Nonce String 随机正整数,与 Timestamp 联合起来, 用于防止重放攻击。
Version String API版本号,使用YYYY-MM-DD日期格式。取值: 2019-01-31。
Format String 返回参数的语言类型。取值范围:json,xml。默认值:xml。
3.通用请求返回值

正常返回

返回值 说明
200 请求成功。
204 任务提交成功。

异常返回

返回值 说明
300 multiple choices 被请求的资源存在多个可供选择的响应。
400 Bad Request 服务器未能处理请求。
401 Unauthorized 被请求的页面需要用户名和密码。
403 Forbidden 对被请求页面的访问被禁止。
404 Not Found 服务器无法找到被请求的页面。
405 Method Not Allowed 请求中指定的方法不被允许。
406 Not Acceptable 服务器生成的响应无法被客户端所接受。
407 Proxy Authentication Required 用户必须首先使用代理服务器进行验证,这样请求才会被处理。
408 Request Timeout 请求超出了服务器的等待时间。
409 Conflict 由于冲突,请求无法被完成。
500 Internal Server Error 请求未完成。服务异常。
501 Not Implemented 请求未完成。服务器不支持所请求的功能。
502 Bad Gateway 请求未完成。服务器从上游服务器收到一个无效的响应。
503 Service Unavailable 请求未完成。系统暂时异常。
504 Gateway Timeout 网关超时。

提交任务类请求结果

响应

名称 参数类型 说明
requestId String 请求ID。
message String 任务异常错误信息描述。
code String 任务异常错误信息编码。
data String 请求结果。

响应样例

正常响应:


   <Response>

   <RequestId>aca3bbf4-a0f0-4d69-83cc-b90d5c89a816</RequestId>

   <Code>200</Code>

   <Data>null</Data>

   <Message>null</Message>

   </Response>

异常响应:

   <Response>

   <RequestId>aca3bbf4-b0f0-4d69-83cc-b90d5c89a816</RequestId>

   <Code>701.001001</Code>

   <Data>null</Data>

   <Message>Version不能为空</Message>

   </Response>

认证Token获取

GetToken

获取用于鉴权的Token。

  • URI

GET getToken

  • URI请求参数
名称 类型 描述
UserName String 用户名
Password String 密码
公共请求参数 - 请参见公共参数
  • Body请求参数
  • 返回参数
名称 类型 描述
code String 状态码
data String Token
requestId String 请求Id
  • 示例

请求示例

https://iot.cn-north-3.inspurcloudapi.com/getToken?UserName=xxxx&Password=xxxx&Timestamp=1553735809&Nonce=121&Version=2019-01-31&Format=json

返回示例

{ 
    "code":200,  
    "data":"eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJsY2hRX2ZrNFdHN0hCZFpmdkdRLUxxWTUwTWxVQVUwb1ZYUU1KcVF0UjNzIn0.eyJqdGkiOiJhNzNhMDA3MC04MDllLTRmZmEtYjY0ZC1jN2Q3NDYwYWJlMjAiLCJleHAiOjE1NTM2ODM0MzMsIm5iZiI6MCwiaWF0IjoxNTUzNjc4MDMzLCJpc3MiOiJodHRwczovL2lvcGRldi4xMC4xMTAuMjUuMTIzLnhpcC5pby9hdXRoL3JlYWxtcy9waWNwIiwiYXVkIjpbImluc2lnaHQiLCJyZWFsbS1tYW5hZ2VtZW50IiwiaW90LWh1YiIsImNsaWVudC1nYW9zcyIsImRiLXNlcnZpY2UiLCJhY2NvdW50IiwicmRzLW15c3FsLWFwaSJdLCJzdWIiOiJmNjc5ZWIyMy1mNzRkLTQ3N2EtYTMxZi1hNjU2ZDcxNjA0ZWQiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJpYWFzLXNlcnZlciIsImF1dGhfdGltZSI6MCwic2Vzc2lvbl9zdGF0ZSI6IjUyZTNkOTA5LWVkYzQtNGQ4ZC04NmUyLTU3ZmY2Y2M3YjE4OCIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiKiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsiQUNDT1VOVF9BRE1JTiIsIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJBQ0NPVU5UX1VTRVIiXX0sInJlc291cmNlX2FjY2VzcyI6eyJpbnNpZ2h0Ijp7InJvbGVzIjpbImFkbWluIl19LCJyZWFsbS1tYW5hZ2VtZW50Ijp7InJvbGVzIjpbInZpZXctdXNlcnMiLCJxdWVyeS1ncm91cHMiLCJxdWVyeS11c2VycyJdfSwiaW90LWh1YiI6eyJyb2xlcyI6WyJhZG1pbiJdfSwiY2xpZW50LWdhb3NzIjp7InJvbGVzIjpbImlhYXNfbXEiLCJhZG1pbiIsInVzZXIiXX0sImRiLXNlcnZpY2UiOnsicm9sZXMiOlsiYWRtaW4iXX0sImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfSwicmRzLW15c3FsLWFwaSI6eyJyb2xlcyI6WyJ1c2VyIl19fSwic2NvcGUiOiIiLCJwcm9qZWN0IjoiZ2Fvc3MiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJnYW9zcyIsImVtYWlsIjoiZ2Fvc3NAaW5zcHVyLmNvbSJ9.G661yoYkbfeeJ_KcyGr1D3Fe55d-5B9PcuIzCjFJMNyFTE7k79GD8K3jI7qkTOjCpowE7F73Q3b4iQtjixjNtWe6Oh03QyYg56lvPn3j33wvLzk5XOzJMSEuNJiH8TWYr2K3DbLUqfDkUvB8_E1X4p94nVtinmI4yvdbqmuiYBGEOSQlz0vuEL1k7-GepY-Ufbh_I6UAH9ePBhQxorCEn3OW-lyHQFcZeMK-531EZkHbw8GzmeA2cbf0e7gI4qZe0WHwYGh0-OWeYh3znZIDGFK928PUYB69bZlQuXHSs0Jvt8GYOecl8r_uzPJiLp99Q0b1W9uHtyxrPF8_0Jb8Jg",  
    "requestId":"83d8f0b7-f2a7-4f84-bf6c-6464e2d561f0"  
}

项目管理

项目列表

查询租户下所有项目列表。

  • URI

GET

  • URI请求参数
名称 类型 是否必须 描述
Action QueryProjectList String 操作
QueryBy owner或者 usergroup String usergroup或者owner
公共请求参数 - 请参见公共参数
  • Body请求参数
  • 返回参数
名称 类型 描述
data Array 详细数据。
requestId String 请求Id
  • 示例**

请求示例

url:

https://iot.cn-north-3.inspurcloudapi.com?Timestamp=1553735809&Nonce=16&Version=2019-01-31&Format=json&Action=QueryProjectList&QueryBy=usergroup

返回示例

{  
    "data":[  
        {  
            "emqInnerAddress":"10.110.25.114:30576",  
            "code":"iotol9592xu",  
            "emqInnerHost":"iotol9592xu-iot-emq-service-in",  
            "floatingIp":"10.110.25.114",  
            "emqOutterAddress":"10.110.25.114:30576",  
            "description":"我是描述2",  
            "updateTime":"2019-03-27T17:25:34Z",  
            "hubSpec":"small",  
            "clusterId":null,  
            "ownerId":"f679eb23-f74d-477a-a31f-a656d71604ed",  
            "eip":"10.110.25.114",  
            "hubSpecCn":null,  
            "storageClass":null,  
            "environmentId":null,  
            "createTime":"2019-03-07T09:26:45Z",  
            "hubCode":"iothub1",  
            "namespace":"iot",  
            "name":"名称2",  
            "dmOutterAddress":"10.110.25.114:31680",  
            "id":"8a8186c2694bd1db016955c2876103fb",  
            "userGroup":"group-xxxx",  
            "externalIp":"10.110.25.114",  
            "username":"xxxx",  
            "emqOutterControlAddress":"10.110.25.114:31177"  
        }  
    ],  
    "requestId":"05eef349-0e28-4c1f-a92b-8271466950cb"  
}

项目详情

查询指定项目的详情。

  • URI

GET

  • URI请求参数
名称 类型 是否必须 描述
Action QueryProject String 操作
ProjectId String 项目Id
公共请求参数 - 请参见公共参数
  • Body请求参数
  • 返回参数
名称 类型 描述
data Array 详细数据。
requestId String 请求Id
  • 示例

请求示例

URI:

https://iot.cn-north-3.inspurcloudapi.com?Timestamp=1553735809&Nonce=84&Version=2019-01-31&Format=json&Action=QueryProject&ProjectId=8a8186c2694bd1db016955c2876103fb

返回示例

{  
    "data":[  
        {  
            "emqInnerAddress":"10.110.25.114:30576",  
            "code":"iotol9592xu",  
            "emqInnerHost":"iotol9592xu-iot-emq-service-in",  
            "floatingIp":"10.110.25.114",  
            "emqOutterAddress":"10.110.25.114:30576",  
            "description":"我是描述2",  
            "updateTime":"2019-03-27T17:25:34Z",  
            "hubSpec":"small",  
            "clusterId":null,  
            "ownerId":"f679eb23-f74d-477a-a31f-a656d71604ed",  
            "eip":"10.110.25.114",  
            "hubSpecCn":null,  
            "storageClass":null,  
            "environmentId":null,  
            "createTime":"2019-03-07T09:26:45Z",  
            "hubCode":"iothub1",  
            "namespace":"iot",  
            "name":"名称2",  
            "dmOutterAddress":"10.110.25.114:31680",  
            "id":"8a8186c2694bd1db016955c2876103fb",  
            "userGroup":"group-xxxx",  
            "externalIp":"10.110.25.114",  
            "username":"xxxx",  
            "emqOutterControlAddress":"10.110.25.114:31177"  
        }  
    ],  
    "requestId":"d4dd0a0a-e441-4a08-a766-bf0451f2c0b1"  
}

创建项目

创建项目

  • URI

POST

  • URI请求参数
名称 类型 是否必须 描述
Action CreateProject String 操作
公共请求参数 - 请参见公共参数
  • Body请求参数
名称 类型 是否必须 描述
Name String 名称
Description String 描述
  • 返回参数

名称 类型 描述
id UUID 项目的uuid
code String 自动生成的8位编码
namespace String 集群命名空间
ownerId String 用户id
username String 用户名称
name String 项目名称
userGroup String 用户所属组
emqInnerHost String emq内部连接ip
dmOutterAddress String dm外部连接地址
emqInnerAddress String emq内部连接地址
emqOutterAddress String emq外部连接地址
createdTime String 创建时间
updatedTime String 更新时间
description String 描述
floatingIp String 集群浮动ip
externalIp String 集群外部ip
hubCode String 真实hub编码
clusterId String 集群id
eip String 集群eip

示例

请求示例

URI:

https://iot.cn-north-3.inspurcloudapi.com?Timestamp=1553735809&Nonce=85&Version=2019-01-31&Format=json&Action=CreateProject&Name=testapi&HubSpec=small

Body:

    Name:tsetapi
    HubSpec:small

返回示例

{  
        "emqInnerAddress":"10.110.25.114:30136",  
        "code":"iotreeqp62m",  
        "emqInnerHost":"iotreeqp62m-iot-emq-service-in",  
        "description":null,  
        "clusterId":"9439c591-b8c9-486d-8793-8d8f8eb9f292",  
        "ownerId":"f679eb23-f74d-477a-a31f-a656d71604ed",  
        "eip":"10.110.25.114",  
        "hubSpecCn":"标准规格",  
        "storageClass":null,  
        "environmentId":null,  
        "requestId":"a3ec1f17-4fe4-435d-8c3c-c363f37e0b4f",  
        "dmOutterAddress":"10.110.25.114:31680",  
        "id":"8a81f3e269c2580c0169c33f05e20002",  
        "userGroup":"group-xxxx",  
        "emqOutterControlAddress":"10.110.25.114:31964",  
        "floatingIp":"10.110.25.114",  
        "emqOutterAddress":"10.110.25.114:30136",  
        "updateTime":"2019-03-28T07:41:21Z",  
        "hubSpec":"small",  
        "createTime":"2019-03-28T07:41:21Z",  
        "hubCode":"iothub1",  
        "namespace":"iot",  
        "name":"testapi",  
        "externalIp":"10.110.25.114",  
        "username":"xxxx"  
  }

修改项目

更新项目

  • URI

PUT

  • URI请求参数
名称 类型 是否必须 描述
Action UpdateProject String 操作
ProjectId String 项目Id
公共请求参数 - 请参见公共参数
  • Body请求参数
名称 类型 是否必须 描述
Name String 名称
Description String 描述
  • 返回参数
名称 类型 描述
id UUID 项目的uuid
code String 自动生成的8位编码
namespace String 集群命名空间
ownerId String 用户id
username String 用户名称
name String 项目名称
userGroup String 用户所属组
emqInnerHost String emq内部连接ip
dmOutterAddress String dm外部连接地址
emqInnerAddress String emq内部连接地址
emqOutterAddress String emq外部连接地址
createdTime String 创建时间
updatedTime String 更新时间
description String 描述
floatingIp String 集群浮动ip
externalIp String 集群外部ip
hubCode String 真实hub编码
clusterId String 集群id
eip String 集群eip

示例

请求示例

URI:

https://iot.cn-north-3.inspurcloudapi.com?Timestamp=1553735809&Nonce=90&Version=2019-01-31&Format=json&Action=UpdateProject&ProjectId=8a8186c2694bd1db016955c2876103fb

Body:

Name:test
Description:test

返回示例

   {  
       "emqInnerAddress":"10.110.25.114:30136",  
       "code":"iotreeqp62m",  
       "emqInnerHost":"iotreeqp62m-iot-emq-service-in",  
       "description":null,  
       "clusterId":"9439c591-b8c9-486d-8793-8d8f8eb9f292",  
       "ownerId":"f679eb23-f74d-477a-a31f-a656d71604ed",  
       "eip":"10.110.25.114",  
       "hubSpecCn":"标准规格",  
       "storageClass":null,  
       "environmentId":null,  
       "requestId":"a3ec1f17-4fe4-435d-8c3c-c363f37e0b4f",  
       "dmOutterAddress":"10.110.25.114:31680",  
       "id":"8a81f3e269c2580c0169c33f05e20002",  
       "userGroup":"group-xxxx",  
       "emqOutterControlAddress":"10.110.25.114:31964",  
       "floatingIp":"10.110.25.114",  
       "emqOutterAddress":"10.110.25.114:30136",  
       "updateTime":"2019-03-28T07:41:21Z",  
       "hubSpec":"small",  
       "createTime":"2019-03-28T07:41:21Z",  
       "hubCode":"iothub1",  
       "namespace":"iot",  
       "name":"testapi",  
       "externalIp":"10.110.25.114",  
       "username":"xxxx"  
   }

产品管理

产品列表

查询指定项目下所有产品列表。

  • URI

GET

  • URI请求参数
名称 类型 是否必须 描述
Action QueryProductList String 操作
公共请求参数 - 请参见公共参数
  • Body请求参数
  • 返回参数

名称 类型 描述
id String 产品的ID
code String 产品编码
name String 产品名称
versionType String 产品版本(暂时只有高级版)
type String 产品类型(直连设备、网关、子设备)
encryption String 证书类型(一机一密)
productTemplateId String 模板ID
projectId String 项目ID
certId String 证书ID
certCode String 证书编码
dataFormat String 数据格式(暂时只有透传)
publishStatus String 发布状态
dynamicRegister String 是否动态注册
ownerId String 用户ID
groupCode String 用户组
description String 描述
productTemplateName String 产品模板名称
createdTime String 创建时间
updatedTime String 更新时间
protocol String 协议
deviceCount String 设备数
oneDeviceOnePrincipal String 是否一机一密
oneProductOnePrincipal String 是否一型一密
projectName String 项目名称
svrsubCertId String 服务端订阅证书Id
secertKey String 产品秘钥
  • 示例

请求示例

URI:

https://iot.cn-north-3.inspurcloudapi.com?Timestamp=1553735809&Nonce=90&Version=2019-01-31&Format=json&Action=QueryProductList

返回示例

[

    {

        "id": "8a48d4a76882997d016882e311110001",

        "code": "y9kz6pc5",

        "name": "zzzz",

        "versionType": "advanced",

        "type": "device",

        "encryption": "bymodel",

        "templateId": "0",

        "projectId": "8a48d4a76882997d016882e2dd950000",

        "certId": "8a48d4a76882997d016882e3112e0002",

        "certCode": null,

        "dataFormat": "透传/自定义",

        "protocol": null,

        "pubstatus": false,

        "dynamicRegister": false,

        "ownerId": "f679eb23-f74d-477a-a31f-a656d71604ed",

        "groupCode": "group-xxxx",

        "description": null,

        "producttemplateName": null,

        "deviceCount": null,

        "createTime": "2019-01-25T02:42:25Z",

        "updateTime": "2019-01-25T02:42:25Z",

        "projectName": null,

        "oneDeviceOneCert": false,

        "oneProductOneCert": true

    },

    {

        "id": "8a48d4a7688427860168842bfe370000",

        "code": "i3lctc29",

        "name": "zvvvv",

        "versionType": "advanced",

        "type": "gateway",

        "encryption": "bymodel",

        "templateId": "0",

        "projectId": "8a48d4a76882997d016882e2dd950000",

        "certId": "8a48d4a7688427860168842bfe660001",

        "certCode": null,

        "dataFormat": "透传/自定义",

        "protocol": null,

        "pubstatus": false,

        "dynamicRegister": false,

        "ownerId": "f679eb23-f74d-477a-a31f-a656d71604ed",

        "groupCode": "group-xxxx",

        "description": null,

        "producttemplateName": null,

        "deviceCount": null,

        "createTime": "2019-01-25T08:41:42Z",

        "updateTime": "2019-01-25T08:41:42Z",

        "projectName": null,

        "oneDeviceOneCert": false,

        "oneProductOneCert": true

    }

]

产品详情

查询指定产品的详情。

  • URI

GET

  • URI请求参数
名称 类型 是否必须 描述
Action QueryProduct String 操作
Id String 产品Id
公共请求参数 - 请参见公共参数
  • Body请求参数
  • 返回参数
名称 类型 描述
id UUID 产品的uuid
code String 产品编码
name String 产品名称
versionType String 产品版本(暂时只有高级版)
type String 产品类型(直连设备、网关、子设备)
encryption String 证书类型(一机一密)
templateId String 模板ID
projectId String 项目ID
certId String 证书ID
certCode String 证书编码
dataFormat String 数据格式(暂时只有透传)
pubstatus String 发布状态
createTime String 创建时间
updateTime String 更新时间
dynamicRegister String 是否动态注册
ownerId String 用户ID
groupCode String 用户组
description String 描述
producttemplateName String 产品模板名称
protocol String 协议
deviceCount String 设备数
  • 示例

请求示例

URI:

https://iot.cn-north-3.inspurcloudapi.com?Timestamp=1553735809&Nonce=90&Version=2019-01-31&Format=json&Action=QueryProduct&Id=8a48d4a7688427860168842bfe370000

返回示例

{

    "id": "8a48d4a76850e557016850f841030007",

    "code": "loptenfe",

    "name": "产品1",

    "versionType": "advanced",

    "type": "device",

    "encryption": "bymodel",

    "templateId": "10",

    "projectId": "8a48d4a76850747a0168508e1f340001",

    "certId": "8a48d4a76850e557016850f8410f000a",

    "certCode": "cert-loptenfe",

    "dataFormat": "透传/自定义",

    "protocol": null,

    "pubstatus": false,

    "dynamicRegister": false,

    "ownerId": "35e5dfc6-91fc-44b7-9220-dfb793412e67",

    "groupCode": "group-cloud-operator",

    "description": "我是描述1",

    "producttemplateName": null,

    "deviceCount": null,

    "createTime": "2019-01-15T10:04:33Z",

    "updateTime": "2019-01-15T10:04:33Z"

}

产品功能定义详情

获取单个产品功能定义详情。

  • URI

GET

  • URI请求参数
名称 类型 是否必须 描述
Action QueryProductTsl String 操作
Id String 产品Id
公共请求参数 - 请参见公共参数
  • Body请求参数
  • 返回参数
名称 类型 描述
productId String 产品ID
functionalType String 功能类型
name String 功能名称
identifier String 标识符
type String 类型
accessMode String 可读/可写
description String 功能的描述
min String 最小值
max String 最大值
step String 步长
unit String 单位
id String 产品功能ID
unitName String 单位名称
specs String 规格
tempSpecs String 临时规格
createdTime String 创建时间
updatedTime String 更新时间
  • 示例

请求示例

URI:

https://iot.cn-north-3.inspurcloudapi.com?Timestamp=1553735809&Nonce=90&Version=2019-01-31&Format=json&Action=QueryProductTsl&Id=8a48d4ad68ef04950168ef19897d0005

返回示例

[

    {

        "id": "8a48d4ad68ef04950168ef1989800006",

        "productId": "8a48d4ad68ef04950168ef19897d0005",

        "functionalType": "属性",

        "name": "氟化物浓度",

        "identifier": "Fluoride",

        "type": "float",

        "max": "10000",

        "min": "0",

        "step": null,

        "unit": "μg/d㎡·d",

        "unitName": "每天每平方分米微克",

        "accessMode": "r",

        "specs": null,

        "tempSpecs": null,

        "description": null,

        "createTime": "2019-02-15T03:00:54Z",

        "updateTime": "2019-02-15T03:00:54Z"

    },

    {

        "id": "8a48d4ad68ef04950168ef1989810007",

        "productId": "8a48d4ad68ef04950168ef19897d0005",

        "functionalType": "属性",

        "name": "地理位置",

        "identifier": "GeoLocation",

        "type": "struct",

        "max": null,

        "min": null,

        "step": null,

        "unit": null,

        "unitName": null,

        "accessMode": "r",

        "specs":
        "[{\\"dataType\\":{\\"specs\\":{\\"max\\":\\"180\\",\\"min\\":\\"-180\\",\\"unit\\":\\"°\\",\\"unitName\\":\\"度\\"},\\"type\\":\\"double\\"},\\"identifier\\":\\"Longitude\\",\\"name\\":\\"经度\\"},{\\"dataType\\":{\\"specs\\":{\\"max\\":\\"90\\",\\"min\\":\\"-90\\",\\"unit\\":\\"°\\",\\"unitName\\":\\"度\\"},\\"type\\":\\"double\\"},\\"identifier\\":\\"Latitude\\",\\"name\\":\\"纬度\\"},{\\"dataType\\":{\\"specs\\":{\\"max\\":\\"9999\\",\\"min\\":\\"0\\",\\"unit\\":\\"m\\",\\"unitName\\":\\"米\\"},\\"type\\":\\"double\\"},\\"identifier\\":\\"Altitude\\",\\"name\\":\\"海拔\\"}]",

        "tempSpecs": null,

        "description": null,

        "createTime": "2019-02-15T03:00:54Z",

        "updateTime": "2019-02-15T03:00:54Z"

    },

    {

        "id": "8a48d4ad68ef04950168ef1989810008",

        "productId": "8a48d4ad68ef04950168ef19897d0005",

        "functionalType": "属性",

        "name": "空气质量指数",

        "identifier": "AQI",

        "type": "int",

        "max": "500",

        "min": "0",

        "step": "1",

        "unit": null,

        "unitName": null,

        "accessMode": "r",

        "specs": null,

        "tempSpecs": null,

        "description": null,

        "createTime": "2019-02-15T03:00:54Z",

        "updateTime": "2019-02-15T03:00:54Z"

    }

]

创建产品

创建产品

  • URI

POST

  • URI请求参数
名称 类型 是否必须 描述
Action CreateProduct String 操作
公共请求参数 - 请参见公共参数
  • Body请求参数
名称 类型 是否必须 描述
Name String 名称
DataFormat String 数据格式
Description String 描述
Encryption String 加密方式
ProjectId String 项目Id
DynamicRegister String 是否动态注册
ProductTemplateId String 模型Id
VersionType String 版本类型
Type String 类型
  • 返回参数
名称 类型 描述
id UUID 产品的uuid
code String 产品编码
name String 产品名称
versionType String 产品版本(暂时只有高级版)
type String 产品类型(直连设备、网关、子设备)
encryption String 证书类型、一机一密)
templateId String 模板ID
projectId String 项目ID
certId String 证书ID
certCode String 证书编码
dataFormat String 数据格式(暂时只有透传)
pubstatus String 发布状态
createTime String 创建时间
updateTime String 更新时间
dynamicRegister String 是否动态注册
ownerId String 用户ID
groupCode String 用户组
description String 描述
producttemplateName String 产品模板名称
protocol String 协议
deviceCount String 设备数
  • 示例

请求示例

URI:

https://iot.cn-north-3.inspurcloudapi.com?Timestamp=1553735809&Nonce=85&Version=2019-01-31&Format=json&Action=CreateProduct

Body:

DataFormat: 透传/自定义,

Description: 我是描述1,

Encryption: bymodel,

ProjectId: 8a48d4a76850747a0168508e1f340001,

DynamicRegister: false,

Name: 产品1,

ProductTemplateId: 00,

Type: device,

VersionType: advanced

返回示例

{

    "id": "8a48d4a76850e557016850f841030007",

    "code": "loptenfe",

    "name": "产品1",

    "versionType": "advanced",

    "type": "device",

    "encryption": "bymodel",

    templateId": "00",

    "projectId": "8a48d4a76850747a0168508e1f340001",

    "certId": "8a48d4a76850e557016850f8410f000a",

    "certCode": "cert-loptenfe",

    "dataFormat": "透传/自定义",

    "protocol": null,

    "pubstatus": false,

    "dynamicRegister": false,

    "ownerId": "35e5dfc6-91fc-44b7-9220-dfb793412e67",

    "groupCode": "group-cloud-operator",

    "description": "我是描述1",

    "producttemplateName": null,

    "deviceCount": null,

    "createTime": "2019-01-15T10:04:33Z",

    "updateTime": "2019-01-15T10:04:33Z"

}

修改产品

更新产品

  • URI

PUT

  • URI请求参数
名称 类型 是否必须 描述
Action UpdateProduct String 操作
Id String 产品Id
公共请求参数 - 请参见公共参数
  • Body请求参数
名称 类型 是否必须 描述
Name String 名称
Description String 描述
  • 返回参数

名称 类型 描述
id String 产品的ID
code String 产品编码
name String 产品名称
versionType String 产品版本(暂时只有高级版)
type String 产品类型(直连设备、网关、子设备)
encryption String 证书类型(一机一密)
productTemplateId String 模板ID
projectId String 项目ID
certId String 证书ID
certCode String 证书编码
dataFormat String 数据格式(暂时只有透传)
publishStatus String 发布状态
dynamicRegister String 是否动态注册
ownerId String 用户ID
groupCode String 用户组
description String 描述
productTemplateName String 产品模板名称
createdTime String 创建时间
updatedTime String 更新时间
protocol String 协议
deviceCount String 设备数
oneDeviceOnePrincipal String 是否一机一密
oneProductOnePrincipal String 是否一型一密
projectName String 项目名称
svrsubCertId String 服务端订阅证书Id
secertKey String 产品秘钥

示例

请求示例

URI:

https://iot.cn-north-3.inspurcloudapi.com?Timestamp=1553735809&Nonce=90&Version=2019-01-31&Format=json&Action=UpdateProduct&Id=8a8186c2694bd1db016955c2876103fb

Body:

"Name": "产品2",

"Description": "我是描述2"

返回示例

{

    "id": "8a48d4a76850e557016850f841030007",

    "code": "loptenfe",

    "name": "产品2",

    "versionType": "advanced",

    "type": "device",

    "encryption": "bymodel",

    "templateId": "10",

    "projectId": "8a48d4a76850747a0168508e1f340001",

    "certId": "8a48d4a76850e557016850f8410f000a",

    "certCode": "cert-loptenfe",

    "dataFormat": "透传/自定义",

    "protocol": null,

    "pubstatus": false,

    "dynamicRegister": false,

    "ownerId": "35e5dfc6-91fc-44b7-9220-dfb793412e67",

    "groupCode": "group-cloud-operator",

    "description": "我是描述2",

    "producttemplateName": null,

    "deviceCount": null,

    "createTime": "2019-01-15T10:04:33Z",

    "updateTime": "2019-01-15T10:04:33Z"

}

删除产品

删除产品

  • URI

DELETE

  • URI请求参数
名称 类型 是否必须 描述
Action DeleteProduct String 操作
Id String 产品Id
公共请求参数 - 请参见公共参数
  • Body请求参数
  • 返回参数
  • 示例

请求示例

URI:

https://iot.cn-north-3.inspurcloudapi.com?Timestamp=1553735809&Nonce=90&Version=2019-01-31&Format=json&Action=DeleteProduct&Id=8a8186c2694bd1db016955c2876103fb

返回示例

产品发布

改变产品发布状态。

  • URI

POST

  • URI请求参数
名称 类型 是否必须 描述
Action PubProduct String 操作
Id String 产品Id
PublishStatus false或者true Boolean 发布状态
公共请求参数 - 请参见公共参数
  • Body请求参数
  • 返回参数
名称 类型 描述
id UUID 产品的uuid
code String 产品编码
name String 产品名称
versionType String 产品版本(暂时只有高级版)
type String 产品类型(直连设备、网关、子设备)
encryption String 证书类型(一机一密)
templateId String 模板ID
projectId String 项目ID
certId String 证书ID
certCode String 证书编码
dataFormat String 数据格式(暂时只有透传)
pubstatus String 发布状态
createTime String 创建时间
updateTime String 更新时间
dynamicRegister String 是否动态注册
ownerId String 用户ID
groupCode String 用户组
description String 描述
producttemplateName String 产品模板名称
protocol String 协议
deviceCount String 设备数
  • 示例

请求示例

URI:

https://iot.cn-north-3.inspurcloudapi.com?Timestamp=1553735809&Nonce=90&Version=2019-01-31&Format=json&Action=PubProduct&Id=8a48d4a7688427860168842bfe370000&PublishStatus=true

返回示例

{

    "id": "8a48d4a76854263001685431d5780004",

    "code": "dbejl8k1",

    "name": "产品1",

    "versionType": "advanced",

    "type": "device",

    "encryption": "bymodel",

    "templateId": "10",

    "projectId": "8a48d4a768542630016854307df80000",

    "certId": "8a48d4a76854263001685431d5840007",

    "certCode": null,

    "dataFormat": "透传/自定义",

    "protocol": null,

    "pubstatus": true,

    "dynamicRegister": false,

    "ownerId": "35e5dfc6-91fc-44b7-9220-dfb793412e67",

    "groupCode": "group-cloud-operator",

    "description": null,

    "producttemplateName": null,

    "deviceCount": null,

    "createTime": "2019-01-16T01:06:18Z",

    "updateTime": "2019-01-16T01:06:18Z"

}

创建产品标签

创建产品标签

  • URI

POST

  • URI请求参数
名称 类型 是否必须 描述
Action CreateProductLabels String 操作
ProductId String 产品Id
公共请求参数 - 请参见公共参数
  • Body请求参数
名称 类型 是否必须 描述
Name String 标签名字
LabelKey String 标签的key
Value String 标签值
  • 返回参数
名称 类型 描述
id UUID 标签的uuid
labelKey String 标签的key
name String 标签的名称
value String 标签的值
createTime String 创建时间
updateTime String 更新时间
ownerId String 用户ID
productId String 产品ID
  • 示例

请求示例

URI:

https://iot.cn-north-3.inspurcloudapi.com?Timestamp=1553735809&Nonce=85&Version=2019-01-31&Format=json&Action=CreateProductLabels&ProductId=8a48d4a76854263001685431d5780004

Body:

ProductId: 8a48d4a76854263001685431d5780004,
Name: 标签1,
LabelKey: label1,
Value": value1

请求示例

{

    "id": "8a48d4a76854263001685435fa45000b",

    "productId": "8a48d4a76854263001685431d5780004",

    "name": "标签1",

    "ownerId": "35e5dfc6-91fc-44b7-9220-dfb793412e67",

    "labelKey": "label1",

    "value": "value1",

    "createTime": "2019-01-16T01:10:50Z",

    "updateTime": "2019-01-16T01:10:50Z"

}

修改产品标签

更新产品标签

  • URI

PUT

  • URI请求参数
名称 类型 是否必须 描述
Action UpdateProductLabels String 操作
ProductId String 产品Id
LabelId String 产品标签Id
公共请求参数 - 请参见公共参数
  • Body请求参数
名称 类型 是否必须 描述
Name String 名称
Value String 标签Value
  • 返回参数
名称 类型 描述
id UUID 标签的uuid
labelKey String 标签的key
name String 标签的名称
value String 标签的值
createTime String 创建时间
updateTime String 更新时间
ownerId String 用户ID
productId String 产品ID
  • 示例

请求示例

URI:

https://iot.cn-north-3.inspurcloudapi.com?Timestamp=1553735809&Nonce=90&Version=2019-01-31&Format=json&Action=UpdateProductLabels&ProductId=8a8186c2694bd1db016955c2876103fb&LabelId=8a48d4a76854263001685435fa45000b

Body:

Name: 标签2,
Value: value2,

返回示例

{

    "id": "8a48d4a76854263001685435fa45000b",

    "productId": "8a48d4a76854263001685431d5780004",

    "name": "标签2",

    "ownerId": "35e5dfc6-91fc-44b7-9220-dfb793412e67",

    "labelKey": "label2",

    "value": "value2",

    "createTime": "2019-01-16T01:10:50Z",

    "updateTime": "2019-01-16T02:30:33Z"

}

删除产品标签

删除产品标签

  • URI

DELETE

  • URI请求参数
名称 类型 是否必须 描述
Action DeleteProductLabels String 操作
ProductId String 产品Id
LabelId String 产品标签Id
公共请求参数 - 请参见公共参数
  • Body请求参数
  • 返回参数
  • 示例

请求示例

URI:

https://iot.cn-north-3.inspurcloudapi.com?Timestamp=1553735809&Nonce=90&Version=2019-01-31&Format=json&Action=DeleteProductLabels&ProductId=8a8186c2694bd1db016955c2876103fb&LabelId=8a8186c2694bd1db016955c2876103fm

返回示例

创建产品功能

创建产品功能

  • URI

POST

  • URI请求参数
名称 类型 是否必须 描述
Action CreateProductProp String 操作
ProductId String 产品Id
公共请求参数 - 请参见公共参数
  • Body请求参数
名称 类型 是否必须 描述
FunctionalType String 功能类型
Name String 功能名称
Identifier String 标识符
Type String 类型
AccessMode String 可读/可写
Description String 功能的描述
Min String 最小值
Max String 最大值
Step String 步长
Unit String 单位
  • 返回参数
名称 类型 描述
id String 产品功能ID
productId String 产品ID
functionalType String 功能类型
name String 功能名称
identifier String 标识符
type String 类型
accessMode String 可读/可写
description String 功能的描述
min String 最小值
max String 最大值
step String 步长
unit String 单位
id String UUID
unitName String 单位名称
specs String 规范
tempSpecs String 临时规范
createTime String 创建时间
updateTime String 更新时间
  • 示例

请求示例

URI:

https://iot.cn-north-3.inspurcloudapi.com?Timestamp=1553735809&Nonce=85&Version=2019-01-31&Format=json&Action=CreateProductProp

Body:

ProductId: 8a48d4a76854263001685431d5780004
FunctionalType: "属性"
Name: "灯泡温度"
Identifier: "temp"
Type: "float"
AccessMode: "rw"
Description: "灯泡温度描述"
Min: "0"
Max: "100"
Step: "0.1"
Unit: "摄氏度 / °C"

返回示例

{

    "id": "8a48d4a768549f4b016854afd4fd0004",

    "ProductId": "8a48d4a76854263001685431d5780004",

    "functionalType": "属性",

    "name": "灯泡温度",

    "identifier": "temp",

    "type": "float",

    "max": "100",

    "min": "0",

    "step": "0.1",

    "unit": "摄氏度 / °C",

    "unitName": null,

    "accessMode": "rw",

    "specs": null,

    "tempSpecs": null,

    "description": "灯泡温度描述",

    "createTime": "2019-01-16T03:23:56Z",

    "updateTime": "2019-01-16T03:23:56Z"

}

修改产品功能

更新产品功能

  • URI

PUT

  • URI请求参数
名称 类型 是否必须 描述
Action UpdateProductProp String 操作
ProductId String 产品Id
PropId String 产品功能Id
公共请求参数 - 请参见公共参数
  • Body请求参数
名称 类型 是否必须 描述
FunctionalType String 功能类型
Name String 功能名称
Identifier String 标识符
Type String 类型
AccessMode String 可读/可写
Description String 功能的描述
Min String 最小值
Max String 最大值
Step String 步长
Unit String 单位
  • 返回参数
名称 类型 描述
id String 产品功能ID
productId String 产品ID
functionalType String 功能类型
name String 功能名称
identifier String 标识符
type String 类型
accessMode String 可读/可写
description String 功能的描述
min String 最小值
max String 最大值
step String 步长
unit String 单位
id String UUID
unitName String 单位名称
specs String 规范
tempSpecs String 临时规范
createTime String 创建时间
updateTime String 更新时间
  • 示例

请求示例

URI:

https://iot.cn-north-3.inspurcloudapi.com?Timestamp=1553735809&Nonce=90&Version=2019-01-31&Format=json&Action=UpdateProductProp&ProductId=8a8186c2694bd1db016955c2876103fb&PropId=8a48d4a76854263001685435fa45000b

Body:

FunctionalType: "属性"
Name: "灯泡温度1"
Identifier: "temp1"
Type: "float"
AccessMode: "rw"
Description: "灯泡温度描述1"
Min: "0"
Max: "100"
Step: "0.1"
Unit: "摄氏度 / °C"

返回示例

{

    "id": "8a48d4a768549f4b016854afd4fd0004",

    "productId": "8a48d4a76854263001685431d5780004",

    "functionalType": "属性",

    "name": "灯泡温度1",

    "identifier": "temp1",

    "type": "float",

    "max": "100",

    "min": "0",

    "step": "0.1",

    "unit": "摄氏度 / °C",

    "unitName": null,

    "accessMode": "rw",

    "specs": null,

    "tempSpecs": null,

    "description": "灯泡温度描述1",

    "createTime": "2019-01-16T03:23:56Z",

    "updateTime": "2019-01-16T03:23:56Z"

}

删除产品功能

删除产品功能

  • URI

DELETE

  • URI请求参数
名称 类型 是否必须 描述
Action DeleteProductProp String 操作
ProductId String 产品Id
PropId String 产品功能Id
公共请求参数 - 请参见公共参数
  • Body请求参数
  • 返回参数
  • 示例

请求示例

URI:

https://iot.cn-north-3.inspurcloudapi.com?Timestamp=1553735809&Nonce=90&Version=2019-01-31&Format=json&Action=DeleteProductProp&ProductId=8a8186c2694bd1db016955c2876103fb&PropId=8a8186c2694bd1db016955c2876103fm

返回示例

设备管理

创建设备

添加设备

  • URI

POST

  • URI请求参数
名称 类型 是否必须 描述
Action RegisterDevice String 操作
公共请求参数 - 请参见公共参数
  • Body请求参数
名称 类型 是否必须 描述
Code String 名称
ProjectId String 项目Id
ProductId String 产品Id
Name String 备注名称
Description String 描述
  • 返回参数
名称 类型 描述
id UUID 设备的uuid
code String 设备名称
principalId String 证书ID
certCode String 证书编码
type String 设备类型
gatewayCode String 网关名称
productId String 产品ID
productCode String 产品编码
projectId String 项目ID
ownerId String 用户ID
userGroup String 用户组
createdTime String 创建时间
updatedTime String 更新时间
lastestOnlineTime String 最后上线时间
description String 设备描述
  • 示例

请求示例

URI:

https://iot.cn-north-3.inspurcloudapi.com?Timestamp=1553735809&Nonce=90&Version=2019-01-31&Format=json&Action=RegisterDevice

Body:

Code:tsetapi
ProjectId: 8a8186c2694bd1db016955c2876103fb
ProductId: 8a8186c2694bd1db016955c2876103fb
Name: test1
Description:small

返回示例

{
    "id": "8a48d4a7685612eb0168595f31b30050",
    "code": "device1",
    "name": null,
    "principalId": "8a48d4a76854263001685431d5840007",
    "version": null,
    "certCode": "principal-dbejl8k1",
    "type": "device",
    "gatewayCode": null,
    "productId": "8a48d4a76854263001685431d5780004",
    "productCode": "dbejl8k1",
    "productName": null,
    "projectId": "8a48d4a768542630016854307df80000",
    "ownerId": "35e5dfc6-91fc-44b7-9220-dfb793412e67",
    "userGroup": "group-cloud-operator",
    "deviceStatus": null,
    "online": null,
    "active": null,
    "lastestOnlineTime": null,
    "createdTime": "2019-01-17T01:13:57Z",
    "updatedTime": "2019-01-17T01:13:57Z",
    "description": "设备描述1",
    "projectCode": null,
    "cert": null
}

指定产品设备列表

查询指定产品下所有设备列表

  • URI

GET

  • URI请求参数
名称 类型 是否必须 描述
Action QueryDevice String 操作
ProjectId String 项目Id
ProductId String 产品Id
Type String 固定值“device“
公共请求参数 - 请参见公共参数
  • Body请求参数
  • 返回参数
名称 类型 描述
id UUID 设备ID
code String 设备code
name String 设备备注名称
certId String 证书ID
version String 版本
certCode String 证书code
type String 设备类型
gatewayCode String 网关code
productId String 产品ID
productCode String 产品code
productName String 产品名称
projectId String 项目ID
ownerId String 用户ID
userGroup String 用户分组
deviceStatus String 设备状态
isBanned String 是否禁用
dataFormat String 数据格式
online String 是否在线
active String 是否激活
lastestOnlineTime String 最后在线时间
createdTime String 创建时间
updatedTime String 更新时间
description String 设备描述
projectCode String 项目code
cert String 设备证书
dmDeviceinstanceProps String 设备分组
  • 示例

请求示例

URI:

https://iot.cn-north-3.inspurcloudapi.com?Timestamp=1553735809&Nonce=90&Version=2019-01-31&Format=json&Action=QueryDevice&ProductId=8a8186c2694bd1db016955c2876103fb&ProjectId=8a8186c2694bd1db016955c2876103fb&Type=device

返回示例

[

    {

        "id": "8a48d4a7688427860168842c40e70009",

        "code": "devicerpwcp6jj",

        "name": null,

        "certId": null,

        "version": null,

        "certCode": null,

        "type": "subdevice",

        "gatewayCode": null,

        "productId": "8a48d4a7688427860168842c1fd80005",

        "productCode": "1yjb2ig6",

        "productName": null,

        "projectId": "8a48d4a76882997d016882e2dd950000",

        "ownerId": "f679eb23-f74d-477a-a31f-a656d71604ed",

        "userGroup": "group-xxxx",

        "deviceStatus": null,

        "dataFormat": null,

        "online": null,

        "active": null,

        "lastestOnlineTime": null,

        "createTime": "2019-01-25T08:41:59Z",

        "updateTime": "2019-01-25T08:41:59Z",

        "description": null,

        "projectCode": "iottw8ukixx",

        "dmDeviceinstanceProps": [],

        "cert": null

    }

]

设备详情

查询指定设备详情

  • URI

GET

  • URI请求参数
名称 类型 是否必须 描述
Action QueryDeviceDetail String 操作
DeviceId String 要查询的DeviceId值
公共请求参数 - 请参见公共参数
  • Body请求参数
  • 返回参数
名称 类型 描述
id UUID 设备ID
code String 设备code
name String 设备备注名称
certId String 证书ID
version String 版本
certCode String 证书code
type String 设备类型
gatewayCode String 网关code
productId String 产品ID
productCode String 产品code
productName String 产品名称
projectId String 项目ID
ownerId String 用户ID
userGroup String 用户分组
deviceStatus String 设备状态
isBanned String 是否禁用
dataFormat String 数据格式
online String 是否在线
active String 是否激活
lastestOnlineTime String 最后在线时间
createdTime String 创建时间
updatedTime String 更新时间
description String 设备描述
projectCode String 项目code
cert String 设备证书
dmDeviceinstanceProps String 设备分组
  • 示例

请求示例

URI:

https://iot.cn-north-3.inspurcloudapi.com?Timestamp=1553735809&Nonce=90&Version=2019-01-31&Format=json&Action=QueryDeviceDetail&DeviceId=8a8186c2694bd1db016955c2876103fb

返回示例

{

    "id": "8a48d4a7685612eb0168595f31b30050",

    "code": "device1",

    "name": null,

    "certId": "8a48d4a76854263001685431d5840007",

    "version": null,

    "certCode": "cert-dbejl8k1",

    "type": "device",

    "gateWayCode": null,

    "productId": "8a48d4a76854263001685431d5780004",

    "productCode": "dbejl8k1",

    "productName": "产品1",

    "projectId": "8a48d4a768542630016854307df80000",

    "ownerId": "35e5dfc6-91fc-44b7-9220-dfb793412e67",

    "userGroup": "group-cloud-operator",

    "deviceStatus": null,

    "online": false,

    "active": false,

    "lastestOnlineTime": null,

    "createTime": "2019-01-17T01:13:57Z",

    "updateTime": "2019-01-17T01:47:54Z",

    "description": "设备描述1",

    "projectCode": "iotyiyxpecj",

    "dmDeviceinstanceProps": [],

    "dmCert": null

}

修改设备

查询指定设备详情

  • URI

PUT

  • URI请求参数
名称 类型 是否必须 描述
Action UpdateDevice String 操作
DeviceId String 要查询的DeviceId值
Description String 描述
公共请求参数 - 请参见公共参数
  • Body请求参数
  • 返回参数
名称 类型 描述
id UUID 设备ID
code String 设备code
name String 设备备注名称
certId String 证书ID
version String 版本
certCode String 证书code
type String 设备类型
gatewayCode String 网关code
productId String 产品ID
productCode String 产品code
productName String 产品名称
projectId String 项目ID
ownerId String 用户ID
userGroup String 用户分组
deviceStatus String 设备状态
isBanned String 是否禁用
dataFormat String 数据格式
online String 是否在线
active String 是否激活
lastestOnlineTime String 最后在线时间
createdTime String 创建时间
updatedTime String 更新时间
description String 设备描述
projectCode String 项目code
cert String 设备证书
dmDeviceinstanceProps String 设备分组
  • 示例

请求示例

URI:

https://iot.cn-north-3.inspurcloudapi.com?Timestamp=1553735809&Nonce=90&Version=2019-01-31&Format=json&Action=UpdateDevice&DeviceId=8a8186c2694bd1db016955c2876103fb&Description=123

返回示例

{

    "id": "8a48d4a7685612eb0168595f31b30050",

    "code": "device1",

    "name": null,

    "certId": "8a48d4a76854263001685431d5840007",

    "version": null,

    "certCode": "cert-dbejl8k1",

    "type": "device",

    "gateWayCode": null,

    "productId": "8a48d4a76854263001685431d5780004",

    "productCode": "dbejl8k1",

    "productName": "产品1",

    "projectId": "8a48d4a768542630016854307df80000",

    "ownerId": "35e5dfc6-91fc-44b7-9220-dfb793412e67",

    "userGroup": "group-cloud-operator",

    "deviceStatus": null,

    "online": false,

    "active": false,

    "lastestOnlineTime": null,

    "createTime": "2019-01-17T01:13:57Z",

    "updateTime": "2019-01-17T01:47:54Z",

    "description": "设备描述1",

    "projectCode": "iotyiyxpecj",

    "dmDeviceinstanceProps": [],

    "dmCert": null

}

删除设备

删除指定设备

  • URI

DELETE

  • URI请求参数
名称 类型 是否必须 描述
Action DeleteDevice String 操作
DeviceId String 设备Id
公共请求参数 - 请参见公共参数
  • Body请求参数
  • 返回参数
  • 示例

请求示例

URI:

https://iot.cn-north-3.inspurcloudapi.com?Timestamp=1553735809&Nonce=90&Version=2019-01-31&Format=json&Action=DeleteDevice&DeviceId=8a8186c2694bd1db016955c2876103fb

返回示例

查询指定设备状态

查询指定设备的运行状态

  • URI

GET

  • URI请求参数
名称 类型 是否必须 描述
Action GetDeviceStatus String 操作
DeviceId String 要查询的DeviceId值
公共请求参数 - 请参见公共参数
  • Body请求参数
  • 返回参数
名称 类型 描述
identifier String 标识符
unit String 单位
name String 名称
time String 时间
value String
  • 示例

请求示例

URI:

https://iot.cn-north-3.inspurcloudapi.com?Timestamp=1553735809&Nonce=90&Version=2019-01-31&Format=json&Action=GetDeviceStatus&DeviceId=8a8186c2694bd1db016955c2876103fb

返回示例

[{
    "identifier": "gzj_gzsd",
    "unit": "Bottle /min",
    "name": "灌装速度",
    "time": null,
    "value": "--"
}, {
    "identifier": "gzj_bjxx",
    "unit": "",
    "name": "报警信息",
    "time": null,
    "value": "--"
}]

子设备所属网关

根据子设备信息查询对应的网关设备信息

  • URI

GET

  • URI请求参数
名称 类型 是否必须 描述
Action GetGatewayBySubDevice String 操作
SubdeviceId String 要查询的SubdeviceId值
公共请求参数 - 请参见公共参数
  • Body请求参数
  • 返回参数
名称 类型 描述
id UUID 设备ID
code String 设备code
name String 设备备注名称
certId String 证书ID
version String 版本
certCode String 证书code
type String 设备类型
gatewayCode String 网关code
productId String 产品ID
productCode String 产品code
productName String 产品名称
projectId String 项目ID
ownerId String 用户ID
userGroup String 用户分组
deviceStatus String 设备状态
isBanned String 是否禁用
dataFormat String 数据格式
online String 是否在线
active String 是否激活
lastestOnlineTime String 最后在线时间
createdTime String 创建时间
updatedTime String 更新时间
description String 设备描述
projectCode String 项目code
cert String 设备证书
dmDeviceinstanceProps String 设备分组
  • 示例

请求示例

URI:

https://iot.cn-north-3.inspurcloudapi.com?Timestamp=1553735809&Nonce=90&Version=2019-01-31&Format=json&Action=GetGatewayBySubDevice&SubdeviceId=8a8186c2694bd1db016955c2876103fb

返回示例

{

    "id": "8a48d4a7688427860168842c503f0015",

    "code": "deviceg8b7eg77",

    "name": null,

    "certId": "8a48d4a7688427860168842bfe660001",

    "version": null,

    "certCode": null,

    "type": "gateway",

    "gateWayCode": null,

    "productId": "8a48d4a7688427860168842bfe370000",

    "productCode": "i3lctc29",

    "productName": null,

    "projectId": "8a48d4a76882997d016882e2dd950000",

    "ownerId": "f679eb23-f74d-477a-a31f-a656d71604ed",

    "userGroup": "group-xxxx",

    "deviceStatus": null,

    "dataFormat": null,

    "online": null,

    "active": null,

    "lastestOnlineTime": null,

    "createTime": "2019-01-25T08:42:03Z",

    "updateTime": "2019-01-25T08:42:03Z",

    "description": null,

    "projectCode": "iottw8ukixx",

    "dmDeviceinstanceProps": [],

    "dmCert": null

}

指定设备标签列表

查询指定设备的标签列表

  • URI

GET

  • URI请求参数
名称 类型 是否必须 描述
Action QueryDeviceLabels String 操作
DeviceId String 要查询的DeviceId值
公共请求参数 - 请参见公共参数
  • Body请求参数
  • 返回参数
名称 类型 描述
id UUID 标签的uuid
labelKey String 标签的key
name String 标签的名称
value String 标签的值
createdTime String 创建时间
updatedTime String 更新时间
ownerId String 用户ID
deviceId String 产品ID
source String 标签来源
  • 示例

请求示例

URI:

https://iot.cn-north-3.inspurcloudapi.com?Timestamp=1553735809&Nonce=90&Version=2019-01-31&Format=json&Action=QueryDeviceLabels&DeviceId=8a8186c2694bd1db016955c2876103fb

返回示例

[

    {

        "id": "8a48d4ad68f01e330168f01f3ab30001",

        "deviceId": "8a48d4ad68f01e330168f01f3a380000",

        "ownerId": "f679eb23-f74d-477a-a31f-a656d71604ed",

        "labelKey": "manufacturer",

        "name": "生产厂家",

        "value": "",

        "source": "product",

        "createTime": "2019-02-15T07:46:45Z",

        "updateTime": "2019-02-15T07:46:45Z"

    },

    {

        "id": "8a48d4ad68f01e330168f01f3b550002",

        "deviceId": "8a48d4ad68f01e330168f01f3a380000",

        "ownerId": "f679eb23-f74d-477a-a31f-a656d71604ed",

        "labelKey": "model",

        "name": "产品型号",

        "value": "",

        "source": "product",

        "createTime": "2019-02-15T07:46:45Z",

        "updateTime": "2019-02-15T07:46:45Z"

    },

    {

        "id": "8a48d4ad68f01e330168f01f3b9d0003",

        "deviceId": "8a48d4ad68f01e330168f01f3a380000",

        "ownerId": "f679eb23-f74d-477a-a31f-a656d71604ed",

        "labelKey": "location",

        "name": "地理位置",

        "value": "",

        "source": "product",

        "createTime": "2019-02-15T07:46:45Z",

        "updateTime": "2019-02-15T07:46:45Z"

    },

    {

        "id": "8a48d4ad69088450016908875db70000",

        "deviceId": "8a48d4ad68f01e330168f01f3a380000",

        "ownerId": "f679eb23-f74d-477a-a31f-a656d71604ed",

        "labelKey": "1",

        "name": "1",

        "value": "1",

        "source": null,

        "createTime": "2019-02-20T01:31:22Z",

        "updateTime": "2019-02-20T01:31:22Z"

    }

]

创建设备标签

为指定设备设置标签

  • URI

POST

  • URI请求参数
名称 类型 是否必须 描述
Action SaveDeviceLabel String 操作
DeviceId String 设备Id
公共请求参数 - 请参见公共参数
  • Body请求参数
名称 类型 是否必须 描述
Name String 标签名
LabelKey String 标签键值
Value String 标签值
  • 返回参数
名称 类型 描述
id UUID 标签的uuid
labelKey String 标签的key
name String 标签的名称
value String 标签的值
createdTime String 创建时间
updatedTime String 更新时间
ownerId String 用户ID
deviceId String 产品ID
source String 标签来源
  • 示例

请求示例

URI:

https://iot.cn-north-3.inspurcloudapi.com?Timestamp=1563735809&Nonce=91&Version=2019-01-31&Format=json&Action=SaveDeviceLabel&DeviceId=8a8101516a067336016a0a498e95003e

Body:

Name:name1
LabelKey:key1
Value:value1

返回示例

{

    "id": "8a48d4a7685981cf0168599960600008",

    "deviceId": "8a48d4ad68f01e330168f01f3a380000",

    "ownerId": "35e5dfc6-91fc-44b7-9220-dfb793412e67",

    "labelKey": "key1",

    "name": "name1",

    "value": "value1",

    "source": null,

    "createTime": "2019-01-17T02:17:30Z",

    "updateTime": "2019-01-17T02:17:30Z"

}

修改设备标签

更新设备下的指定标签

更新项目

  • URI

PUT

  • URI请求参数
名称 类型 是否必须 描述
Action UpdateDeviceLabel String 操作
DeviceId String 设备Id
Id String 标签Id
公共请求参数 - 请参见公共参数
  • Body请求参数
名称 类型 是否必须 描述
Name String 标签名
LabelKey String 标签键值
Value String 标签值
  • 返回参数
名称 类型 描述
id UUID 标签的uuid
labelKey String 标签的key
name String 标签的名称
value String 标签的值
createdTime String 创建时间
updatedTime String 更新时间
ownerId String 用户ID
deviceId String 产品ID
source String 标签来源
  • 示例

请求示例

URI:

https://iot.cn-north-3.inspurcloudapi.com?Timestamp=1563735809&Nonce=91&Version=2019-01-31&Format=json&Action=UpdateDeviceLabel&DeviceId=8a8101516a067336016a0a498e95003e&Id=8a8101516a067336016a0a498eed003f

Body:

Name:name1
LabelKey:key1
Value:value1

返回示例

{

    "id": "8a48d4a7685981cf0168599960600008",

    "deviceId": "8a48d4a7685981cf01685997bfb00004",

    "ownerId": "35e5dfc6-91fc-44b7-9220-dfb793412e67",

    "labelKey": "key2",

    "name": "name2",

    "value": "value2",

    "source": null,

    "createTime": "2019-01-17T02:17:30Z",

    "updateTime": "2019-01-17T02:24:47Z"

}

删除设备标签

删除设备下的指定标签

  • URI

DELETE

  • URI请求参数
名称 类型 是否必须 描述
Action DeleteDeviceLabel String 操作
DeviceId String 设备Id
Id String 标签Id
公共请求参数 - 请参见公共参数
  • Body请求参数
  • 返回参数
  • 示例

请求示例

URI:

https://iot.cn-north-3.inspurcloudapi.com?Timestamp=1553735809&Nonce=90&Version=2019-01-31&Format=json&Action=DeleteDeviceLabel&DeviceId=8a8186c2694bd1db016955c2876103fb&Id=8a8186c2694bd1db016955c2876103fb

返回示例

网关下子设备列表

查询指定设备的拓扑关系

  • URI

GET

  • URI请求参数
名称 类型 是否必须 描述
Action GetThingTopo String 操作
ProjectId String 项目Id
ProductId String 产品Id
Type String 默认值“subdevice“
GatewayCode String 网关Code
公共请求参数 - 请参见公共参数
  • Body请求参数
  • 返回参数
名称 类型 描述
id UUID 设备ID
code String 设备code
name String 设备备注名称
certId String 证书ID
version String 版本
certCode String 证书code
type String 设备类型
gatewayCode String 网关code
productId String 产品ID
productCode String 产品code
productName String 产品名称
projectId String 项目ID
ownerId String 用户ID
userGroup String 用户分组
deviceStatus String 设备状态
isBanned String 是否禁用
dataFormat String 数据格式
online String 是否在线
active String 是否激活
lastestOnlineTime String 最后在线时间
createdTime String 创建时间
updatedTime String 更新时间
description String 设备描述
projectCode String 项目code
cert String 设备证书
dmDeviceinstanceProps String 设备分组
  • 示例

请求示例

URI:

https://iot.cn-north-3.inspurcloudapi.com?Timestamp=1553735809&Nonce=90&Version=2019-01-31&Format=json&Action=GetThingTopo&DeviceId=8a8186c2694bd1db016955c2876103fb&Type=subdevice&GatewayCode=deviceawcpduiu&ProjectId=8a8186c2694bd1db016955c2876103fb&ProductId=8ac819ed6b4fe054016b4fe8dcaa0000

返回示例

[

    {

        "id": "8a48d4a7688427860168842c40e70009",

        "code": "devicerpwcp6jj",

        "name": null,

        "certId": null,

        "version": null,

        "certCode": null,

        "type": "subdevice",

        "gateWayCode": "deviceg8b7eg77",

        "productId": "8a48d4a7688427860168842c1fd80005",

        "productCode": "1yjb2ig6",

        "productName": null,

        "projectId": "8a48d4a76882997d016882e2dd950000",

        "ownerId": "f679eb23-f74d-477a-a31f-a656d71604ed",

        "userGroup": "group-xxxx",

        "deviceStatus": null,

        "dataFormat": null,

        "online": null,

        "active": null,

        "lastestOnlineTime": null,

        "createTime": "2019-01-25T08:41:59Z",

        "updateTime": "2019-01-25T08:41:59Z",

        "description": null,

        "projectCode": "iottw8ukixx",

        "dmDeviceinstanceProps": [],

        "dmCert": null

    },

    {

        "id": "8a48d4a7688427860168842c4209000d",

        "code": "devicelv8kik2w",

        "name": null,

        "certId": null,

        "version": null,

        "certCode": null,

        "type": "subdevice",

        "gateWayCode": "deviceg8b7eg77",

        "productId": "8a48d4a7688427860168842c1fd80005",

        "productCode": "1yjb2ig6",

        "productName": null,

        "projectId": "8a48d4a76882997d016882e2dd950000",

        "ownerId": "f679eb23-f74d-477a-a31f-a656d71604ed",

        "userGroup": "group-xxxx",

        "deviceStatus": null,

        "dataFormat": null,

        "online": null,

        "active": null,

        "lastestOnlineTime": null,

        "createTime": "2019-01-25T08:41:59Z",

        "updateTime": "2019-01-25T08:41:59Z",

        "description": null,

        "projectCode": "iottw8ukixx",

        "dmDeviceinstanceProps": [],

        "dmCert": null

    },

    {

        "id": "8a48d4a7688427860168842c428e0011",

        "code": "devicelmcxs0fe",

        "name": null,

        "certId": null,

        "version": null,

        "certCode": null,

        "type": "subdevice",

        "gateWayCode": "deviceg8b7eg77",

        "productId": "8a48d4a7688427860168842c1fd80005",

        "productCode": "1yjb2ig6",

        "productName": null,

        "projectId": "8a48d4a76882997d016882e2dd950000",

        "ownerId": "f679eb23-f74d-477a-a31f-a656d71604ed",

        "userGroup": "group-xxxx",

        "deviceStatus": null,

        "dataFormat": null,

        "online": null,

        "active": null,

        "lastestOnlineTime": null,

        "createTime": "2019-01-25T08:41:59Z",

        "updateTime": "2019-01-25T08:41:59Z",

        "description": null,

        "projectCode": "iottw8ukixx",

        "dmDeviceinstanceProps": [],

        "dmCert": null

    }

]

网关绑定子设备

添加子设备到网关

  • URI

POST

  • URI请求参数
名称 类型 是否必须 描述
Action NotifyAddThingTopo String 操作
GatewayId String 网关Id
公共请求参数 - 请参见公共参数
  • Body请求参数
名称 类型 是否必须 描述
Ids1 String 子设备Id
Ids2 String 子设备Id
  • 返回参数
名称 类型 描述
id UUID 设备ID
code String 设备code
name String 设备备注名称
certId String 证书ID
version String 版本
certCode String 证书code
type String 设备类型
gatewayCode String 网关code
productId String 产品ID
productCode String 产品code
productName String 产品名称
projectId String 项目ID
ownerId String 用户ID
userGroup String 用户分组
deviceStatus String 设备状态
isBanned String 是否禁用
dataFormat String 数据格式
online String 是否在线
active String 是否激活
lastestOnlineTime String 最后在线时间
createdTime String 创建时间
updatedTime String 更新时间
description String 设备描述
projectCode String 项目code
cert String 设备证书
dmDeviceinstanceProps String 设备分组
  • 示例

请求示例

URI:

https://iot.cn-north-3.inspurcloudapi.com?Timestamp=1563735809&Nonce=91&Version=2019-01-31&Format=json&Action=NotifyAddThingTopo&GatewayId=8a815d896a4943e8016a4b26796c0031

Body:

Ids1: 8a48d4a7688427860168842c40e70009
Ids2: 8a48d4a7688427860168842c4209000d

返回示例

[

    {

        "id": "8a48d4a7688427860168842c40e70009",

        "code": "devicerpwcp6jj",

        "name": null,

        "certId": null,

        "version": null,

        "certCode": null,

        "type": "subdevice",

        "gateWayCode": "deviceg8b7eg77",

        "productId": "8a48d4a7688427860168842c1fd80005",

        "productCode": "1yjb2ig6",

        "productName": null,

        "projectId": "8a48d4a76882997d016882e2dd950000",

        "ownerId": "f679eb23-f74d-477a-a31f-a656d71604ed",

        "userGroup": "group-xxxx",

        "deviceStatus": null,

        "dataFormat": null,

        "online": null,

        "active": null,

        "lastestOnlineTime": null,

        "createTime": "2019-01-25T08:41:59Z",

        "updateTime": "2019-01-25T08:41:59Z",

        "description": null,

        "projectCode": "iottw8ukixx",

        "dmDeviceinstanceProps": [],

        "dmCert": null

    },

    {

        "id": "8a48d4a7688427860168842c4209000d",

        "code": "devicelv8kik2w",

        "name": null,

        "certId": null,

        "version": null,

        "certCode": null,

        "type": "subdevice",

        "gateWayCode": "deviceg8b7eg77",

        "productId": "8a48d4a7688427860168842c1fd80005",

        "productCode": "1yjb2ig6",

        "productName": null,

        "projectId": "8a48d4a76882997d016882e2dd950000",

        "ownerId": "f679eb23-f74d-477a-a31f-a656d71604ed",

        "userGroup": "group-xxxx",

        "deviceStatus": null,

        "dataFormat": null,

        "online": null,

        "active": null,

        "lastestOnlineTime": null,

        "createTime": "2019-01-25T08:41:59Z",

        "updateTime": "2019-01-25T08:41:59Z",

        "description": null,

        "projectCode": "iottw8ukixx",

        "dmDeviceinstanceProps": [],

        "dmCert": null

    },

    {

        "id": "8a48d4a7688427860168842c428e0011",

        "code": "devicelmcxs0fe",

        "name": null,

        "certId": null,

        "version": null,

        "certCode": null,

        "type": "subdevice",

        "gateWayCode": "deviceg8b7eg77",

        "productIdId": "8a48d4a7688427860168842c1fd80005",

        "productIdCode": "1yjb2ig6",

        "productIdName": null,

        "projectId": "8a48d4a76882997d016882e2dd950000",

        "ownerId": "f679eb23-f74d-477a-a31f-a656d71604ed",

        "userGroup": "group-xxxx",

        "deviceStatus": null,

        "dataFormat": null,

        "online": null,

        "active": null,

        "lastestOnlineTime": null,

        "createTime": "2019-01-25T08:41:59Z",

        "updateTime": "2019-01-25T08:41:59Z",

        "description": null,

        "projectCode": "iottw8ukixx",

        "dmDeviceinstanceProps": [],

        "dmCert": null

    }

]

网关解绑子设备

从网关中移除子设备

  • URI

POST

  • URI请求参数
名称 类型 是否必须 描述
Action RemoveThingTopo String 操作
GatewayId String 网关Code
公共请求参数 - 请参见公共参数
  • Body请求参数
名称 类型 是否必须 描述
Ids1 String 子设备Id
Ids2 String 子设备Id
  • 返回参数
  • 示例

请求示例

URI:

https://iot.cn-north-3.inspurcloudapi.com?Timestamp=1563735809&Nonce=91&Version=2019-01-31&Format=json&Action=RemoveThingTopo&GatewayId=8a8186c2694bd1db016955c2876103fb&Ids1=8a812a3a6a0043ad016a01656931001a

返回示例

自定义主题发布

自定义主题发布

  • URI

POST

  • URI请求参数
名称 类型 是否必须 描述
Action PubTopic String 操作
DeviceId String 设备Id
公共请求参数 - 请参见公共参数
  • Body请求参数
名称 类型 是否必须 描述
Topic String 名称
Payload String 项目Id
  • 返回参数
  • 示例

请求示例

URI:

https://iot.cn-north-3.inspurcloudapi.com?Timestamp=1563735809&Nonce=91&Version=2019-01-31&Format=json&Action=PubTopic&DeviceId=8a8101516a067336016a0a498e95003e

Body:

Topic: "device/topic/1"
Payload: 我是报文

返回示例

Pub Topic Succes

设备影子

查询设备影子

查询指定设备的影子信息查询指定设备的运行状态

  • URI

GET

  • URI请求参数
名称 类型 是否必须 描述
Action GetDeviceShadow String 操作
DeviceId String 要查询的DeviceId值
公共请求参数 - 请参见公共参数
  • Body请求参数
  • 返回参数
  • 示例

请求示例

URI:

https://iot.cn-north-3.inspurcloudapi.com?Timestamp=1553735809&Nonce=90&Version=2019-01-31&Format=json&Action=GetDeviceShadow&DeviceId=8a8186c2694bd1db016955c2876103fb

返回示例

更新设备影子

修改指定设备的影子信息

  • URI

PUT

  • URI请求参数
名称 类型 是否必须 描述
Action UpdateDeviceShadow String 操作
DeviceId String 设备Id
公共请求参数 - 请参见公共参数
  • Body请求参数
名称 类型 是否必须 描述
Message String 消息内容
  • 返回参数

  • 示例

请求示例

URI:

https://iot.cn-north-3.inspurcloudapi.com?Timestamp=1553735809&Nonce=90&Version=2019-01-31&Format=json&Action=UpdateDeviceShadow&DeviceId=8a8186c2694bd1db016955c2876103fb

Body:

Message: {

   "state": {

      "reported": {

            "color": "red",

            "length": "66cm"

        }

     }

}

返回示例