物联网服务产品云端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 网关超时。

认证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=1953735809&Nonce=16&Version=2019-01-31&Format=json&Action=QueryProjectList&QueryBy=usergroup

返回示例

{
    "data": [
        {
            "emqInnerAddress": "172.31.0.11:31187",
            "hubId": "iothub5",
            "updatedTime": "2019-07-30T12:00:33Z",
            "code": "iotzo86wpdc",
            "emqInnerHost": "iotzo86wpdc-iot-emq-service-in",
            "floatingIp": "100.111.64.77",
            "flag": null,
            "emqOutterAddress": "117.73.3.68:31187",
            "description": "12231121",
            "clusterId": "f895784e-7a8c-46d3-9dd1-7a4b11e8696d",
            "ownerId": "767bb18c-6966-453b-812a-2b9585582d44",
            "eip": "117.73.3.68",
            "accountId": "767bb18c-6966-453b-812a-2b9585582d44",
            "storageClass": null,
            "namespace": "default",
            "name": "project1",
            "createdTime": "2019-01-24T19:55:01Z",
            "dmOutterAddress": "100.111.64.77:30378",
            "id": "2c9f3329687f19ec01687fb6a19d0003",
            "externalIp": "172.31.0.11",
            "username": "inspurtest13",
            "emqOutterControlAddress": null
        }
    ],
    "requestId": "b23adaf2-bb95-414f-bd62-b2b68317aee3"
}

项目详情

查询指定项目的详情。

  • URI

GET

  • URI 请求参数
名称 类型 是否必须 描述
Action QueryProject String 操作
ProjectId String 项目 Id
公共请求参数 - 请参见公共参数
  • Body 请求参数
  • 返回参数
名称 类型 描述
emqInnerAddress String emq 内部连接地址
hubId String hub 的 id
updatedTime String 更新时间
code String 自动生成的 8 位编码
emqInnerHost String emq 内部连接 ip
floatingIp String 集群浮动 ip
flag String 标志位
emqOutterAddress String emq 外部连接地址
description String 描述
clusterId String 集群 id
ownerId String 用户 id
eip String 集群 eip
accountId String 用户所属组
storageClass String k8s 动态存储
requestId String 请求 Id
namespace String 集群命名空间
name String 项目名称
createdTime String 创建时间
dmOutterAddress String dm 外部连接地址
id UUID 项目的 uuid
externalIp String 集群外部 ip
username String 用户名称
emqOutterControlAddress String mqtt 控制台地址
  • 示例

请求示例

URI:

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

返回示例

{
    "emqInnerAddress": "172.31.0.11:31187",
    "hubId": "iothub5",
    "updatedTime": "2019-07-30T12:00:33Z",
    "code": "iotzo86wpdc",
    "emqInnerHost": "iotzo86wpdc-iot-emq-service-in",
    "floatingIp": "100.111.64.77",
    "flag": null,
    "emqOutterAddress": "117.73.3.68:31187",
    "description": "12231121",
    "clusterId": null,
    "ownerId": "767bb18c-6966-453b-812a-2b9585582d44",
    "eip": "117.73.3.68",
    "accountId": "767bb18c-6966-453b-812a-2b9585582d44",
    "storageClass": null,
    "requestId": "1404f2b5-ed8e-4962-a5c2-15603eb1a942",
    "namespace": "default",
    "name": "project1",
    "createdTime": "2019-01-24T19:55:01Z",
    "dmOutterAddress": "100.111.64.77:30378",
    "id": "2c9f3329687f19ec01687fb6a19d0003",
    "externalIp": "172.31.0.11",
    "username": "inspurtest13",
    "emqOutterControlAddress": null
}

创建项目

创建项目

  • URI

POST

  • URI 请求参数
名称 类型 是否必须 描述
Action CreateProject String 操作
公共请求参数 - 请参见公共参数
  • Body 请求参数
名称 类型 是否必须 描述
Name String 名称
Description String 描述
  • 返回参数
名称 类型 描述
emqInnerAddress String emq 内部连接地址
hubId String hub 的 id
updatedTime String 更新时间
code String 自动生成的 8 位编码
emqInnerHost String emq 内部连接 ip
floatingIp String 集群浮动 ip
flag String 标志位
emqOutterAddress String emq 外部连接地址
description String 描述
clusterId String 集群 id
ownerId String 用户 id
eip String 集群 eip
accountId String 用户所属组
storageClass String k8s 动态存储
requestId String 请求 Id
namespace String 集群命名空间
name String 项目名称
createdTime String 创建时间
dmOutterAddress String dm 外部连接地址
id UUID 项目的 uuid
externalIp String 集群外部 ip
username String 用户名称
emqOutterControlAddress String mqtt 控制台地址

示例

请求示例

URI:

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

Body:

    Name:tsetapi
    HubSpec:small

返回示例

{
    "emqInnerAddress": "172.31.0.11:31187",
    "hubId": "iothub5",
    "updatedTime": "2019-07-30T12:00:33Z",
    "code": "iotzo86wpdc",
    "emqInnerHost": "iotzo86wpdc-iot-emq-service-in",
    "floatingIp": "100.111.64.77",
    "flag": null,
    "emqOutterAddress": "117.73.3.68:31187",
    "description": "12231121",
    "clusterId": null,
    "ownerId": "767bb18c-6966-453b-812a-2b9585582d44",
    "eip": "117.73.3.68",
    "accountId": "767bb18c-6966-453b-812a-2b9585582d44",
    "storageClass": null,
    "requestId": "1404f2b5-ed8e-4962-a5c2-15603eb1a942",
    "namespace": "default",
    "name": "project1",
    "createdTime": "2019-01-24T19:55:01Z",
    "dmOutterAddress": "100.111.64.77:30378",
    "id": "2c9f3329687f19ec01687fb6a19d0003",
    "externalIp": "172.31.0.11",
    "username": "inspurtest13",
    "emqOutterControlAddress": null
}

修改项目

更新项目

  • URI

PUT

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

示例

请求示例

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": "172.31.0.11:31187",
    "hubId": "iothub5",
    "updatedTime": "2019-07-30T12:00:33Z",
    "code": "iotzo86wpdc",
    "emqInnerHost": "iotzo86wpdc-iot-emq-service-in",
    "floatingIp": "100.111.64.77",
    "flag": null,
    "emqOutterAddress": "117.73.3.68:31187",
    "description": "12231121",
    "clusterId": null,
    "ownerId": "767bb18c-6966-453b-812a-2b9585582d44",
    "eip": "117.73.3.68",
    "accountId": "767bb18c-6966-453b-812a-2b9585582d44",
    "storageClass": null,
    "requestId": "1404f2b5-ed8e-4962-a5c2-15603eb1a942",
    "namespace": "default",
    "name": "project1",
    "createdTime": "2019-01-24T19:55:01Z",
    "dmOutterAddress": "100.111.64.77:30378",
    "id": "2c9f3329687f19ec01687fb6a19d0003",
    "externalIp": "172.31.0.11",
    "username": "inspurtest13",
    "emqOutterControlAddress": null
}

产品管理

产品列表

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

  • 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 产品秘钥
userName String 用户名称
accountId String 用户组 Id
requestId String 请求 Id
  • 示例

请求示例

URI:

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

返回示例

{
    "data": [
        {
            "code": "hkr4xjh4",
            "flag": null,
            "certCode": null,
            "productTemplateId": "00",
            "description": "1",
            "type": "subdevice",
            "ownerId": "767bb18c-6966-453b-812a-2b9585582d44",
            "dynamicRegister": false,
            "protocol": null,
            "encryption": "bydevice",
            "createdTime": "2019-04-25T13:35:53Z",
            "id": "2c9f08be6a545bfb016a54b5ac750321",
            "oneDeviceOneCert": true,
            "publishStatus": false,
            "productTemplateName": null,
            "versionType": "advanced",
            "updatedTime": "2019-04-25T13:35:53Z",
            "deviceCount": null,
            "dataFormat": "透传/自定义",
            "certId": null,
            "oneProductOneCert": false,
            "userName": null,
            "accountId": "767bb18c-6966-453b-812a-2b9585582d44",
            "name": "test-zzzh22",
            "secertKey": null,
            "projectName": null,
            "projectId": "2c9f3329687f19ec01687fb6a19d0003",
            "svrsubCertId": null
        },
        {
            "code": "atathp10",
            "flag": null,
            "certCode": null,
            "productTemplateId": "20",
            "description": "12345",
            "type": "gateway",
            "ownerId": "767bb18c-6966-453b-812a-2b9585582d44",
            "dynamicRegister": false,
            "protocol": null,
            "encryption": "bydevice",
            "createdTime": "2019-07-18T11:59:52Z",
            "id": "2c9f09dc6c04dda6016c04f3f3c3004a",
            "oneDeviceOneCert": true,
            "publishStatus": false,
            "productTemplateName": null,
            "versionType": "advanced",
            "updatedTime": "2019-07-18T11:59:52Z",
            "deviceCount": null,
            "dataFormat": "透传/自定义",
            "certId": null,
            "oneProductOneCert": false,
            "userName": null,
            "accountId": "767bb18c-6966-453b-812a-2b9585582d44",
            "name": "20190718",
            "secertKey": "W8OBISkbZzqgidTi",
            "projectName": null,
            "projectId": "2c9f3329687f19ec01687fb6a19d0003",
            "svrsubCertId": "2c9f09dc6c04dda6016c04f3f4e40065"
        }
    ],
    "requestId": "5c45ac02-5d41-46ac-9f64-3ab0c6bea350"
}

产品详情

查询指定产品的详情。

  • URI

GET

  • URI 请求参数
名称 类型 是否必须 描述
Action QueryProduct String 操作
Id String 产品 Id
公共请求参数 - 请参见公共参数
  • 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 产品秘钥
userName String 用户名称
accountId String 用户组 Id
requestId String 请求 Id
  • 示例

请求示例

URI:

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

返回示例

{
    "code": "ecb3x1r2",
    "flag": null,
    "certCode": null,
    "productTemplateId": "00",
    "description": null,
    "type": "gateway",
    "ownerId": "767bb18c-6966-453b-812a-2b9585582d44",
    "dynamicRegister": false,
    "protocol": null,
    "encryption": "bydevice",
    "requestId": "48b81eb7-7845-4fc2-8270-8b10d3e78f4d",
    "createdTime": "2019-07-30T12:57:34Z",
    "id": "2c9f32166c42be5c016c42f516ec01a5",
    "oneDeviceOneCert": true,
    "publishStatus": false,
    "productTemplateName": "自定义品类",
    "versionType": "advanced",
    "updatedTime": "2019-07-30T12:57:34Z",
    "deviceCount": 0,
    "dataFormat": "透传/自定义",
    "certId": null,
    "oneProductOneCert": false,
    "userName": null,
    "accountId": "767bb18c-6966-453b-812a-2b9585582d44",
    "name": "yangRui",
    "secertKey": "QJ1ILNp4iCCbU969",
    "projectName": "project",
    "projectId": "2c9f3329687f19ec01687fb6a19d0003",
    "svrsubCertId": "2c9f32166c42be5c016c42f517dc01bf"
}

产品功能定义详情

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

  • 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 更新时间
requestId String 请求 Id
  • 示例

请求示例

URI:

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

返回示例

{
    "data": [
        {
            "identifier": "GeoLocation",
            "tempSpecs": null,
            "updatedTime": "2019-07-18T11:59:52Z",
            "productId": "2c9f09dc6c04dda6016c04f3f3c3004a",
            "unitName": null,
            "max": null,
            "description": null,
            "type": "struct",
            "accessMode": "r",
            "specs": "[{\"identifier\": \"Longitude\", \"dataType\": {\"specs\": {\"unit\": \"°\", \"min\": \"-180\", \"unitName\": \"度\", \"max\": \"180\", \"step\": \"0.01\"}, \"type\": \"double\"}, \"name\": \"经度\"}, {\"identifier\": \"Latitude\", \"dataType\": {\"specs\": {\"unit\": \"°\", \"min\": \"-90\", \"unitName\": \"度\", \"max\": \"90\", \"step\": \"0.01\"}, \"type\": \"double\"}, \"name\": \"纬度\"}, {\"identifier\": \"Altitude\", \"dataType\": {\"specs\": {\"unit\": \"m\", \"min\": \"0\", \"unitName\": \"米\", \"max\": \"9999\", \"step\": \"0.01\"}, \"type\": \"double\"}, \"name\": \"海拔\"}, {\"identifier\": \"CoordinateSystem\", \"dataType\": {\"specs\": {\"1\": \"WGS_84\", \"2\": \"GCJ_02\"}, \"type\": \"enum\"}, \"name\": \"坐标系统\"}]",
            "functionalType": "属性",
            "unit": null,
            "min": null,
            "name": "地理位置",
            "createdTime": "2019-07-18T11:59:52Z",
            "step": null,
            "id": "2c9f09dc6c04dda6016c04f3f3d3004b"
        },
        {
            "identifier": "1",
            "tempSpecs": null,
            "updatedTime": "2019-07-18T12:05:17Z",
            "productId": "2c9f09dc6c04dda6016c04f3f3c3004a",
            "unitName": null,
            "max": "111",
            "description": null,
            "type": "float",
            "accessMode": "rw",
            "specs": null,
            "functionalType": "属性",
            "unit": "分米 / dm",
            "min": "1",
            "name": "1",
            "createdTime": "2019-07-18T12:05:17Z",
            "step": "1",
            "id": "2c9f09dc6c04dda6016c04f8e8aa0121"
        }
    ],
    "requestId": "65144c6d-f9aa-494a-8f72-e4993a05f048"
}

创建产品

创建产品

  • 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 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 产品秘钥
userName String 用户名称
accountId String 用户组 Id
requestId String 请求 Id
  • 示例

请求示例

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

返回示例

{
    "code": "0hv0sgqm",
    "flag": null,
    "certCode": null,
    "productTemplateId": "00",
    "description": "我是描述1",
    "type": "device",
    "ownerId": "767bb18c-6966-453b-812a-2b9585582d44",
    "dynamicRegister": false,
    "protocol": null,
    "encryption": "bydevice",
    "requestId": "d00d378e-1036-47cc-b07b-3b4ca48a1687",
    "createdTime": "2019-08-02T01:02:39Z",
    "id": "2c9f32166c42be5c016c4fd9a6b125aa",
    "oneDeviceOneCert": true,
    "publishStatus": false,
    "productTemplateName": null,
    "versionType": "advanced",
    "updatedTime": "2019-08-02T01:02:39Z",
    "deviceCount": null,
    "dataFormat": "透传/自定义",
    "certId": null,
    "oneProductOneCert": false,
    "userName": null,
    "accountId": "767bb18c-6966-453b-812a-2b9585582d44",
    "name": "产品1",
    "secertKey": "yhkgaujhRNMyiiQJ",
    "projectName": null,
    "projectId": "2c9f3329687f19ec01687fb6a19d0003",
    "svrsubCertId": "2c9f32166c42be5c016c4fd9a71925be"
}

修改产品

更新产品

  • 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 产品秘钥
userName String 用户名称
accountId String 用户组 Id
requestId String 请求 Id

示例

请求示例

URI:

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

Body:

"Name": "产品1",

"Description": "我是描述1"

返回示例

{
    "code": "0hv0sgqm",
    "flag": null,
    "certCode": null,
    "productTemplateId": "00",
    "description": "我是描述1",
    "type": "device",
    "ownerId": "767bb18c-6966-453b-812a-2b9585582d44",
    "dynamicRegister": false,
    "protocol": null,
    "encryption": "bydevice",
    "requestId": "815b8c63-23ec-4d14-bd25-f2ea94542886",
    "createdTime": "2019-08-02T01:02:39Z",
    "id": "2c9f32166c42be5c016c4fd9a6b125aa",
    "oneDeviceOneCert": true,
    "publishStatus": false,
    "productTemplateName": "自定义品类",
    "versionType": "advanced",
    "updatedTime": "2019-08-02T01:02:39Z",
    "deviceCount": 0,
    "dataFormat": "透传/自定义",
    "certId": null,
    "oneProductOneCert": false,
    "userName": null,
    "accountId": "767bb18c-6966-453b-812a-2b9585582d44",
    "name": "产品12",
    "secertKey": "yhkgaujhRNMyiiQJ",
    "projectName": "project",
    "projectId": "2c9f3329687f19ec01687fb6a19d0003",
    "svrsubCertId": "2c9f32166c42be5c016c4fd9a71925be"
}

删除产品

删除产品

  • 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 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 产品秘钥
userName String 用户名称
accountId String 用户组 Id
requestId String 请求 Id
  • 示例

请求示例

URI:

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

返回示例

{
    "code": "ecb3x1r2",
    "flag": null,
    "certCode": null,
    "productTemplateId": "00",
    "description": null,
    "type": "gateway",
    "ownerId": "767bb18c-6966-453b-812a-2b9585582d44",
    "dynamicRegister": false,
    "protocol": null,
    "encryption": "bydevice",
    "requestId": "4558a46f-1165-415e-9382-da121bfebe1c",
    "createdTime": "2019-07-30T12:57:34Z",
    "id": "2c9f32166c42be5c016c42f516ec01a5",
    "oneDeviceOneCert": true,
    "publishStatus": true,
    "productTemplateName": "自定义品类",
    "versionType": "advanced",
    "updatedTime": "2019-07-30T12:57:34Z",
    "deviceCount": 0,
    "dataFormat": "透传/自定义",
    "certId": null,
    "oneProductOneCert": false,
    "userName": null,
    "accountId": "767bb18c-6966-453b-812a-2b9585582d44",
    "name": "yangRui",
    "secertKey": "QJ1ILNp4iCCbU969",
    "projectName": "project",
    "projectId": "2c9f3329687f19ec01687fb6a19d0003",
    "svrsubCertId": "2c9f32166c42be5c016c42f517dc01bf"
}

创建产品标签

创建产品标签

  • 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
source String 类型
requestId 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

返回示例

{
    "updatedTime": "2019-08-02T01:08:19Z",
    "productId": "2c9f32166c42be5c016c42f516ec01a5",
    "requestId": "23567dc8-6121-4990-ad03-f3f68e01b16c",
    "name": "标签1",
    "createdTime": "2019-08-02T01:08:19Z",
    "id": "2c9f32166c42be5c016c4fded52925bf",
    "source": null,
    "ownerId": "767bb18c-6966-453b-812a-2b9585582d44",
    "labelKey": "label1",
    "value": "value1"
}

修改产品标签

更新产品标签

  • 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
source String 类型
requestId 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: 标签12,
Value: value12,

返回示例

{
    "updatedTime": "2019-08-02T01:10:32Z",
    "productId": "2c9f32166c42be5c016c42f516ec01a5",
    "requestId": "0bfe7d73-6da2-492b-8c13-e42dc0e70995",
    "name": "标签12",
    "createdTime": "2019-08-02T01:08:19Z",
    "id": "2c9f32166c42be5c016c4fded52925bf",
    "source": null,
    "ownerId": "767bb18c-6966-453b-812a-2b9585582d44",
    "labelKey": "label1",
    "value": "value12"
}

删除产品标签

删除产品标签

  • 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 单位
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"

返回示例

{
    "identifier": "temp",
    "tempSpecs": null,
    "updatedTime": "2019-08-02T01:14:43Z",
    "productId": "2c9f32166c42be5c016c42f516ec01a5",
    "unitName": null,
    "max": "111",
    "description": "灯泡温度描述",
    "type": "float",
    "accessMode": "rw",
    "specs": null,
    "functionalType": "属性",
    "unit": "摄氏度 / °C",
    "min": "1",
    "requestId": "309edb8d-4ca1-430d-9962-911df3f83978",
    "name": "灯泡温度",
    "createdTime": "2019-08-02T01:14:43Z",
    "step": "1",
    "id": "2c9f5a886c42bccb016c4fe4b1052476"
}

修改产品功能

更新产品功能

  • 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 单位
unitName String 单位名称
specs String 规范
tempSpecs String 临时规范
createTime String 创建时间
updateTime String 更新时间
requestId String 请求 Id
  • 示例

请求示例

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"

返回示例

{
    "identifier": "temp",
    "tempSpecs": null,
    "updatedTime": "2019-08-02T01:14:43Z",
    "productId": "2c9f32166c42be5c016c42f516ec01a5",
    "unitName": null,
    "max": "111",
    "description": "灯泡温度描述2",
    "type": "float",
    "accessMode": "rw",
    "specs": null,
    "functionalType": "属性",
    "unit": "摄氏度 / °C",
    "min": "1",
    "requestId": "4524d784-1b4a-49b2-b1e1-ed1399eb38e0",
    "name": "灯泡温度2",
    "createdTime": "2019-08-02T01:14:43Z",
    "step": "1",
    "id": "2c9f5a886c42bccb016c4fe4b1052476"
}

删除产品功能

删除产品功能

  • 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
accountId String 用户主账户 Id
createdTime String 创建时间
updatedTime String 更新时间
lastestOnlineTime String 最后上线时间
description String 设备描述
userName String 用户名称
requestId String 请求 Id
  • 示例

请求示例

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

返回示例

{
    "code": "tsetapi",
    "flag": null,
    "certCode": "iotzo86wpdc-kcrphqe6-tsetapi",
    "description": "small",
    "cert": {
        "updatedTime": "2019-08-02T01:48:39Z",
        "code": "iotzo86wpdc-kcrphqe6-tsetapi",
        "flag": null,
        "clientKey": "-----BEGIN RSA PRIVATE KEY-----\nMIIEpAIBAAKCAQEA6tQ3HE2tzZmG8yimG+e9iKr2To3pbnQ3EvYZBCqFXU0VOI8S\ncr3v4Q8+ZdStYLJm7XFiCIPtApmY05HX6GC9BXs0vlr3I8Fft8xDMYK3HzZekSD3\nwU1kkzG0AWYcteamiOgZ139RKP3gmqQ4xxMe+Nhxtk9mXco0E/DalL9S2TLYauWQ\nK6g+mcmdkYgMpModmjxTbrSdd35eygGXKJd8xYvGCAyCrh6WjxNHRSq0ZrsDzv5e\n62QFJp03VfWKJSdtJwHIq69jdZswteeu9ZsOxI/sAQBMJocy1Fb0xz7Xs0gLt3UG\nI5DT1TTwtTtP55oMnwJM3PLy/Qs+U6VwCPm4qwIDAQABAoIBABvQ5XJJ1UOcYvrc\nnsiBa9cLgT+O2c7Gn1t0oUP4EXIa1l+ruuCylP6QwrBnP95LY5vOqXEex21ealbt\nWKjjBKDoljfSKKIonsDzxiXQOQbOduc0A4T3OOmiopLj2JTHbISdEaqQHzn+0KMg\nvsT+A9YwNVAGGbcUY5TVG98wxoyJmi4de4/5pkTpD6rdMIoTXRfI89u2BqQ38i4R\nyr83gv30Bpya5rlg10P5hg2uJiuewD9I9Uh49tOm0HdxtHRA3NZOgBEnWBY0zAAb\no0uRDL3ND2po2W+TA4K+rvPn0kQjJRatpq7vc3y3fNOUNeKurmttyuPEt6/yZApl\naBersCkCgYEA/riVIZmV0TRctXqb0ESOSmnP6LPVo9/h8FFYUzVdrTUbDdBWOOMj\nFr4c4hLinYgm56h2T4eL/Cs4tdqZel9c24v8cq3wQkS3ARzgOUxlrKHdW0XBO+Ih\nJC1I7Z9rix5W3w2ykn5GMX+3Q/FqgJ0hfyoByRwbUTb0DFCIzCOCTy8CgYEA7AIQ\nRPi44woZ81ZPJ0MNY0siIbJ3N8dXoOR/KPES5CBiUrGcY/elxV7m9g6xW03g2gfS\nu/Gz2XmS/9dLLkcVW4SNa18lnTL5BUIuB4LgwR0yaOmrTIj50vjlrJTax3z8ve6w\nodwpJgnPRl6K0T11lM6oyRXWO1vFNxCNPYiLb0UCgYEAjpwhQpKOgnZigWiH2+7G\nC3t6X7pvnjQ2dynT3aI/ND5LS0ydOXRRrOX7nccdAT29Km3y70vgX+qC8a3Vx+Gk\nR3b0e/BOV4vJOeJE10+ijSiCmhtPuIs+Ktb/wapDt7vgvzkYBVSVUBlFLdD349IV\ncvC91y7ZTHsL3+km7cPjrRkCgYEAxyhWol1hZ/Y2P+otkWw79/aHLvhzMla907/+\nroYA8xGA51eKKbHp6cxUCoALmoj1ngfMBV3J71NwgQUlJEBH/Zq13E3GaAmDqrRW\nM3B2SYBh8bZ+H2/Xofj3l9Nla8JFZeHunCg1cSwGBdPyQPAkMRbTyBztU9n1aqpF\nBhAb2iECgYBaQR07f1ZmKoEGVy5a1clXzl+YjqRs4MQidt2PPw/hc3IzCYRNY0mW\nj2alsKFGeG2BdoaUN7eRxYJQJLe3d/2CKGKRq0hR0apjdbLyBkhuzvWsESjq88GZ\nf+6Pj995WOlh0HjYYRnlKG3kfT5nEOcGcse31cYPSMXaj1tOJ5Rw7Q==\n-----END RSA PRIVATE KEY-----\n",
        "name": null,
        "createdTime": "2019-08-02T01:48:39Z",
        "description": "证书(一机一密)属于设备:kcrphqe6-tsetapi",
        "id": "2c9f5a886c42bccb016c5003c47224b0",
        "clientCrt": "-----BEGIN CERTIFICATE-----\nMIID1zCCAr+gAwIBAgIJANanagmLRGhPMA0GCSqGSIb3DQEBCwUAMHExCzAJBgNV\nBAYTAkNOMREwDwYDVQQIDAhTaGFuZG9uZzEOMAwGA1UEBwwFSmluYW4xDzANBgNV\nBAoMBkluc3B1cjEUMBIGA1UECwwLSU9UX1NlcnZpY2UxGDAWBgNVBAMMD0lvVF9D\nZXJ0aWZpY2F0ZTAgFw0xOTA4MDIwMTQ4MzlaGA8yMTE5MDcwOTAxNDgzOVowdjEL\nMAkGA1UEBhMCQ04xETAPBgNVBAgMCFNoYW5kb25nMQ4wDAYDVQQHDAVKaW5hbjEP\nMA0GA1UECgwGSW5zcHVyMQwwCgYDVQQLDANJb3QxJTAjBgNVBAMMHGlvdHpvODZ3\ncGRjLWtjcnBocWU2LXRzZXRhcGkwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEK\nAoIBAQDq1DccTa3NmYbzKKYb572IqvZOjeludDcS9hkEKoVdTRU4jxJyve/hDz5l\n1K1gsmbtcWIIg+0CmZjTkdfoYL0FezS+WvcjwV+3zEMxgrcfNl6RIPfBTWSTMbQB\nZhy15qaI6BnXf1Eo/eCapDjHEx742HG2T2ZdyjQT8NqUv1LZMthq5ZArqD6ZyZ2R\niAykyh2aPFNutJ13fl7KAZcol3zFi8YIDIKuHpaPE0dFKrRmuwPO/l7rZAUmnTdV\n9YolJ20nAcirr2N1mzC15671mw7Ej+wBAEwmhzLUVvTHPtezSAu3dQYjkNPVNPC1\nO0/nmgyfAkzc8vL9Cz5TpXAI+birAgMBAAGjazBpMAkGA1UdEwQCMAAwCwYDVR0P\nBAQDAgXgME8GA1UdEQRIMEaHBHVJA0SHBKwfAAuCHmlvdHpvODZ3cGRjLWlvdC1l\nbXEtc2VydmljZS1pboILMTE3LjczLjMuNjiCCzE3Mi4zMS4wLjExMA0GCSqGSIb3\nDQEBCwUAA4IBAQATHxohNcN69cv0Otil7XpKZvSvEWx4ENUgmvw75gzgge6hoTCh\nEaX4+J7ybh2M8JcGZN7T3UW3KmL/v3oErowrMj6SIKtxbTA1vx7afSzVOUHFQjIO\nZzVYCF/HZORA5vqrhB1bCatZganWAAPGK56RTYbG0y8eq09DEcGFC5YsNVdTriBm\njHLSvlLrQe25Jq3+tDf43NnTHKMpwTAPTEda//a7h9ifYK0aso+zs86UT6ZAZWsz\nRsVt1+mnhRtd43k3xwgwOky2XC1e9bfHSBedKSS5LeYV2zrMVxkbwl6H09QCjJ/P\nlhzAl2PlTh4NCmt2s1KrJeK22iF1hmpxAhdy\n-----END CERTIFICATE-----\n",
        "ownerId": "767bb18c-6966-453b-812a-2b9585582d44",
        "projectId": "2c9f3329687f19ec01687fb6a19d0003",
        "status": true
    },
    "type": "gateway",
    "ownerId": "767bb18c-6966-453b-812a-2b9585582d44",
    "productName": null,
    "gatewayCode": null,
    "projectCode": "iotzo86wpdc",
    "requestId": "5b4eaab3-7c08-4f08-a251-3c50c2ae6996",
    "lastestOnlineTime": null,
    "createdTime": "2019-08-02T01:48:39Z",
    "id": "2c9f5a886c42bccb016c5003c3c824ac",
    "banned": null,
    "deviceLabels": [
        {
            "updatedTime": "2019-08-02T01:48:39Z",
            "name": "生产厂家",
            "createdTime": "2019-08-02T01:48:39Z",
            "id": "2c9f5a886c42bccb016c5003c3c924ad",
            "source": "system",
            "ownerId": "767bb18c-6966-453b-812a-2b9585582d44",
            "labelKey": "manufacturer",
            "deviceId": "2c9f5a886c42bccb016c5003c3c824ac",
            "value": ""
        },
        {
            "updatedTime": "2019-08-02T01:48:39Z",
            "name": "产品型号",
            "createdTime": "2019-08-02T01:48:39Z",
            "id": "2c9f5a886c42bccb016c5003c3c924ae",
            "source": "system",
            "ownerId": "767bb18c-6966-453b-812a-2b9585582d44",
            "labelKey": "model",
            "deviceId": "2c9f5a886c42bccb016c5003c3c824ac",
            "value": ""
        },
        {
            "updatedTime": "2019-08-02T01:48:39Z",
            "name": "地理位置",
            "createdTime": "2019-08-02T01:48:39Z",
            "id": "2c9f5a886c42bccb016c5003c3ca24af",
            "source": "system",
            "ownerId": "767bb18c-6966-453b-812a-2b9585582d44",
            "labelKey": "location",
            "deviceId": "2c9f5a886c42bccb016c5003c3c824ac",
            "value": ""
        }
    ],
    "updatedTime": "2019-08-02T01:48:39Z",
    "productId": "2c9f333b6b993a2f016bdaadf64c180c",
    "dataFormat": null,
    "active": null,
    "certId": "2c9f5a886c42bccb016c5003c47224b0",
    "userName": null,
    "version": null,
    "accountId": "767bb18c-6966-453b-812a-2b9585582d44",
    "productCode": "kcrphqe6",
    "name": "test1",
    "online": null,
    "projectId": "2c9f3329687f19ec01687fb6a19d0003"
}

指定产品设备列表

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

  • 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
accountId String 用户主账户 Id
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 设备分组
userName String 用户名称
requestId String 请求 Id
  • 示例

请求示例

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

返回示例

{
    "data": [
        {
            "code": "devicer76p7kl6",
            "flag": null,
            "certCode": null,
            "description": null,
            "cert": null,
            "type": "gateway",
            "ownerId": "767bb18c-6966-453b-812a-2b9585582d44",
            "productName": null,
            "gatewayCode": null,
            "projectCode": "iotzo86wpdc",
            "lastestOnlineTime": null,
            "createdTime": "2019-07-30T13:35:44Z",
            "id": "2c9f5a886c42bccb016c43180a2701ba",
            "banned": false,
            "deviceLabels": null,
            "updatedTime": "2019-07-30T13:36:01Z",
            "productId": "2c9f333b6b993a2f016bdaadf64c180c",
            "dataFormat": null,
            "active": null,
            "certId": "2c9f5a886c42bccb016c43180acb01be",
            "userName": null,
            "version": null,
            "accountId": "767bb18c-6966-453b-812a-2b9585582d44",
            "productCode": "kcrphqe6",
            "name": "性能测试网关02",
            "online": null,
            "projectId": "2c9f3329687f19ec01687fb6a19d0003"
        },
        {
            "code": "tsetapi",
            "flag": null,
            "certCode": null,
            "description": "small",
            "cert": null,
            "type": "gateway",
            "ownerId": "767bb18c-6966-453b-812a-2b9585582d44",
            "productName": null,
            "gatewayCode": null,
            "projectCode": "iotzo86wpdc",
            "lastestOnlineTime": null,
            "createdTime": "2019-08-02T01:48:39Z",
            "id": "2c9f5a886c42bccb016c5003c3c824ac",
            "banned": null,
            "deviceLabels": null,
            "updatedTime": "2019-08-02T01:48:39Z",
            "productId": "2c9f333b6b993a2f016bdaadf64c180c",
            "dataFormat": null,
            "active": null,
            "certId": "2c9f5a886c42bccb016c5003c47224b0",
            "userName": null,
            "version": null,
            "accountId": "767bb18c-6966-453b-812a-2b9585582d44",
            "productCode": "kcrphqe6",
            "name": "test1",
            "online": null,
            "projectId": "2c9f3329687f19ec01687fb6a19d0003"
        },
        {
            "code": "devicemhybspqs",
            "flag": null,
            "certCode": null,
            "description": null,
            "cert": null,
            "type": "gateway",
            "ownerId": "767bb18c-6966-453b-812a-2b9585582d44",
            "productName": null,
            "gatewayCode": null,
            "projectCode": "iotzo86wpdc",
            "lastestOnlineTime": null,
            "createdTime": "2019-07-10T08:01:40Z",
            "id": "2c9fbc7f6b993dcb016bdae6ffcc1b4b",
            "banned": false,
            "deviceLabels": null,
            "updatedTime": "2019-07-15T08:28:16Z",
            "productId": "2c9f333b6b993a2f016bdaadf64c180c",
            "dataFormat": null,
            "active": null,
            "certId": "2c9fbc7f6b993dcb016bdae700461b4f",
            "userName": null,
            "version": null,
            "accountId": "767bb18c-6966-453b-812a-2b9585582d44",
            "productCode": "kcrphqe6",
            "name": "性能测试网关01",
            "online": null,
            "projectId": "2c9f3329687f19ec01687fb6a19d0003"
        }
    ],
    "requestId": "bfa39a10-ded5-40ea-a639-d0830bc070b0"
}

设备详情

查询指定设备详情

  • 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
accountId String 用户主账户 Id
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 设备分组
userName String 用户名称
requestId String 请求 Id
  • 示例

请求示例

URI:

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

返回示例

{
    "code": "devicer76p7kl6",
    "flag": null,
    "certCode": "iotzo86wpdc-kcrphqe6-devicer76p7kl6",
    "description": null,
    "cert": null,
    "type": "gateway",
    "ownerId": "767bb18c-6966-453b-812a-2b9585582d44",
    "productName": "性能测试网关",
    "gatewayCode": null,
    "projectCode": "iotzo86wpdc",
    "requestId": "94e34794-7b64-440c-9298-12e1884b0598",
    "lastestOnlineTime": "2019-07-31T00:43:35Z",
    "createdTime": "2019-07-30T13:35:44Z",
    "id": "2c9f5a886c42bccb016c43180a2701ba",
    "banned": false,
    "deviceLabels": null,
    "updatedTime": "2019-07-30T13:36:01Z",
    "productId": "2c9f333b6b993a2f016bdaadf64c180c",
    "dataFormat": "透传/自定义",
    "active": true,
    "certId": "2c9f5a886c42bccb016c43180acb01be",
    "userName": null,
    "version": null,
    "accountId": "767bb18c-6966-453b-812a-2b9585582d44",
    "productCode": "kcrphqe6",
    "name": "性能测试网关02",
    "online": false,
    "projectId": "2c9f3329687f19ec01687fb6a19d0003"
}

修改设备

查询指定设备详情

  • 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
accountId String 用户主账户 Id
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 设备分组
userName String 用户名称
requestId String 请求 Id
  • 示例

请求示例

URI:

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

返回示例

{
    "code": "devicer76p7kl6",
    "flag": null,
    "certCode": "iotzo86wpdc-kcrphqe6-devicer76p7kl6",
    "description": "small2",
    "cert": null,
    "type": "gateway",
    "ownerId": "767bb18c-6966-453b-812a-2b9585582d44",
    "productName": "性能测试网关",
    "gatewayCode": null,
    "projectCode": "iotzo86wpdc",
    "requestId": "c37ac417-f5d1-4bb0-90f6-6e408f3719ab",
    "lastestOnlineTime": "2019-07-31T00:43:35Z",
    "createdTime": "2019-07-30T13:35:44Z",
    "id": "2c9f5a886c42bccb016c43180a2701ba",
    "banned": false,
    "deviceLabels": null,
    "updatedTime": "2019-08-02T01:54:25Z",
    "productId": "2c9f333b6b993a2f016bdaadf64c180c",
    "dataFormat": "透传/自定义",
    "active": true,
    "certId": "2c9f5a886c42bccb016c43180acb01be",
    "userName": null,
    "version": null,
    "accountId": "767bb18c-6966-453b-812a-2b9585582d44",
    "productCode": "kcrphqe6",
    "name": "性能测试网关02",
    "online": false,
    "projectId": "2c9f3329687f19ec01687fb6a19d0003"
}

删除设备

删除指定设备

  • 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 请求参数
  • 返回参数
名称 类型 描述
latestOnlineTime String 最后上线时间
devicecode String 设备 code
online boolean 是否在线
active boolean 是否激活
  • 示例

请求示例

URI:

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

返回示例

{
        "latestOnlineTime": null,
        "devicecode": "devicerpwcp6jj",
        "online": false,
        "active": false
}

查询指定产品下设备状态

查询指定设备的运行状态

  • URI

GET

  • URI 请求参数
名称 类型 是否必须 描述
Action BatchGetDeviceState String 操作
ProductId String 要查询的产品 id 值
公共请求参数 - 请参见公共参数
  • Body 请求参数
  • 返回参数
名称 类型 描述
latestOnlineTime String 最后上线时间
devicecode String 设备 code
online boolean 是否在线
active boolean 是否激活
  • 示例

请求示例

URI:

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

返回示例

[
    {
        "latestOnlineTime": null,
        "devicecode": "devicerpwcp6jj",
        "online": false,
        "active": false
    },
    {
        "latestOnlineTime": null,
        "devicecode": "devicelv8kik2w",
        "online": false,
        "active": false
    },
    {
        "latestOnlineTime": null,
        "devicecode": "devicelmcxs0fe",
        "online": false,
        "active": false
    }
]

子设备所属网关

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

  • 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
accountId String 用户主账户 Id
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 设备分组
userName String 用户名称
requestId String 请求 Id
  • 示例

请求示例

URI:

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

返回示例

{
    "code": "devicedtd3wobp",
    "flag": null,
    "certCode": null,
    "description": null,
    "cert": null,
    "type": "gateway",
    "ownerId": "767bb18c-6966-453b-812a-2b9585582d44",
    "productName": null,
    "gatewayCode": null,
    "projectCode": "iotzo86wpdc",
    "requestId": "b49f751f-1f89-479b-95d1-63e88d6ccf60",
    "lastestOnlineTime": null,
    "createdTime": "2019-07-30T12:04:51Z",
    "id": "2c9f32166c42be5c016c42c4d5d70051",
    "banned": null,
    "deviceLabels": null,
    "updatedTime": "2019-07-30T12:04:51Z",
    "productId": "2c9f32166c42be5c016c42c3b1860020",
    "dataFormat": null,
    "active": null,
    "certId": "2c9f32166c42be5c016c42c4d6550055",
    "userName": null,
    "version": null,
    "accountId": "767bb18c-6966-453b-812a-2b9585582d44",
    "productCode": "85o95l89",
    "name": "test",
    "online": null,
    "projectId": "2c9f3329687f19ec01687fb6a19d0003"
}

指定设备标签列表

查询指定设备的标签列表

  • 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 标签来源
requestId String 请求 Id
  • 示例

请求示例

URI:

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

返回示例

{
    "data": [
        {
            "updatedTime": "2019-07-30T12:05:00Z",
            "name": "生产厂家",
            "createdTime": "2019-07-30T12:05:00Z",
            "id": "2c9f5a886c42bccb016c42c4f89a0063",
            "source": "system",
            "ownerId": "767bb18c-6966-453b-812a-2b9585582d44",
            "labelKey": "manufacturer",
            "deviceId": "2c9f5a886c42bccb016c42c4f8980062",
            "value": ""
        },
        {
            "updatedTime": "2019-07-30T12:05:00Z",
            "name": "产品型号",
            "createdTime": "2019-07-30T12:05:00Z",
            "id": "2c9f5a886c42bccb016c42c4f89a0064",
            "source": "system",
            "ownerId": "767bb18c-6966-453b-812a-2b9585582d44",
            "labelKey": "model",
            "deviceId": "2c9f5a886c42bccb016c42c4f8980062",
            "value": ""
        },
        {
            "updatedTime": "2019-07-30T12:05:00Z",
            "name": "地理位置",
            "createdTime": "2019-07-30T12:05:00Z",
            "id": "2c9f5a886c42bccb016c42c4f89b0065",
            "source": "system",
            "ownerId": "767bb18c-6966-453b-812a-2b9585582d44",
            "labelKey": "location",
            "deviceId": "2c9f5a886c42bccb016c42c4f8980062",
            "value": ""
        }
    ],
    "requestId": "e4b0f76b-5d25-4c6c-bebd-53a69278a9ae"
}

创建设备标签

为指定设备设置标签

  • 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 标签来源
requestId String 请求 Id
  • 示例

请求示例

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

返回示例

{
    "updatedTime": "2019-08-02T02:17:26Z",
    "requestId": "abf1a208-2761-4044-8f8e-be15548c7488",
    "name": "name1",
    "createdTime": "2019-08-02T02:17:26Z",
    "id": "2c9f5a886c42bccb016c501e1d882540",
    "source": null,
    "ownerId": "767bb18c-6966-453b-812a-2b9585582d44",
    "labelKey": "key1",
    "deviceId": "2c9f5a886c42bccb016c42c4f8980062",
    "value": "Value1"
}

修改设备标签

更新设备下的指定标签

更新项目

  • 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 标签来源
requestId String 请求 Id
  • 示例

请求示例

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

返回示例

{
    "updatedTime": "2019-08-02T02:18:49Z",
    "requestId": "fc6c2cb2-531a-4f47-83ca-8a171ed74f7d",
    "name": "name2",
    "createdTime": "2019-08-02T02:17:26Z",
    "id": "2c9f5a886c42bccb016c501e1d882540",
    "source": null,
    "ownerId": "767bb18c-6966-453b-812a-2b9585582d44",
    "labelKey": "key2",
    "deviceId": "2c9f5a886c42bccb016c42c4f8980062",
    "value": "Value2"
}

删除设备标签

删除设备下的指定标签

  • 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
accountId String 用户主账户 Id
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 设备分组
requestId String 请求 Id
  • 示例

请求示例

URI:

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

返回示例

{
    "data": [
        {
            "code": "devicefbo4tvmq",
            "flag": null,
            "certCode": null,
            "description": null,
            "cert": null,
            "type": "subdevice",
            "ownerId": "767bb18c-6966-453b-812a-2b9585582d44",
            "productName": null,
            "gatewayCode": "devicedtd3wobp",
            "projectCode": "iotzo86wpdc",
            "lastestOnlineTime": null,
            "createdTime": "2019-07-30T12:05:00Z",
            "id": "2c9f5a886c42bccb016c42c4f8980062",
            "banned": null,
            "deviceLabels": null,
            "updatedTime": "2019-07-30T12:05:00Z",
            "productId": "2c9f32166c42be5c016c42c4332f003b",
            "dataFormat": null,
            "active": null,
            "certId": null,
            "userName": null,
            "version": null,
            "accountId": "767bb18c-6966-453b-812a-2b9585582d44",
            "productCode": "9cmcqms0",
            "name": "tett",
            "online": null,
            "projectId": "2c9f3329687f19ec01687fb6a19d0003"
        }
    ],
    "requestId": "3e4363e7-b975-4186-aa77-8dad05a58b27"
}

网关绑定子设备

添加子设备到网关

  • 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
accountId String 用户主账户 Id
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 设备分组
requestId String 请求 Id
  • 示例

请求示例

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

返回示例

{
    "data": [
        {
            "code": "devicefbo4tvmq",
            "flag": null,
            "certCode": null,
            "description": null,
            "cert": null,
            "type": "subdevice",
            "ownerId": "767bb18c-6966-453b-812a-2b9585582d44",
            "productName": null,
            "gatewayCode": "devicedtd3wobp",
            "projectCode": "iotzo86wpdc",
            "lastestOnlineTime": null,
            "createdTime": "2019-07-30T12:05:00Z",
            "id": "2c9f5a886c42bccb016c42c4f8980062",
            "banned": null,
            "deviceLabels": null,
            "updatedTime": "2019-07-30T12:05:00Z",
            "productId": "2c9f32166c42be5c016c42c4332f003b",
            "dataFormat": null,
            "active": null,
            "certId": null,
            "userName": null,
            "version": null,
            "accountId": "767bb18c-6966-453b-812a-2b9585582d44",
            "productCode": "9cmcqms0",
            "name": "tett",
            "online": null,
            "projectId": "2c9f3329687f19ec01687fb6a19d0003"
        },
        {
            "code": "devicetbjq372h",
            "flag": null,
            "certCode": null,
            "description": null,
            "cert": null,
            "type": "subdevice",
            "ownerId": "767bb18c-6966-453b-812a-2b9585582d44",
            "productName": null,
            "gatewayCode": "devicedtd3wobp",
            "projectCode": "iotzo86wpdc",
            "lastestOnlineTime": null,
            "createdTime": "2019-07-18T12:08:39Z",
            "id": "2c9f09dc6c04dda6016c04fbfeff0124",
            "banned": null,
            "deviceLabels": null,
            "updatedTime": "2019-07-18T12:08:39Z",
            "productId": "2c9f09dc6c04dda6016c04f7cde800d9",
            "dataFormat": null,
            "active": null,
            "certId": null,
            "userName": null,
            "version": null,
            "accountId": "767bb18c-6966-453b-812a-2b9585582d44",
            "productCode": "5xg9c6xz",
            "name": "测试",
            "online": null,
            "projectId": "2c9f3329687f19ec01687fb6a19d0003"
        }
    ],
    "requestId": "01dad765-3caa-4507-8bda-6ef187ac8773"
}

网关解绑子设备

从网关中移除子设备

  • 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: {
    "state": {
        "reported": {
            "_delayMs": 0,
            "_receive": 0,
            "_send": 1,
            "temperature": 36
        }
    }
}

返回示例

{}

设备影子

查询设备影子

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

  • URI

GET

  • URI 请求参数
名称 类型 是否必须 描述
Action GetDeviceShadow String 操作
DeviceId String 要查询的 DeviceId 值
公共请求参数 - 请参见公共参数
  • Body 请求参数
  • 返回参数
{
    "metadata": {
        "reported": {
            "_delayMs": {
                "timestamp": 1559609766882
            },
            "_receive": {
                "timestamp": 1559609766882
            },
            "_send": {
                "timestamp": 1559609766882
            },
            "temperature": {
                "timestamp": 1559609766882
            }
        }
    },
    "requestId": "2e3aaefd-2b35-4f00-a309-0bc1c7fefa1e",
    "state": {
        "reported": {
            "_delayMs": 0,
            "_receive": 0,
            "_send": 1,
            "temperature": 36
        }
    },
    "version": 9,
    "timestamp": 1559609766882,
    "timeflag": "From_Device"
}
  • 示例

请求示例

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"

        }

     }

}

返回示例