CLI Command Reference

Creating a Device Group

hcloud ROMA CreateDeviceGroup

This API is used to create a device group.

Go debug

Querying All Device Groups

hcloud ROMA ShowDeviceGroupTree

This API is used to query all device groups.

Go debug

Deleting a Device Group

hcloud ROMA DeleteDeviceGroup

This API is used to delete a device group.

Go debug

Querying Device Group Details

hcloud ROMA ShowDeviceGroup

This API is used to query the information about a device group.

Go debug

Modifying a Device Group

hcloud ROMA UpdateDeviceGroup

This API is used to modify information of a device group.

Go debug

Adding Devices to a Device Group in Batches

hcloud ROMA BatchAddDeviceToGroup

This API is used to add devices to a device group in batches.

Go debug

Deleting Devices from a Device Group

hcloud ROMA DeleteDeviceFromGroup

This API is used delete devices from a device group.

Go debug

Creating a Device

hcloud ROMA CreateDevice

This API is used to create a device.

Go debug

Querying Devices

hcloud ROMA ListDevices

This API is used to query devices.

Go debug

Bringing Devices Offline in Batches

hcloud ROMA BatchFreezeDevices

Bringing Devices Offline in Batches

Go debug

Deleting a Device

hcloud ROMA DeleteDevice

This API is used to delete a device by device ID.

Go debug

Querying Device Details

hcloud ROMA ShowDevice

This API is used to query the details of a specified device.

Go debug

Modifying a Device

hcloud ROMA UpdateDevice

This API is used to modify information of a device.

Go debug

Querying Device Topics

hcloud ROMA ListTopics

This API is used to query device topics.

Go debug

Adding a Subdevice to the Gateway

hcloud ROMA AddSubsetsToGateway

This API is used to add a subdevice to the gateway.

Go debug

Querying Subdevices

hcloud ROMA ListSubsets

This API is used to query subdevices.

Go debug

Querying a Device Shadow

hcloud ROMA ListShadows

This API is used to query a device shadow.

Go debug

Resetting Device Authentication Information

hcloud ROMA ResetAuthentication

This API is used to reset device authentication information.

Go debug

Querying Device Authentication Information

hcloud ROMA ShowAuthentication

This API is used to query device authentication information.

Go debug

Sending Commands

hcloud ROMA SendCommand

This API is used to send commands.

Go debug

Creating a Product Template

hcloud ROMA CreateProductTemplate

This API is used to create a product template.

Go debug

Querying Product Templates

hcloud ROMA ListProductTemplates

This API is used to query product templates.

Go debug

Deleting a Product Template

hcloud ROMA DeleteProductTemplate

This API is used to delete a product template.

Go debug

Modifying a Product Template

hcloud ROMA UpdateProductTemplate

This API is used to modify information of a product template.

Go debug

Creating a Product

hcloud ROMA CreateProduct

This API is used to create a product.

Go debug

Querying Products

hcloud ROMA ListProducts

This API is used to query products.

Go debug

Querying the Number of Devices in a Product

hcloud ROMA ListDevicesInProduct

This API is used to query the number of devices in a product.

Go debug

Deleting a Product

hcloud ROMA DeleteProduct

This API is used to delete a product.

Go debug

Querying Product Details

hcloud ROMA ShowProduct

This API is used to query product details.

Go debug

Modifying Product Information

hcloud ROMA UpdateProduct

This API is used to modify product information.

Go debug

Adding a Product Topic

hcloud ROMA CreateProductTopic

This API is used to add a product topic.

Go debug

Querying Product Topics

hcloud ROMA ListProductTopics

This API is used to query product topics.

Go debug

Deleting a Product Topic

hcloud ROMA DeleteProductTopic

This API is used to delete a product topic.

Go debug

Modifying a Product Topic

hcloud ROMA UpdateProductTopic

This API is used to modify a product topic.

Go debug

Resetting Product Authentication Information

hcloud ROMA ResetProductAuthentication

This API is used to reset product authentication information.

Go debug

Querying Product Authentication Information

hcloud ROMA ShowProductAuthentication

This API is used to query product authentication information.

Go debug

Importing Products

hcloud ROMA UploadProduct

This API is used to import products.

Go debug

Exporting Products

hcloud ROMA DownloadProducts

This API is used to export products.

Go debug

Creating a Rule

hcloud ROMA CreateRule

This API is used to create a rule.

Go debug

Querying Rules

hcloud ROMA ListRules

This API is used to query rules.

Go debug

Deleting Rules in Batches

hcloud ROMA BatchDeleteRules

This API is used to delete rules in batches.

Go debug

Debugging Rules

hcloud ROMA DebugRule

This API is used to debug rules.

Go debug

Deleting a Rule

hcloud ROMA DeleteRule

This API is used to delete a rule.

Go debug

Querying Rule Details

hcloud ROMA ShowRule

This API is used to query rule details.

Go debug

Modifying a Rule

hcloud ROMA UpdateRule

This API is used to modify a rule.

Go debug

Creating a Destination

hcloud ROMA CreateDestination

This API is used to create a destination of a rule.

Go debug

Querying Destinations

hcloud ROMA ListDestinations

This API is used to querying destinations.

Go debug

Deleting a Destination

hcloud ROMA DeleteDestination

This API is used to delete a destination of a rule.

Go debug

Creating a Source

hcloud ROMA CreateSource

This API is used to create a source of a rule.

Go debug

Querying Sources

hcloud ROMA ListSources

This API is used to query sources.

Go debug

Deleting a Source

hcloud ROMA DeleteSource

This API is used to delete a source of a rule.

Go debug

Creating a Service

hcloud ROMA CreateService

This API is used to create a service.

Go debug

Querying Services

hcloud ROMA ListServices

This API is used to querying services.

Go debug

Deleting a Service

hcloud ROMA DeleteService

This API is used to delete a service.

Go debug

Querying Service Details

hcloud ROMA ShowService

This API is used to query service details.

Go debug

Modifying a Service

hcloud ROMA UpdateService

This API is used to modify a service.

Go debug

Creating an Attribute

hcloud ROMA CreateProperty

This API is used to create an attribute.

Go debug

Querying Attributes

hcloud ROMA ListProperties

This API is used to query attributes.

Go debug

Creating a Command

hcloud ROMA CreateCommand

This API is used to create a command.

Go debug

Querying Commands

hcloud ROMA ListCommands

This API is used to query commands.

Go debug

Deleting a Command

hcloud ROMA DeleteCommand

This API is used to delete a command.

Go debug

Querying Command Details

hcloud ROMA ShowCommand

This API is used to query command details.

Go debug

Modifying a Command

hcloud ROMA UpdateCommand

This API is used to modify a command.

Go debug

Creating a Request Attribute

hcloud ROMA CreateRequestProperty

This API is used to create a request attribute.

Go debug

Querying Request Attributes

hcloud ROMA ListRequestProperties

This API is used to query request attributes.

Go debug

Deleting a Request Attribute

hcloud ROMA DeleteRequestProperty

This API is used to delete a request attribute.

Go debug

Modifying a Request Attribute

hcloud ROMA UpdateRequestProperty

This API is used to modify a request attribute.

Go debug

Creating a Response Attribute

hcloud ROMA CreateResponseProperty

This API is used to create a response attribute.

Go debug

Querying Response Attributes

hcloud ROMA ListResponseProperties

This API is used to query reponse attributes.

Go debug

Deleting a Response Attribute

hcloud ROMA DeleteResponseProperty

This API is used to delete a response attribute.

Go debug

Querying Response Attributes

hcloud ROMA ShowResponseProperty

This API is used to query response attributes.

Go debug

Modifying a Response Attribute

hcloud ROMA UpdateResponseProperty

This API is used to modify a response attribute.

Go debug

Creating a Subscription Management Task

hcloud ROMA CreateNotification

This API is used to create device operations under an application in a specified instance and subscribe to the specified topic.

Go debug

Querying Information About a Subscription Management Task

hcloud ROMA ListNotification

This API is used to query subscription management information of the specified application.

Go debug

Modifying a Subscription Management Task

hcloud ROMA UpdateNotification

This API is used to modify the specified subscription management.

Go debug

Deleting a Subscription Management Task

hcloud ROMA DeleteNotification

This API is used to delete the specified subscription management.

Go debug

Deleting Request Throttling Policy in Batches

hcloud ROMA BatchDeleteThrottlingPolicyV2

This API is used to delete request throttling policy in Batches.

Go debug

Verifying the Existence of a Dictionary

hcloud ROMA ValidateDictionary

This API is used to check whether the dictionary that meets a given condition exists. Only the dictionary name and code can be used as conditions.

Go debug

Querying Dictionaries

hcloud ROMA ListDictionary

This API is used to query dictionaries.

Go debug

Creating a Dictionary

hcloud ROMA CreateDictionary

This API is used to create a dictionary.

Go debug

Querying Dictionary Details

hcloud ROMA CheckDictionary

This API is used to query the details of a dictionary.

Go debug

Updating a Dictionary

hcloud ROMA UpdateDictionary

This API is used to update a dictionary.

Go debug

Deleting a Dictionary

hcloud ROMA DeleteDictionary

This API is used to delete a dictionary. When a dictionary is deleted, all its child dictionaries are deleted.

Go debug

Instance list.

hcloud ROMA CheckRomaInstanceListV2

Obtain the list of service instances that meet the search criteria.

Go debug

Querying the Task Monitoring Information List

hcloud ROMA ListMonitorInfos

This API is used to query the monitoring information about all tasks.

Go debug

Querying the Log Details of a Single Task

hcloud ROMA ListMonitorLog

This API is used to query all logs of a task.

Go debug

Creating Data Sources

hcloud ROMA CreateDatasourceInfo

This API is used to create a data source.

Go debug

Querying Data Sources

hcloud ROMA ListDatasources

This API is used to query a data source.

Go debug

Querying a Specified Data Source

hcloud ROMA ShowDataourceDetail

This API is used to query data sources based on data source IDs.

Go debug

Modifying Data Sources

hcloud ROMA UpdateDatasourceInfo

This API is used to modify a data source.

Go debug

Deleting a Specified Data Source

hcloud ROMA DeleteDatasourceInfoById

This API is used to delete information about a specified data source based on the data source ID.

Go debug

Obtaining All Tables in the Data Source

hcloud ROMA ListDatasourceTables

This API is used to obtain all tables in the data source.

Go debug

Obtaining All Fields in a Table in the Data Source

hcloud ROMA ListDatasourceColumns

This API is used to obtain all fields in a table in the data source.

Go debug

Testing Data Source Connectivity

hcloud ROMA StartTestDatasource

This API is used to test the data source connectivity.

Go debug

Counting the number of tasks of different types and states

hcloud ROMA CountTasks

This API is used to count the number of tasks of different types and states.

Go debug

Creating a Common Task

hcloud ROMA CreateCommonTask

This API is used to create a common task (different from a composite task).

Go debug

Querying a Task List

hcloud ROMA ListTasks

This API is used to query a task list.

Go debug

Updating a Common Job

hcloud ROMA UpdateTask

This API is used to update a common job.

Go debug

Querying Information About a Specified Task

hcloud ROMA ShowTask

This API is used to query the information about a specified task based on the task ID.

Go debug

Deleting a Task

hcloud ROMA DeleteTask

This API is used to delete a specified task based on the task ID.

Go debug

Manually Triggering a Single Task

hcloud ROMA RunTask

This API is used to manually trigger a task scheduling.

Go debug

Manually Stopping the Current Task

hcloud ROMA StopTask

This API is used to manually stop the current task.

Go debug

Creating a Schedule

hcloud ROMA CreateDispatches

This API is used to create a schedule.

Go debug

Querying a Schedule

hcloud ROMA ShowDispatches

This API is used to query a schedule.

Go debug

Modifying a Schedule

hcloud ROMA UpdateDispatches

This API is used to modifying a Schedule.

Go debug

Starting or Stopping Tasks in Batches

hcloud ROMA BatchStartOrStopTasks

This API is used to start or stop tasks in batches.

Go debug

Creating a Composite Task

hcloud ROMA CreateMultiTasks

Create a composite task.

Go debug

Initializing the Combined Task

hcloud ROMA InstallMultiTasks

Initialize the combined task, assign task IDs, and initialize mappings.

Go debug

Modifying a Combined Task

hcloud ROMA UpdateMultiTasks

Modify a combined task.

Go debug

Resetting the Progress of the Combined Task

hcloud ROMA ResetMultiTaskOffset

Reset the progress of the combined task.

Go debug

Creating Combined Task Mappings

hcloud ROMA CreateMultiTaskMappings

Create combined task mappings.

Go debug

Deleting the Specified Task Mapping

hcloud ROMA DeleteMultiTaskMapping

Delete the specified task mapping by ID.

Go debug

Verifying the Existence of an Application

hcloud ROMA ValidateRomaApp

This API is used to check whether an application that meets a given condition exists.

Go debug

Querying Applications

hcloud ROMA ListRomaApp

This API is used to query applications that meet all the given conditions.

Go debug

Creating an Application

hcloud ROMA CreateRomaApp

This API is used to create an application.

Go debug

Querying Application Details

hcloud ROMA CheckRomaAppDetails

This API is used to query the details of an application.

Go debug

Updating an Application

hcloud ROMA UpdateRomaApp

This API is used to update an application.

Go debug

Deleting an Application

hcloud ROMA DeleteRomaApp

This API is used to delete an application.

Go debug

Querying an Application Secret

hcloud ROMA CheckRomaAppSecret

This API is used to query an application secret.

Go debug

Resetting an Application Secret

hcloud ROMA ResetRomaAppSecret

This API is used to reset an application secret.

Go debug

Querying Application Members

hcloud ROMA CheckAuthUsersOfApp

This API is used to query members of an application.

Go debug

Setting Application Members

hcloud ROMA AddUserToApp

- This API is used to set members of an application. If an empty array is carried, the existing members are cleared.

Go debug

Querying Candidate Members

hcloud ROMA CheckCanAuthUsersOfApp

This API is used to query candidate members of an application. Members in the abnormal state are filtered out.

Go debug

Downloading an Asset Package

hcloud ROMA DownloadAssetArchive

- This API can be used to obtain the asset package generated by an executed export job. The asset package can be downloaded only once.

Go debug

Exporting Assets in Batches

hcloud ROMA ExportAsset

Exporting Assets in Batches

Go debug

Importing Assets

hcloud ROMA ImportAsset

- This API is used to create an asset import task. The asset version and specific assets are read from the asset content.

Go debug

Obtaining Job Progress

hcloud ROMA CheckAssetJobStatus

This API is used to query the job progress.

Go debug

Deleting Assets in Batches

hcloud ROMA DeleteAsset

This API is used to delete assets in batches.

Go debug

Obtaining Service API Versions

hcloud ROMA ListVersion

This API is used to obtain service API versions. No authentication is required.

Go debug

Obtaining the API Version of a Given Version ID

hcloud ROMA CheckVersion

This API is used to obtain the API version of a given version ID.

Go debug

Querying MQS Instances

hcloud ROMA ListMqsInstance

This API is used to query a list of MQS instances.

Go debug

Querying MQS Instance Details

hcloud ROMA ShowMqsInstance

This API is used to query details of an MQS instance.

Go debug

Querying Topics

hcloud ROMA ListMqsInstanceTopics

This API is used to query a list of topics.

Go debug

Creating a Topic

hcloud ROMA CreateMqsInstanceTopic

This API is used to create a topic.

Go debug

Modifying a Topic

hcloud ROMA UpdateMqsInstanceTopic

This API is used to modify a topic.

Go debug

Deleting Topics in Batches

hcloud ROMA DeleteMqsInstanceTopic

This API is used to delete topics in batches.

Go debug

Deleting Topics in Batches

hcloud ROMA BatchDeleteMqsInstanceTopic

This API is used to delete topics in batches.

Go debug

Importing Topics

hcloud ROMA ImportMqsInstanceTopic

This API is used to import topics.

Go debug

Exporting Topics

hcloud ROMA ExportMqsInstanceTopic

This API is used to export topics.

Go debug

Updating a Topic Permission

hcloud ROMA UpdateTopicAccessPolicy

This API is used to update the permission of a topic.

Go debug

Querying a Topic Permission

hcloud ROMA ShowMqsInstanceTopicAccessPolicy

This API is used to query the permission of a topic.

Go debug

Querying a Message

hcloud ROMA ShowMqsInstanceMessages

This API is used to query the offset and content of a message.

Go debug

Retransmitting a Message

hcloud ROMA ResetMessages

This API is used to retransmit a message.

Go debug