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
DICTIONARY_MANAGEMENT
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 校验字典是否存在 | hcloud ROMA ValidateDictionary | 校验指定条件的字典是否存在,支持字典名称和字典编码 | |
| 查询字典列表 | hcloud ROMA ListDictionary | 查询字典列表 | |
| 创建字典 | hcloud ROMA CreateDictionary | 创建字典 | |
| 查询字典详情 | hcloud ROMA CheckDictionary | 查询字典详情 | |
| 更新字典 | hcloud ROMA UpdateDictionary | 更新字典 | |
| 删除字典 | hcloud ROMA DeleteDictionary | 删除单个字典,会同时删除该字典的所有子字典 |
PUBLIC_MANAGEMENT
任务监控管理
数据源管理
| 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 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 | 修改响应属性 |
订阅管理操作
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名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 批量删除流控策略 | hcloud ROMA BatchDeleteThrottlingPolicyV2 | 批量删除流控策略。 |