更新时间:2026-09-16 GMT+08:00

CLI命令参考

INSTANCE_MANAGEMENT

API名称

命令

描述

操作

查询实例列表

hcloud ROMA CheckRomaInstanceListV2

获取符合条件的服务实例列表。

去调试

APPLICATION_MANAGEMENT

API名称

命令

描述

操作

校验应用是否存在

hcloud ROMA ValidateRomaApp

校验指定条件的应用是否存在

去调试

查询应用列表

hcloud ROMA ListRomaApp

查询应用列表,支持条件查询,所有条件是并且的关系

去调试

创建应用

hcloud ROMA CreateRomaApp

创建应用

去调试

查询应用详情

hcloud ROMA CheckRomaAppDetails

查询应用详情

去调试

更新应用

hcloud ROMA UpdateRomaApp

更新应用

去调试

删除应用

hcloud ROMA DeleteRomaApp

删除单个应用

去调试

查询应用密钥

hcloud ROMA CheckRomaAppSecret

查询应用密钥

去调试

重置应用密钥

hcloud ROMA ResetRomaAppSecret

重置应用密钥

去调试

查询用户成员列表

hcloud ROMA CheckAuthUsersOfApp

查询用户成员列表

去调试

设置用户成员

hcloud ROMA AddUserToApp

设置应用的用户成员,为空数组时会清空已有应用成员列表

去调试

查询候选用户成员

hcloud ROMA CheckCanAuthUsersOfApp

查询应用的候选用户成员列表,会过滤掉异常状态用户

去调试

ASSET_MANAGEMENT

API名称

命令

描述

操作

下载资产包

hcloud ROMA DownloadAssetArchive

导出作业执行成功后,通过该接口获取导出作业产生的资产包,仅能下载一次

去调试

批量导出资产

hcloud ROMA ExportAsset

批量导出资产

去调试

导入资产

hcloud ROMA ImportAsset

创建导入资产作业任务,资产版本和具体哪些资产从资产内容里读取

去调试

批量删除资产

hcloud ROMA DeleteAsset

批量删除资产

去调试

查询作业进度

hcloud ROMA CheckAssetJobStatus

查询作业进度

去调试

DICTIONARY_MANAGEMENT

API名称

命令

描述

操作

校验字典是否存在

hcloud ROMA ValidateDictionary

校验指定条件的字典是否存在,支持字典名称和字典编码

去调试

查询字典列表

hcloud ROMA ListDictionary

查询字典列表

去调试

创建字典

hcloud ROMA CreateDictionary

创建字典

去调试

查询字典详情

hcloud ROMA CheckDictionary

查询字典详情

去调试

更新字典

hcloud ROMA UpdateDictionary

更新字典

去调试

删除字典

hcloud ROMA DeleteDictionary

删除单个字典,会同时删除该字典的所有子字典

去调试

PUBLIC_MANAGEMENT

API名称

命令

描述

操作

获取服务API版本列表

hcloud ROMA ListVersion

获取服务API版本列表,无需认证

去调试

获取指定版本ID的API版本信息

hcloud ROMA CheckVersion

获取指定版本ID的API版本信息

去调试

任务监控管理

API名称

命令

描述

操作

任务监控信息列表查询

hcloud ROMA ListMonitorInfos

查询所有任务的监控信息

去调试

任务监控日志查询

hcloud ROMA ListMonitorLog

查询单个任务的所有日志信息

去调试

数据源管理

API名称

命令

描述

操作

创建数据源

hcloud ROMA CreateDatasourceInfo

创建数据源

去调试

查询数据源

hcloud ROMA ListDatasources

查询数据源

去调试

查询指定数据源

hcloud ROMA ShowDatasourceDetail

根据数据源id查询数据源

去调试

修改数据源

hcloud ROMA UpdateDatasourceInfo

修改数据源

去调试

通过数据源Id删除指定数据源信息

hcloud ROMA DeleteDatasourceInfoById

通过数据源Id删除指定数据源信息

去调试

获取数据源中所有的表

hcloud ROMA ListDatasourceTables

获取数据源中所有的表

去调试

获取数据源中某个表中所有字段

hcloud ROMA ListDatasourceColumns

获取数据源中某个表中所有字段

去调试

测试数据源连通性

hcloud ROMA StartTestDatasource

测试数据源连通性

去调试

任务管理

API名称

命令

描述

操作

创建普通任务

hcloud ROMA CreateCommonTask

创建普通任务(区别于组合任务)

去调试

查询任务列表

hcloud ROMA ListTasks

查询任务列表

去调试

更新普通任务

hcloud ROMA UpdateTask

更新普通任务

去调试

通过任务ID查询指定任务的信息

hcloud ROMA ShowTask

通过任务ID查询指定任务的信息

去调试

通过任务ID删除指定任务

hcloud ROMA DeleteTask

通过任务ID删除指定任务

去调试

统计不同类型不同状态任务数量

hcloud ROMA CountTasks

统计不同类型不同状态任务数量

去调试

手工触发单个任务

hcloud ROMA RunTask

手工触发一次任务调度

去调试

手工停止当前执行的任务

hcloud ROMA StopTask

手工停止当前执行的任务

去调试

修改调度计划

hcloud ROMA UpdateDispatches

通过任务ID和调度ID修改调度计划

去调试

创建调度计划

hcloud ROMA CreateDispatches

创建调度计划

去调试

查询调度计划

hcloud ROMA ShowDispatches

查询调度计划

去调试

批量启动\停止任务

hcloud ROMA BatchStartOrStopTasks

批量启动/停止任务

去调试

创建组合任务

hcloud ROMA CreateMultiTasks

创建组合任务

去调试

组合任务初始化

hcloud ROMA InstallMultiTasks

初始化组合任务,分配任务ID,初始化映射等

去调试

修改组合任务

hcloud ROMA UpdateMultiTasks

修改组合任务

去调试

重置组合任务进度

hcloud ROMA ResetMultiTaskOffset

重置组合任务进度

去调试

创建组合任务映射

hcloud ROMA CreateMultiTaskMappings

创建组合任务映射

去调试

删除指定任务映射

hcloud ROMA DeleteMultiTaskMapping

通过映射ID删除指定任务映射

去调试

设备分组管理

API名称

命令

描述

操作

创建设备分组

hcloud ROMA CreateDeviceGroup

创建设备分组

去调试

查询所有设备分组

hcloud ROMA ShowDeviceGroupTree

查询所有设备分组

去调试

删除设备分组

hcloud ROMA DeleteDeviceGroup

删除分组

去调试

查询设备分组详情

hcloud ROMA ShowDeviceGroup

获取设备分组及下一层分组信息

去调试

修改设备分组

hcloud ROMA UpdateDeviceGroup

修改设备分组

去调试

批量添加设备到设备分组

hcloud ROMA BatchAddDeviceToGroup

批量添加设备到设备分组

去调试

删除设备分组内的设备

hcloud ROMA DeleteDeviceFromGroup

删除设备分组内的设备

去调试

设备管理

API名称

命令

描述

操作

创建设备

hcloud ROMA CreateDevice

创建设备

去调试

查询设备

hcloud ROMA ListDevices

查询设备

去调试

设备批量下线

hcloud ROMA BatchFreezeDevices

设备批量下线

去调试

删除设备

hcloud ROMA DeleteDevice

删除指定设备ID的设备

去调试

查询设备详情

hcloud ROMA ShowDevice

查询设备详情

去调试

修改设备

hcloud ROMA UpdateDevice

修改设备信息

去调试

查询设备主题

hcloud ROMA ListTopics

查询设备主题

去调试

添加子设备到网关

hcloud ROMA AddSubsetsToGateway

添加子设备到网关

去调试

查询子设备

hcloud ROMA ListSubsets

查询子设备

去调试

查询设备影子

hcloud ROMA ListShadows

查询设备影子

去调试

重置设备鉴权信息

hcloud ROMA ResetAuthentication

重置设备鉴权信息

去调试

查询设备鉴权信息

hcloud ROMA ShowAuthentication

查询设备鉴权信息

去调试

发送命令

hcloud ROMA SendCommand

发送命令

去调试

产品模板

API名称

命令

描述

操作

创建产品模板

hcloud ROMA CreateProductTemplate

创建产品模板

去调试

查询产品模板

hcloud ROMA ListProductTemplates

查询产品模板

去调试

删除产品模板

hcloud ROMA DeleteProductTemplate

删除产品模板

去调试

修改产品模板

hcloud ROMA UpdateProductTemplate

修改产品模板

去调试

产品管理

API名称

命令

描述

操作

创建产品

hcloud ROMA CreateProduct

创建产品

去调试

查询产品

hcloud ROMA ListProducts

查询产品

去调试

查询产品内设备数量

hcloud ROMA ListDevicesInProduct

查询产品内设备数量

去调试

删除产品

hcloud ROMA DeleteProduct

删除产品

去调试

查询产品详情

hcloud ROMA ShowProduct

查询产品详情

去调试

修改产品信息

hcloud ROMA UpdateProduct

修改产品信息

去调试

添加产品主题

hcloud ROMA CreateProductTopic

添加产品主题

去调试

查询产品主题

hcloud ROMA ListProductTopics

查询产品主题

去调试

删除产品主题

hcloud ROMA DeleteProductTopic

删除产品主题

去调试

更新产品主题

hcloud ROMA UpdateProductTopic

更新产品主题

去调试

重置产品鉴权信息

hcloud ROMA ResetProductAuthentication

重置产品鉴权信息

去调试

查询产品鉴权信息

hcloud ROMA ShowProductAuthentication

查询产品鉴权信息

去调试

导入产品

hcloud ROMA UploadProduct

导入产品

去调试

导出产品

hcloud ROMA DownloadProducts

导出产品

去调试

规则引擎

API名称

命令

描述

操作

创建规则

hcloud ROMA CreateRule

创建规则

去调试

查询规则

hcloud ROMA ListRules

查询规则

去调试

批量删除规则

hcloud ROMA BatchDeleteRules

批量删除规则

去调试

规则调试

hcloud ROMA DebugRule

规则调试

去调试

删除规则

hcloud ROMA DeleteRule

删除规则

去调试

查询规则详情

hcloud ROMA ShowRule

查询规则详情

去调试

修改规则

hcloud ROMA UpdateRule

修改规则

去调试

添加目标数据源

hcloud ROMA CreateDestination

添加目标数据源

去调试

查询目标数据源列表

hcloud ROMA ListDestinations

查询目标数据源列表

去调试

删除目标数据源

hcloud ROMA DeleteDestination

删除目标数据源

去调试

添加源数据源

hcloud ROMA CreateSource

添加源数据源

去调试

查询源数据源列表

hcloud ROMA ListSources

查询源数据源列表

去调试

删除源数据源

hcloud ROMA DeleteSource

删除源数据源

去调试

服务管理

API名称

命令

描述

操作

创建服务

hcloud ROMA CreateService

创建服务

去调试

查询服务

hcloud ROMA ListServices

查询服务

去调试

删除服务

hcloud ROMA DeleteService

删除服务

去调试

查询服务详情

hcloud ROMA ShowService

查询服务详情

去调试

修改服务

hcloud ROMA UpdateService

修改服务

去调试

创建属性

hcloud ROMA CreateProperty

创建属性

去调试

查询属性

hcloud ROMA ListProperties

查询属性

去调试

创建命令

hcloud ROMA CreateCommand

创建命令

去调试

查询命令

hcloud ROMA ListCommands

查询命令

去调试

删除命令

hcloud ROMA DeleteCommand

删除命令

去调试

查询命令详情

hcloud ROMA ShowCommand

查询命令详情

去调试

修改命令

hcloud ROMA UpdateCommand

修改命令

去调试

创建请求属性

hcloud ROMA CreateRequestProperty

创建请求属性

去调试

查询请求属性

hcloud ROMA ListRequestProperties

查询请求属性

去调试

删除请求属性

hcloud ROMA DeleteRequestProperty

删除请求属性

去调试

修改请求属性

hcloud ROMA UpdateRequestProperty

修改请求属性

去调试

创建响应属性

hcloud ROMA CreateResponseProperty

创建响应属性

去调试

查询响应属性

hcloud ROMA ListResponseProperties

查询响应属性

去调试

删除响应属性

hcloud ROMA DeleteResponseProperty

删除响应属性

去调试

查询响应属性详情

hcloud ROMA ShowResponseProperty

查询响应属性详情

去调试

修改响应属性

hcloud ROMA UpdateResponseProperty

修改响应属性

去调试

订阅管理操作

API名称

命令

描述

操作

创建订阅管理

hcloud ROMA CreateNotification

该接口用于创建指定实例下对应的应用下的设备操作,订阅到指定的topic

去调试

查询订阅管理信息

hcloud ROMA ListNotification

该接口用于查询指定应用订阅管理信息的数据

去调试

修改订阅管理

hcloud ROMA UpdateNotification

该接口用于修改指定的订阅管理

去调试

删除订阅管理

hcloud ROMA DeleteNotification

该接口用于删除指定订阅管理

去调试

MQS实例管理

API名称

命令

描述

操作

查询MQS实例列表

hcloud ROMA ListMqsInstance

查询MQS实例列表。

去调试

查询MQS实例详情

hcloud ROMA ShowMqsInstance

查询指定MQS实例详情。

去调试

主题管理

API名称

命令

描述

操作

查询Topic列表

hcloud ROMA ListMqsInstanceTopics

查询Topic列表。

去调试

创建Topic

hcloud ROMA CreateMqsInstanceTopic

创建Topic。

去调试

修改Topic

hcloud ROMA UpdateMqsInstanceTopic

修改Topic。

去调试

删除Topic

hcloud ROMA DeleteMqsInstanceTopic

删除Topic。

去调试

批量删除Topic

hcloud ROMA BatchDeleteMqsInstanceTopic

批量删除Topic。

去调试

导入Topic

hcloud ROMA ImportMqsInstanceTopic

导入Topic。

去调试

导出Topic

hcloud ROMA ExportMqsInstanceTopic

导出Topic。

去调试

应用权限管理

API名称

命令

描述

操作

更新Topic权限

hcloud ROMA UpdateTopicAccessPolicy

更新Topic权限。

去调试

查询Topic权限

hcloud ROMA ShowMqsInstanceTopicAccessPolicy

查询Topic权限。

去调试

消息管理

API名称

命令

描述

操作

查询消息

hcloud ROMA ShowMqsInstanceMessages

查询消息的偏移量和消息内容。

去调试

重发消息

hcloud ROMA ResetMessages

重发消息。

去调试

流控策略管理

API名称

命令

描述

操作

批量删除流控策略

hcloud ROMA BatchDeleteThrottlingPolicyV2

批量删除流控策略。

去调试