IoT Core

Last Updated on : 2024-09-26 02:09:35download

IoT Core provides the fundamental device connection and device management. The secured and reliable connection between your IoT application and devices allows to monitor and to manage your IoT assets.

Space Management

API Name	URL
Delete Space	DELETE:/v2.0/cloud/space/{space_id}
Query Resources in Space	GET:/v2.0/cloud/space/{space_id}/resource
Create Space	POST:/v2.0/cloud/space/creation
Query Space	GET:/v2.0/cloud/space/{space_id}
Query Space List	GET:/v2.0/cloud/space/child
Modify Space Information	PUT:/v2.0/cloud/space/{space_id}
Query Parent-Child Relationship	GET:/v2.0/cloud/space/relation

Device Management

API Name	URL
Get Status Reporting Log	GET:/v2.0/cloud/thing/{device_id}/report-logs
Get Update Progress	GET:/v2.0/cloud/thing/{device_id}/firmware/{channel}/progress
Query Device Details in Bulk	GET:/v2.0/cloud/thing/batch
Delete Device	DELETE:/v2.0/cloud/thing/{device_id}
Get Update Information	GET:/v2.0/cloud/thing/{device_id}/firmware
Query Device Details	GET:/v2.0/cloud/thing/{device_id}
Confirm Start of Update	POST:/v2.0/cloud/thing/{device_id}/firmware/{channel}
Get Device State	GET:/v2.0/cloud/thing/{device_id}/state
Get Operation Log	GET:/v2.0/cloud/thing/{device_id}/logs
Modify Basic Properties	POST:/v2.0/cloud/thing/{device_id}/attribute
Freeze/Unfreeze Device	POST:/v2.0/cloud/thing/{device_id}/freeze
Transfer Device	POST:/v2.0/cloud/thing/{device_id}/transfer
Restore Factory Defaults	POST:/v2.0/cloud/thing/{device_id}/reset
Query Devices in Space	GET:/v2.0/cloud/thing/space/device
Query Devices in Project	GET:/v2.0/cloud/thing/device
Pair Device by Scanning QR Code	POST:/v2.0/cloud/thing/active/qrcode
Query Pairing Result	GET:/v2.0/cloud/thing/active/token/{token}
Send Signal Detection Instruction	POST:/v2.0/cloud/thing/signal/detection/issue
Query Signal Strength	GET:/v2.0/cloud/thing/{device_id}/{device_type}/signal
Get Status Reporting Log	GET:/v2.1/cloud/thing/{device_id}/report-logs

Device Control

API Name	URL
Send Actions	POST:/v2.0/cloud/thing/{device_id}/shadow/actions
Query Properties	GET:/v2.0/cloud/thing/{device_id}/shadow/properties
Modify Properties	POST:/v2.0/cloud/thing/{device_id}/shadow/properties
Query Desired Properties	GET:/v2.0/cloud/thing/{device_id}/shadow/properties/desired
Send Property	POST:/v2.0/cloud/thing/{device_id}/shadow/properties/issue
Set Desired Property	POST:/v2.0/cloud/thing/{device_id}/shadow/properties/desired
Query Things Data Model	GET:/v2.0/cloud/thing/{device_id}/model

Scene Linkage Rules

API Name	URL
Get Linkage Rule Details	GET:/v2.0/cloud/scene/rule/{rule_id}
Query Linkage Rules	GET:/v2.0/cloud/scene/rule
Delete Linkage Rule	DELETE:/v2.0/cloud/scene/rule
Trigger Tap-to-Run	POST:/v2.0/cloud/scene/rule/{rule_id}/actions/trigger
Modify Linkage Rule	PUT:/v2.0/cloud/scene/rule/{rule_id}
Enable/Disable Automation	PUT:/v2.0/cloud/scene/rule/state
Add Linkage Rule	POST:/v2.0/cloud/scene/rule

Device Control(Standard Instruction Set)

API Name	URL
Get the specifications and properties of the device	GET:/v1.0/iot-03/devices/{device_id}/specification
Get the instruction set of the device	GET:/v1.0/iot-03/devices/{device_id}/functions
Get the instruction set of the category	GET:/v1.0/iot-03/categories/{category}/functions
Send commands	POST:/v1.0/iot-03/devices/{device_id}/commands
Get Category List	GET:/v1.0/iot-03/device-categories
Get the status of a single device	GET:/v1.0/iot-03/devices/{device_id}/status
Get the latest status of multiple devices	GET:/v1.0/iot-03/devices/status
Get Status Set	GET:/v1.0/iot-03/categories/{category}/status

Device Group

API Name	URL
Query Group Properties	GET:/v2.1/cloud/thing/group/{group_id}/properties
Get Groups in Space	GET:/v2.1/cloud/thing/group
Add Devices	PUT:/v2.1/cloud/thing/group/{group_id}/devices
Create Group	POST:/v2.1/cloud/thing/group
Get Device Group	GET:/v2.1/cloud/thing/group/device/{device_id}
Query Group Task Progress	GET:/v2.1/cloud/thing/group/task/{group_id}/{task_id}
Query Group Status	GET:/v2.1/cloud/thing/group/{group_id}/status-set
Remove Devices	DELETE:/v2.1/cloud/thing/group/{group_id}/devices
Delete Group	DELETE:/v2.1/cloud/thing/group/{group_id}
Query Group Devices	GET:/v2.1/cloud/thing/group/{group_id}/devices
Modify Group Information	PUT:/v2.1/cloud/thing/group/{group_id}
Send Group Properties	POST:/v2.1/cloud/thing/group/{group_id}/properties
Query Group Details	GET:/v2.1/cloud/thing/group/{group_id}

Prev DocAPI Adjustment Announcement

Next DocSpace Management