云服务 API 参考IoT Core 连接服务

IoT Core 连接服务

更新时间:2024-05-08 03:05:35下载pdf

提供了 IoT 行业最核心的设备连接和管理能力,通过多种方法实现设备接入开发者平台,在智能应用和设备间建立安全,稳定的通信并实现设备管理、监测和控制等操作。

空间管理

API 名称 接口地址
删除空间 DELETE:/v2.0/cloud/space/{space_id}
查询空间下资源列表 GET:/v2.0/cloud/space/{space_id}/resource
创建空间 POST:/v2.0/cloud/space/creation
查询空间 GET:/v2.0/cloud/space/{space_id}
查询空间节点列表 GET:/v2.0/cloud/space/child
修改空间信息 PUT:/v2.0/cloud/space/{space_id}
判断父子关系 GET:/v2.0/cloud/space/relation

设备管理

API 名称 接口地址
获取设备状态上报日志 GET:/v2.0/cloud/thing/{device_id}/report-logs
获取设备升级进度 GET:/v2.0/cloud/thing/{device_id}/firmware/{channel}/progress
批量查询设备详情 GET:/v2.0/cloud/thing/batch
移除设备 DELETE:/v2.0/cloud/thing/{device_id}
获取设备升级信息 GET:/v2.0/cloud/thing/{device_id}/firmware
查询单个设备详情 GET:/v2.0/cloud/thing/{device_id}
确认开始设备升级 POST:/v2.0/cloud/thing/{device_id}/firmware/{channel}
获取设备状态 GET:/v2.0/cloud/thing/{device_id}/state
获取设备操作日志 GET:/v2.0/cloud/thing/{device_id}/logs
修改设备基础属性 POST:/v2.0/cloud/thing/{device_id}/attribute
冻结/解冻设备 POST:/v2.0/cloud/thing/{device_id}/freeze
转移设备 POST:/v2.0/cloud/thing/{device_id}/transfer
恢复出厂设置 POST:/v2.0/cloud/thing/{device_id}/reset
查询空间下设备列表 GET:/v2.0/cloud/thing/space/device
查询项目下设备列表 GET:/v2.0/cloud/thing/device
自联网设备扫码配网 POST:/v2.0/cloud/thing/active/qrcode
查询配网结果 GET:/v2.0/cloud/thing/active/token/{token}

设备控制

API 名称 接口地址
下发动作 POST:/v2.0/cloud/thing/{device_id}/shadow/actions
查询属性 GET:/v2.0/cloud/thing/{device_id}/shadow/properties
修改属性 POST:/v2.0/cloud/thing/{device_id}/shadow/properties
查询期望属性 GET:/v2.0/cloud/thing/{device_id}/shadow/properties/desired
下发属性 POST:/v2.0/cloud/thing/{device_id}/shadow/properties/issue
设置期望属性 POST:/v2.0/cloud/thing/{device_id}/shadow/properties/desired
查询物模型 GET:/v2.0/cloud/thing/{device_id}/model

设备群组

API 名称 接口地址
查询群组 GET:/v2.0/cloud/thing/group/{group_id}
添加设备 PUT:/v2.0/cloud/thing/group/{group_id}/devices
删除设备 DELETE:/v2.0/cloud/thing/group/{group_id}/devices
获取设备所在群组 GET:/v2.0/cloud/thing/group/device/{device_id}
查询群组属性 GET:/v2.0/cloud/thing/group/{group_id}/properties
删除群组 DELETE:/v2.0/cloud/thing/group/{group_id}
创建群组 POST:/v2.0/cloud/thing/group
下发群组属性 POST:/v2.0/cloud/thing/group/properties
查询群组设备 GET:/v2.0/cloud/thing/group/{group_id}/devices
修改群组名称 PUT:/v2.0/cloud/thing/group/{group_id}/{name}
获取空间下群组 GET:/v2.0/cloud/thing/group

场景联动规则

API 名称 接口地址
获取联动规则详情 GET:/v2.0/cloud/scene/rule/{rule_id}
查询联动规则列表 GET:/v2.0/cloud/scene/rule
删除联动规则 DELETE:/v2.0/cloud/scene/rule
触发一键执行 POST:/v2.0/cloud/scene/rule/{rule_id}/actions/trigger
修改联动规则 PUT:/v2.0/cloud/scene/rule/{rule_id}
启用/禁用自动化 PUT:/v2.0/cloud/scene/rule/state
新增联动规则 POST:/v2.0/cloud/scene/rule

设备控制(标准指令集)

API 名称 接口地址
获取设备规格属性 GET:/v1.0/iot-03/devices/{device_id}/specification
获取设备支持的指令集 GET:/v1.0/iot-03/devices/{device_id}/functions
获取品类支持的指令集 GET:/v1.0/iot-03/categories/{category}/functions
下发指令 POST:/v1.0/iot-03/devices/{device_id}/commands
获取产品品类列表 GET:/v1.0/iot-03/device-categories
获取单个设备的状态 GET:/v1.0/iot-03/devices/{device_id}/status
批量获取设备最新状态 GET:/v1.0/iot-03/devices/status
获取状态集 GET:/v1.0/iot-03/categories/{category}/status