Updated on 2024-03-15 GMT+08:00

List of Supported Actions

API Group

Permission

API

Action

Product management

Creating a product

POST /v5/iot/{project_id}/products

iotda:products:create

Querying the product list

GET /v5/iot/{project_id}/products

iotda:products:queryList

Querying a product

GET /v5/iot/{project_id}/products/{product_id}

iotda:products:query

Modifying a product

PUT /v5/iot/{project_id}/products/{product_id}

iotda:products:modify

Deleting a product

DELETE /v5/iot/{project_id}/products/{product_id}

iotda:products:delete

Device management

Creating a device

POST /v5/iot/{project_id}/devices

iotda:devices:register

Querying the device list

GET /v5/iot/{project_id}/devices

iotda:devices:queryList

Querying a device

GET /v5/iot/{project_id}/devices/{device_id}

iotda:devices:query

Modifying a device

PUT /v5/iot/{project_id}/devices/{device_id}

iotda:devices:modify

Deleting a device

DELETE /v5/iot/{project_id}/devices/{device_id}

iotda:devices:delete

Resetting a device secret

POST /v5/iot/{project_id}/devices/{device_id}/action

iotda:devices:resetSecret

Freezing a device

POST /v5/iot/{project_id}/devices/{device_id}/freeze

iotda:devices:freeze

Unfreezing a device

POST /v5/iot/{project_id}/devices/{device_id}/unfreeze

iotda:devices:unfreeze

Resetting a device fingerprint

POST /v5/iot/{project_id}/devices/{device_id}/reset-fingerprint

iotda:devices:resetFingerprint

Querying device list flexibly

POST /v5/iot/{project_id}/search/query-devices

iotda:devices:queryList

Device message management

Delivering a device message

POST /v5/iot/{project_id}/devices/{device_id}/messages

iotda:messages:send

Querying device messages

GET /v5/iot/{project_id}/devices/{device_id}/messages

iotda:messages:queryList

Querying a message by message ID

GET /v5/iot/{project_id}/devices/{device_id}/messages/{message_id}

iotda:messages:query

Broadcasting a message

POST /v5/iot/{project_id}/broadcast-messages

iotda:message:broadcast

Device command management

Delivering a device command

POST /v5/iot/{project_id}/devices/{device_id}/commands

iotda:commands:send

Delivering an asynchronous command

POST /v5/iot/{project_id}/devices/{device_id}/async-commands

iotda:asynccommands:send

Querying a command with a specific ID

GET /v5/iot/{project_id}/devices/{device_id}/async-commands/{command_id}

iotda:asynccommands:query

Device property management

Modifying device properties

PUT /v5/iot/{project_id}/devices/{device_id}/properties

iotda:properties:modify

Querying device properties

GET /v5/iot/{project_id}/devices/{device_id}/properties

iotda:properties:query

Device shadow

Querying device shadow data

GET /v5/iot/{project_id}/devices/{device_id}/shadow

iotda:shadow:query

Configuring desired device shadow data

PUT /v5/iot/{project_id}/devices/{device_id}/shadow

iotda:shadow:config

AMQP queue management

Creating an AMQP queue

POST /v5/iot/{project_id}/amqp-queues

iotda:amqpqueue:create

Querying the AMQP list

GET /v5/iot/{project_id}/amqp-queues

iotda:amqpqueue:queryList

Querying an AMQP queue

GET /v5/iot/{project_id}/amqp-queues/{queue_id}

iotda:amqpqueue:query

Deleting an AMQP queue

DELETE /v5/iot/{project_id}/amqp-queues/{queue_id}

iotda:amqpqueue:delete

Access code management

Generating an access credential

POST /v5/iot/{project_id}/auth/accesscode

iotda:accesscode:create

Forwarding rule management

Creating a rule triggering condition

POST /v5/iot/{project_id}/routing-rule/rules

iotda:routingrules:create

Querying the rule triggering condition list

GET /v5/iot/{project_id}/routing-rule/rules

iotda:routingrules:queryList

Querying a rule triggering condition

GET /v5/iot/{project_id}/routing-rule/rules/{rule_id}

iotda:routingrules:query

Modifying a rule triggering condition

PUT /v5/iot/{project_id}/routing-rule/rules/{rule_id}

iotda:routingrules:modify

Deleting a rule triggering condition

DELETE /v5/iot/{project_id}/routing-rule/rules/{rule_id}

iotda:routingrules:delete

Forwarding rule action management

Creating a rule action

POST /v5/iot/{project_id}/routing-rule/actions

iotda:routingactions:create

Querying the rule action list

GET /v5/iot/{project_id}/routing-rule/actions

iotda:routingactions:queryList

Querying a rule action

GET /v5/iot/{project_id}/routing-rule/actions/{action_id}

iotda:routingactions:query

Modifying a rule action

PUT /v5/iot/{project_id}/routing-rule/actions/{action_id}

iotda:routingactions:modify

Deleting a rule action

DELETE /v5/iot/{project_id}/routing-rule/actions/{action_id}

iotda:routingactions:delete

Linkage rule management

Creating a rule

POST /v5/iot/{project_id}/rules

iotda:rules:create

Querying the rule list

GET /v5/iot/{project_id}/rules

iotda:rules:queryList

Modifying a rule

PUT /v5/iot/{project_id}/rules/{rule_id}

iotda:rules:modify

Querying a rule

GET /v5/iot/{project_id}/rules/{rule_id}

iotda:rules:query

Deleting a rule

DELETE /v5/iot/{project_id}/rules/{rule_id}

iotda:rules:delete

Modifying the rule status

PUT /v5/iot/{project_id}/rules/{rule_id}/status

iotda:rules:modifyStatus

Group management

Adding a device group

POST /v5/iot/{project_id}/device-group

iotda:group:create

Querying the device group list

GET /v5/iot/{project_id}/device-group

iotda:group:queryList

Querying a device group

GET /v5/iot/{project_id}/device-group/{group_id}

iotda:group:query

Modifying a device group

PUT /v5/iot/{project_id}/device-group/{group_id}

iotda:group:modify

Deleting a device group

DELETE /v5/iot/{project_id}/device-group/{group_id}

iotda:group:delete

Managing devices in a device group

POST /v5/iot/{project_id}/device-group/{group_id}/action

iotda:group:addDevice

Querying devices in a device group

GET /v5/iot/{project_id}/device-group/{group_id}/devices

iotda:group:queryDeviceList

Device tag management

Binding a tag

POST /v5/iot/{project_id}/tags/bind-resource

iotda:tags:bind

Unbinding a tag

POST /v5/iot/{project_id}/tags/unbind-resource

iotda:tags:unbind

Querying resources by tag

POST /v5/iot/{project_id}/tags/query-resources

iotda:tags:query

Resource space management

Querying the resource space list

GET /v5/iot/{project_id}/apps

iotda:apps:queryList

Creating a resource space

POST /v5/iot/{project_id}/apps

iotda:app:create

Querying a resource space

GET /v5/iot/{project_id}/apps/{app_id}

iotda:apps:query

Deleting a resource space

DELETE /v5/iot/{project_id}/apps/{app_id}

iotda:apps:delete

Batch task management

Creating a batch task

POST /v5/iot/{project_id}/batchtasks

iotda:batchtasks:create

Querying the batch task list

GET /v5/iot/{project_id}/batchtasks

iotda:batchtasks:queryList

Querying a batch task

GET /v5/iot/{project_id}/batchtasks/{task_id}

iotda:batchtasks:query

Retrying a batch task

POST /v5/iot/{project_id}/batchtasks/{task_id}/retry

iotda:batchtasks:retry

Stopping a batch task

POST /v5/iot/{project_id}/batchtasks/{task_id}/stop

iotda:batchtasks:stop

Deleting a batch task

DELETE /v5/iot/{project_id}/batchtasks/{task_id}

iotda:batchtasks:delete

Batch task file management

Uploading a batch task file

POST /v5/iot/{project_id}/batchtask-files

iotda:batchtasks:stop

Querying the list of batch task files

GET /v5/iot/{project_id}/batchtask-files

iotda:batchtaskfiles:queryList

Deleting a batch task file

DELETE /v5/iot/{project_id}/batchtask-files/{file_id}

iotda:batchtaskfiles:delete

Certificate management

Uploading a device CA certificate

POST /v5/iot/{project_id}/certificates

iotda:certificates:upload

Obtaining the device CA certificate list

GET /v5/iot/{project_id}/certificates

iotda:certificates:queryList

Deleting a device CA certificate

DELETE /v5/iot/{project_id}/certificates/{certificate_id}

iotda:certificates:delete

Verifying a device CA certificate

POST /v5/iot/{project_id}/certificates/{certificate_id}/action

iotda:certificates:check

Software/Firmware upgrade package management

Creating an OTA upgrade package

POST /v5/iot/{project_id}/ota-upgrades/packages

iotda:otapackages:create

Querying the OTA upgrade package list

GET /v5/iot/{project_id}/ota-upgrades/packages

iotda:otapackages:queryList

Obtaining OTA upgrade package details

GET /v5/iot/{project_id}/ota-upgrades/packages/{package_id}

iotda:otapackages:query

Deleting an OTA upgrade package

DELETE /v5/iot/{project_id}/ota-upgrades/packages/{package_id}

iotda:otapackages:delete

Tunnel management

Querying the tunnel list

GET /v5/iot/{project_id}/tunnels

iotda:tunnel:queryList

Creating a device tunnel

POST /v5/iot/{project_id}/tunnels

iotda:tunnel:create

Deleting a device tunnel

DELETE /v5/iot/{project_id}/tunnels/{id}

iotda:tunnel:delete

Querying tunnel details

GET /v5/iot/{project_id}/tunnels/{id}

iotda:tunnel:query

Modifying a device tunnel

PUT /v5/iot/{project_id}/tunnels/{id}

iotda:tunnel:update