Cloud Services API ReferenceIndustrial ScenariosIndustry Basic Service

Industry Basic Service

Last Updated on : 2023-07-19 09:56:55download

Provides the underlying service interface related to asset management

Industry Devices management

API Name	URL
Check whether a device is frozen	GET:/v1.0/iot-03/devices/{device_id}/freeze-state
Delete devices in batches	DELETE:/v1.0/iot-03/devices
Modify the device information	PUT:/v1.0/iot-03/devices/{device_id}
Delete a device	DELETE:/v1.0/iot-03/devices/{device_id}
Restore defaults	POST:/v1.0/iot-03/devices/{device_id}/actions/reset
Get the list of sub-devices	GET:/v1.0/iot-03/devices/{device_id}/sub-devices
Modify the frozen status of a device	PUT:/v1.0/iot-03/devices/{device_id}/freeze-state
Get Device Information	GET:/v1.1/iot-03/devices/{device_id}
Get Device Specification	GET:/v1.2/iot-03/devices/{device_id}/specification
Get Extended Properties in Bulk	GET:/v1.0/iot-03/devices/properties
Get Extended Properties	GET:/v1.0/iot-03/devices/{device_id}/properties
Query Protocols of Multiple Devices	GET:/v1.0/iot-03/devices/protocol
Get Device List	GET:/v1.3/iot-03/devices

Industry Asset Management

API Name	URL
Query assets based on id	GET:/v1.0/iot-02/assets
Delete Asset	DELETE:/v1.0/iot-02/assets/{asset_id}
Modify Asset	PUT:/v1.0/iot-02/assets/{asset_id}
Query Node Devices in Pages	GET:/v1.0/iot-02/assets/{asset_id}/devices
Paging query of sub-nodes under the current node	GET:/v1.0/iot-02/assets/{asset_id}/sub-assets
Query assets based on id	GET:/v1.0/iot-02/assets/{asset_id}
Add new asset	POST:/v1.0/iot-02/assets
Authorize Assets	POST:/v1.0/iot-03/assets/actions/user-authorized
Query the Authorized Assets	GET:/v1.0/iot-03/users/{uid}/assets
Authorize User with Assets	POST:/v1.0/iot-03/users/{uid}/actions/batch-assets-authorized
Revoke a User's Asset Permissions	POST:/v1.0/iot-03/users/{uid}/actions/assets-unauthorized
Revoke Asset Permissions from a User	POST:/v1.0/iot-03/users/{uid}/actions/batch-assets-unauthorized
Query Cross-Level Sub-Assets	POST:/v1.1/iot-02/cross-level-sub-assets
Query Authorized User List	GET:/v1.0/iot-03/{asset_id}/authorized_users
Transfer Device	POST:/v1.0/iot-03/assets/devices/{device_id}/actions/transfer
Query and Sort Asset Sub-Node	GET:/v1.1/iot-02/assets/{asset_id}/sub-assets

Industry User Management

API Name	URL
Query User Information by User ID	GET:/v1.0/iot-02/users/{user_id}
Register User	POST:/v1.0/iot-02/users
Delete User	DELETE:/v1.0/iot-02/users/{user_id}
Reset Password	PUT:/v1.0/iot-02/users/reset-password
Query User Information on Pages	GET:/v1.1/iot-02/users
Modify User Information	PUT:/v1.1/iot-02/users/{user_id}
Query User by Username	GET:/v1.2/iot-02/users/{user_name}
Query User Information on Pages	GET:/v1.1/iot-02/users/page

Industry Device Registration

API Name	URL
Register a Bluetooth Device	POST:/v1.0/iot-03/device-registration/single-bluetooth/actions/register
Search for sub-devices	POST:/v1.0/iot-03/device-registration/devices/{device_id}/actions/discover
Generate an `authKey` for Bluetooth Device Pairing	POST:/v1.0/iot-03/device-registration/single-bluetooth/auth-key
Activate a Bluetooth Device	POST:/v1.0/iot-03/device-registration/single-bluetooth/actions/active
Generate Pairing Token	POST:/v1.0/iot-03/device-registration/token
Stop Discovering Sub-devices	POST:/v1.0/iot-03/device-registration/devices/{device_id}/actions/stop-discover
Get the list of newly connected sub-devices	GET:/v1.0/iot-03/device-registration/devices/{device_id}/sub-devices
Query device activation result based on network distribution token	GET:/v1.1/iot-03/device-registration/tokens/{token}
Get Cloud System Time	GET:/v1.0/iot-03/cloud/system-time
Pair NB-IoT Device by Scanning QR Code	POST:/v1.0/iot-03/device-registration/qrcode-bind
Get the list of gateways under the asset	GET:/v1.0/iot-03/device-registration/assets/{asset_id}/gateways
Generate RSA Public Key for Bluetooth Pairing	POST:/v1.0/iot-03/device-registration/assets/{asset_id}/encryptions/rsa/public-key
Bind Device with Asset	POST:/v1.1/iot-02/device-bc-bind

Prev DocIndustrial Scenarios

Next DocGeneral Device Management