更新时间:2026-08-21 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 ShowDataourceDetail

根据数据源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分组管理

API名称

命令

描述

操作

创建API分组

hcloud ROMA CreateApiGroupV2

API分组是API的管理单元,一个API分组等同于一个服务入口,创建API分组时,返回一个子域名作为访问入口。建议一个API分组下的API具有一定的相关性。

去调试

查询分组列表

hcloud ROMA ListApiGroupsV2

查询API分组列表。

去调试

查询分组详情

hcloud ROMA ShowDetailsOfApiGroupV2

查询指定分组的详细信息。

去调试

删除API分组

hcloud ROMA DeleteApiGroupV2

删除指定的API分组。

去调试

修改API分组

hcloud ROMA UpdateApiGroupV2

修改API分组属性。其中name和remark可修改,其他属性不可修改。

去调试

校验API分组名称是否存在

hcloud ROMA CheckApiGroupsV2

校验API分组名称是否存在。

去调试

API管理

API名称

命令

描述

操作

创建API

hcloud ROMA CreateApiV2

添加一个API,API即一个服务接口,具体的服务能力。

去调试

查询API列表

hcloud ROMA ListApisV2

查看API列表,返回API详细信息、发布信息等,但不能查看到后端服务信息。

去调试

查询API详情

hcloud ROMA ShowDetailsOfApiV2

查看指定的API的详细信息。

去调试

删除API

hcloud ROMA DeleteApiV2

删除指定的API。

去调试

修改API

hcloud ROMA UpdateApiV2

修改指定API的信息,包括后端服务信息。

去调试

发布或下线API

hcloud ROMA CreateOrDeletePublishRecordForApiV2

对API进行发布或下线。

去调试

调试API

hcloud ROMA DebugApiV2

调试一个API在指定运行环境下的定义,接口调用者需要具有操作该API的权限。

去调试

批量发布或下线API

hcloud ROMA BatchPublishOrOfflineApiV2

将多个API发布到一个指定的环境,或将多个API从指定的环境下线。

去调试

查询API历史版本列表

hcloud ROMA ListApiVersionsV2

查询某个API的历史版本。每个API在一个环境上最多存在10个历史版本。

去调试

切换API版本

hcloud ROMA ChangeApiVersionV2

API每次发布时,会基于当前的API定义生成一个版本。版本记录了API发布时的各种定义及状态。

去调试

查询API运行时定义

hcloud ROMA ListApiRuntimeDefinitionV2

查看指定的API在指定的环境上的运行时定义,默认查询RELEASE环境上的运行时定义。

去调试

查看版本详情

hcloud ROMA ListApiVersionDetailV2

查询某个指定的版本详情。

去调试

根据版本编号下线API

hcloud ROMA DeleteApiByVersionIdV2

对某个生效中的API版本进行下线操作,下线后,API在该版本生效的环境中将不再能够被调用。

去调试

校验API定义

hcloud ROMA CheckApisV2

校验API定义。校验API的路径或名称是否已存在

去调试

环境管理

API名称

命令

描述

操作

创建环境

hcloud ROMA CreateEnvironmentV2

在实际的生产中,API提供者可能有多个环境,如开发环境、测试环境、生产环境等,用户可以自由将API发布到某个环境,供调用者调用。

去调试

查询环境列表

hcloud ROMA ListEnvironmentsV2

查询符合条件的环境列表。

去调试

删除环境

hcloud ROMA DeleteEnvironmentV2

删除指定的环境。

去调试

修改环境

hcloud ROMA UpdateEnvironmentV2

修改指定环境的信息。其中可修改的属性为:name、remark,其它属性不可修改。

去调试

环境变量管理

API名称

命令

描述

操作

新建变量

hcloud ROMA CreateEnvironmentVariableV2

将API发布到不同的环境后,对于不同的环境,可能会有不同的环境变量,比如,API的服务部署地址,请求的版本号等。

去调试

查询变量列表

hcloud ROMA ListEnvironmentVariablesV2

查询分组下的所有环境变量的列表。

去调试

查看变量详情

hcloud ROMA ShowDetailsOfEnvironmentVariableV2

查看指定的环境变量的详情。

去调试

删除变量

hcloud ROMA DeleteEnvironmentVariableV2

删除指定的环境变量。

去调试

修改变量

hcloud ROMA UpdateEnvironmentVariableV2

修改环境变量。环境变量引用位置为api的后端服务地址时,修改对应环境变量会将使用该变量的所有api重新发布。

去调试

域名管理

API名称

命令

描述

操作

绑定域名

hcloud ROMA AssociateDomainV2

用户自定义的域名,需要CNAME到API分组的子域名上才能生效。

去调试

修改域名

hcloud ROMA UpdateDomainV2

修改绑定的域名所对应的配置信息。

去调试

解绑域名

hcloud ROMA DisassociateDomainV2

如果API分组不再需要绑定某个自定义域名,则可以为此API分组解绑此域名。

去调试

绑定域名证书

hcloud ROMA AssociateCertificateV2

如果创建API时,“定义API请求”使用HTTPS请求协议,那么在独立域名中需要添加SSL证书。

去调试

删除域名证书

hcloud ROMA DisassociateCertificateV2

如果域名证书不再需要或者已过期,则可以删除证书内容。

去调试

查看域名证书

hcloud ROMA ShowDetailsOfDomainNameCertificateV2

查看域名下绑定的证书详情。

去调试

流控策略管理

API名称

命令

描述

操作

创建流控策略

hcloud ROMA CreateRequestThrottlingPolicyV2

当API上线后,系统会默认给每个API提供一个流控策略,API提供者可以根据自身API的服务能力及负载情况变更这个流控策略。

去调试

查询流控策略列表

hcloud ROMA ListRequestThrottlingPolicyV2

查询所有流控策略的信息。

去调试

查看流控策略详情

hcloud ROMA ShowDetailsOfRequestThrottlingPolicyV2

查看指定流控策略的详细信息。

去调试

删除流控策略

hcloud ROMA DeleteRequestThrottlingPolicyV2

删除指定的流控策略。当该流控策略绑定了API时,需要先解除流控策略与API的所有绑定关系后再删除。

去调试

修改流控策略

hcloud ROMA UpdateRequestThrottlingPolicyV2

修改指定流控策略的详细信息。

去调试

批量删除流控策略

hcloud ROMA BatchDeleteThrottlingPolicyV2

批量删除流控策略。

去调试

API绑定流控策略

API名称

命令

描述

操作

绑定流控策略

hcloud ROMA AssociateRequestThrottlingPolicyV2

将流控策略应用于API,则所有对该API的访问将会受到该流控策略的限制。

去调试

批量解绑流控策略

hcloud ROMA BatchDisassociateThrottlingPolicyV2

批量解除API与流控策略的绑定关系

去调试

解除API与流控策略的绑定关系

hcloud ROMA DisassociateRequestThrottlingPolicyV2

解除API与流控策略的绑定关系。

去调试

查看流控策略绑定的API列表

hcloud ROMA ListApisBindedToRequestThrottlingPolicyV2

查询某个流控策略上已经绑定的API列表。

去调试

查看流控策略未绑定的API列表

hcloud ROMA ListApisUnbindedToRequestThrottlingPolicyV2

查询所有未绑定到该流控策略上的自有API列表。需要API已经发布,未发布的API不予展示。

去调试

查看API绑定的流控策略列表

hcloud ROMA ListRequestThrottlingPoliciesBindedToApiV2

查询某个API绑定的流控策略列表。每个环境上应该最多只有一个流控策略。

去调试

设置特殊流控

API名称

命令

描述

操作

创建特殊设置

hcloud ROMA CreateSpecialThrottlingConfigurationV2

流控策略可以限制一段时间内可以访问API的最大次数,也可以限制一段时间内单个租户和单个APP可以访问API的最大次数。

去调试

查看特殊设置列表

hcloud ROMA ListSpecialThrottlingConfigurationsV2

查看给流控策略设置的特殊配置。

去调试

删除特殊设置

hcloud ROMA DeleteSpecialThrottlingConfigurationV2

删除某个流控策略的某个特殊配置。

去调试

修改特殊设置

hcloud ROMA UpdateSpecialThrottlingConfigurationV2

修改某个流控策略下的某个特殊设置。

去调试

ACL策略管理

API名称

命令

描述

操作

查看ACL策略列表

hcloud ROMA ListAclStrategiesV2

查询所有的ACL策略列表。

去调试

批量删除ACL策略

hcloud ROMA BatchDeleteAclV2

批量删除指定的多个ACL策略。

去调试

创建ACL策略

hcloud ROMA CreateAclStrategyV2

增加一个ACL策略,策略类型通过字段acl_type来确定(permit或者deny),限制的对象的类型可以为IP[或者DOMAIN,这里的DOMAIN对应的acl_value的值为租户名称,而非“www.exampleDomain.com"之类的网络域名。

去调试

查看ACL策略详情

hcloud ROMA ShowDetailsOfAclPolicyV2

查询指定ACL策略的详情。

去调试

修改ACL策略

hcloud ROMA UpdateAclStrategyV2

修改指定的ACL策略,其中可修改的属性为:acl_name、acl_type、acl_value,其它属性不可修改。

去调试

删除ACL策略

hcloud ROMA DeleteAclV2

删除指定的ACL策略, 如果存在api与该ACL策略的绑定关系,则无法删除

去调试

API绑定ACL策略

API名称

命令

描述

操作

批量解除API与ACL策略的绑定

hcloud ROMA BatchDeleteApiAclBindingV2

批量解除API与ACL策略的绑定

去调试

将API与ACL策略进行绑定

hcloud ROMA CreateApiAclBindingV2

将API与ACL策略进行绑定。

去调试

解除API与ACL策略的绑定

hcloud ROMA DeleteApiAclBindingV2

解除某条API与ACL策略的绑定关系

去调试

查看API绑定的ACL策略列表

hcloud ROMA ListAclPolicyBindedToApiV2

查看API绑定的ACL策略列表

去调试

查看ACL策略绑定的API列表

hcloud ROMA ListApisBindedToAclPolicyV2

查看ACL策略绑定的API列表

去调试

查看ACL策略未绑定的API列表

hcloud ROMA ListApisUnbindedToAclPolicyV2

查看ACL策略未绑定的API列表,需要API已发布

去调试

APP授权管理

API名称

命令

描述

操作

APP授权

hcloud ROMA CreateAuthorizingAppsV2

APP创建成功后,还不能访问API,如果想要访问某个环境上的API,需要将该API在该环境上授权给APP。授权成功后,APP即可访问该环境上的这个API。

去调试

解除授权

hcloud ROMA CancelingAuthorizationV2

解除API对APP的授权关系。解除授权后,APP将不再能够调用该API。

去调试

查看API已绑定的APP列表

hcloud ROMA ListAppsBindedToApiV2

查询API绑定的APP列表。

去调试

查看APP已绑定的API列表

hcloud ROMA ListApisBindedToAppV2

查询APP已经绑定的API列表。

去调试

查看APP未绑定的API列表

hcloud ROMA ListApisUnbindedToAppV2

查询指定环境上某个APP未绑定的API列表,包括自有API和从云市场购买的API。

去调试

查看APP下路径冲突的api列表

hcloud ROMA ListDuplicateApisForAppV2

查询指定APP下路径冲突的api列表。

去调试

签名密钥管理

API名称

命令

描述

操作

创建签名密钥

hcloud ROMA CreateSignatureKeyV2

为了保护API的安全性,建议租户为API的访问提供一套保护机制,即租户开放的API,需要对请求来源进行认证,不符合认证的请求直接拒绝访问。

去调试

查询签名密钥列表

hcloud ROMA ListSignatureKeysV2

查询所有签名密钥的信息。

去调试

删除签名密钥

hcloud ROMA DeleteSignatureKeyV2

删除指定的签名密钥。签名密钥绑定了API时无法删除,需要先解除与API的绑定关系后删除。

去调试

修改签名密钥

hcloud ROMA UpdateSignatureKeyV2

修改指定签名密钥的详细信息。

去调试

签名密钥绑定关系管理

API名称

命令

描述

操作

绑定签名密钥

hcloud ROMA AssociateSignatureKeyV2

签名密钥创建后,需要绑定到API才能生效。

去调试

解除绑定

hcloud ROMA DisassociateSignatureKeyV2

解除API与签名密钥的绑定关系。

去调试

查看API绑定的签名密钥列表

hcloud ROMA ListSignatureKeysBindedToApiV2

查询某个API绑定的签名密钥列表。每个API在每个环境上应该最多只会绑定一个签名密钥。

去调试

查看签名密钥未绑定的API列表

hcloud ROMA ListApisNotBoundWithSignatureKeyV2

查询所有未绑定到该签名密钥上的API列表。需要API已经发布,未发布的API不予展示。

去调试

查看签名密钥绑定的API列表

hcloud ROMA ListApisBindedToSignatureKeyV2

查询某个签名密钥上已经绑定的API列表。

去调试

VPC通道管理

API名称

命令

描述

操作

创建VPC通道

hcloud ROMA CreateVpcChannelV2

在服务集成中创建连接私有VPC资源的通道,并在创建API时将后端节点配置为使用这些VPC通道,以便服务集成直接访问私有VPC资源。

去调试

查询VPC通道列表

hcloud ROMA ListVpcChannelsV2

查看VPC通道列表

去调试

查看VPC通道详情

hcloud ROMA ShowDetailsOfVpcChannelV2

查看指定的VPC通道详情

去调试

删除VPC通道

hcloud ROMA DeleteVpcChannelV2

删除指定的VPC通道

去调试

修改VPC通道

hcloud ROMA UpdateVpcChannelV2

更新指定VPC通道的参数

去调试

修改VPC通道健康检查

hcloud ROMA UpdateHealthCheck

修改VPC通道健康检查。

去调试

添加后端实例

hcloud ROMA AddingBackendInstancesV2

为指定的VPC通道添加后端实例

去调试

查看后端实例列表

hcloud ROMA ListBackendInstancesV2

查看指定VPC通道的后端实例列表。

去调试

修改后端实例

hcloud ROMA UpdateBackendInstancesV2

更新指定的VPC通道的后端实例。更新时,使用传入的请求参数对对应云服务组的后端实例进行全量覆盖修改。若未指定修改的云服务器组,则进行全量覆盖。

去调试

删除后端实例

hcloud ROMA DeleteBackendInstanceV2

删除指定VPC通道中的后端实例

去调试

批量修改后端服务器状态可用

hcloud ROMA BatchEnableMembers

批量修改后端服务器状态可用。

去调试

批量修改后端服务器状态不可用

hcloud ROMA BatchDisableMembers

批量修改后端服务器状态不可用。

去调试

添加VPC通道后端服务器组

hcloud ROMA CreateMemberGroup

在服务集成中创建VPC通道后端服务器组,VPC通道后端实例可以选择是否关联后端实例服务器组,以便管理后端服务器节点。

去调试

查询VPC通道后端云服务组列表

hcloud ROMA ListMemberGroups

查询VPC通道后端云服务组列表

去调试

查看VPC通道后端服务器组详情

hcloud ROMA ShowDetailsOfMemberGroup

查看指定的VPC通道后端服务器组详情

去调试

删除VPC通道后端服务器组

hcloud ROMA DeleteMemberGroup

删除指定的VPC通道后端服务器组

去调试

修改VPC通道后端服务器组

hcloud ROMA UpdateMemberGroup

更新指定VPC通道后端服务器组

去调试

自定义认证管理

API名称

命令

描述

操作

查询自定义认证列表

hcloud ROMA ListCustomAuthorizersV2

查询自定义认证列表

去调试

创建自定义认证

hcloud ROMA CreateCustomAuthorizerV2

创建自定义认证

去调试

查看自定义认证详情

hcloud ROMA ShowDetailsOfCustomAuthorizersV2

查看自定义认证详情

去调试

修改自定义认证

hcloud ROMA UpdateCustomAuthorizerV2

修改自定义认证

去调试

删除自定义认证

hcloud ROMA DeleteCustomAuthorizerV2

删除自定义认证

去调试

自定义后端服务

API名称

命令

描述

操作

查询后端API列表

hcloud ROMA ListLiveDataApiV2

获取某个实例下的所有后端API。

去调试

创建后端API

hcloud ROMA CreateLiveDataApiV2

在某个实例中创建后端API。

去调试

查询后端API详情

hcloud ROMA ShowLiveDataApiV2

查询后端API的详细信息。

去调试

修改后端API

hcloud ROMA UpdateLiveDataApiV2

在某个实例中更新后端API的参数。

去调试

删除后端API

hcloud ROMA DeleteLiveDataApiV2

在某个实例中删除后端API。

去调试

创建后端API脚本

hcloud ROMA CreateLiveDataApiScriptV2

在某个实例中创建后端API脚本。

去调试

测试后端API

hcloud ROMA DebugLiveDataApiV2

测试后端API是否可用。

去调试

查询后端API测试结果

hcloud ROMA ListLiveDataApiTestHistoryV2

在某个实例中查询后端API的测试结果。

去调试

查询后端API部署历史

hcloud ROMA ListLiveDataApiDeploymentHistoryV2

在某个实例中查询后端API的部署记录。

去调试

部署后端API

hcloud ROMA PublishLiveDataApiV2

在某个实例中部署后端API。

去调试

撤销后端API

hcloud ROMA UnpublishLiveDataApiV2

在某个实例中取消部署后端API。

去调试

查询自定义后端服务配额

hcloud ROMA ListLiveDataQuotaV2

查询自定义后端服务配额。

去调试

查询自定义后端服务数据源列表

hcloud ROMA ListLiveDataDataSourcesV2

查询自定义后端服务数据源列表。

去调试

校验自定义后端API定义

hcloud ROMA CheckLivedataApisV2

校验自定义后端API定义。校验自定义后端API的路径或名称是否已存在

去调试

OpenAPI接口

API名称

命令

描述

操作

导出API

hcloud ROMA ExportApiDefinitionsV2

导出分组下API的定义信息,导出文件内容符合swagger标准规范。

去调试

导入API

hcloud ROMA ImportApiDefinitionsV2

导入API。导入文件内容需要符合swagger标准规范,自定义扩展字段请参考用户指南的“附录:前端API的Swagger扩展定义”章节。

去调试

导出自定义后端API

hcloud ROMA ExportLiveDataApiDefinitionsV2

导出自定义后端API,导出文件内容符合swagger标准规范。

去调试

导入自定义后端API

hcloud ROMA ImportLiveDataApiDefinitionsV2

导入自定义后端API。导入文件内容需要符合swagger标准规范,自定义扩展字段请参考用户指南的“附录:后端API的Swagger扩展定义”章节

去调试

监控信息查询

API名称

命令

描述

操作

API指标统计值查询-最近一段时间

hcloud ROMA ListLatelyApiStatisticsV2

根据API的id和最近的一段时间查询API被调用的次数,统计周期为1分钟。查询范围一小时以内,一分钟一个样本,其样本值为一分钟内的累计值。

去调试

查询API指标统计值

hcloud ROMA ListStatisticsApi

查询某个实例下的API统计信息。

去调试

标签管理

API名称

命令

描述

操作

查询标签列表

hcloud ROMA ListTagsV2

查询标签列表

去调试

实例特性管理

API名称

命令

描述

操作

实例配置特性

hcloud ROMA CreateFeatureV2

为实例配置需要的特性。

去调试

查看实例特性列表

hcloud ROMA ListFeaturesV2

查看实例特性列表。注意:实例不支持以下特性的需要联系技术支持升级实例版本。

去调试

配置管理

API名称

命令

描述

操作

查询某个实例的租户配置列表

hcloud ROMA ListProjectCofigsV2

查询某个实例的租户配置列表,用户可以通过此接口查看各类型资源配置及使用情况。

去调试

应用配置管理

API名称

命令

描述

操作

查询应用配置列表

hcloud ROMA ListAppConfigsV2

查询应用配置列表

去调试

创建应用配置

hcloud ROMA CreateAppConfigV2

创建应用配置

去调试

查看应用配置详情

hcloud ROMA ShowDetailsOfAppConfigV2

查看应用配置详情

去调试

修改应用配置

hcloud ROMA UpdateAppConfigV2

修改应用配置

去调试

删除应用配置

hcloud ROMA DeleteAppConfigV2

删除应用配置

去调试

客户端配置

API名称

命令

描述

操作

查询APP列表

hcloud ROMA ListAppsV2

查询APP列表。

去调试

查看APP详情

hcloud ROMA ShowDetailsOfAppV2

查看指定APP的详细信息。

去调试

创建APP Code

hcloud ROMA CreateAppCodeV2

App Code为APP应用下的子模块,创建App Code之后,可以实现简易的APP认证。

去调试

自动生成APP Code

hcloud ROMA CreateAppCodeAutoV2

创建App Code时,可以不指定具体值,由后台自动生成随机字符串填充。

去调试

查询APP Code列表

hcloud ROMA ListAppCodesV2

查询App Code列表。

去调试

查看APP Code详情

hcloud ROMA ShowDetailsOfAppCodeV2

App Code为APP应用下的子模块,创建App Code之后,可以实现简易的APP认证。

去调试

删除APP Code

hcloud ROMA DeleteAppCodeV2

删除App Code,App Code删除后,将无法再通过简易认证访问对应的API。

去调试

查询客户端应用关联的应用配额

hcloud ROMA ShowAppBoundAppQuota

查看指定客户端应用关联的应用配额。

去调试

设置APP的访问控制

hcloud ROMA UpdateAppAcl

设置客户端配置的访问控制。

去调试

查看APP的访问控制详情

hcloud ROMA ShowDetailsOfAppAcl

查看APP的访问控制详情。

去调试

删除APP的访问控制

hcloud ROMA DeleteAppAcl

删除客户端配置的访问控制信息。

去调试

客户端配额

API名称

命令

描述

操作

获取客户端配额列表

hcloud ROMA ListAppQuotas

获取客户端配额列表。支持根据名称模糊查询

去调试

创建客户端配额

hcloud ROMA CreateAppQuota

创建客户端配额

去调试

获取客户端配额详情

hcloud ROMA ShowAppQuota

获取客户端配额详情

去调试

修改客户端配额

hcloud ROMA UpdateAppQuota

修改客户端配额

去调试

删除客户端配额

hcloud ROMA DeleteAppQuota

删除客户端配额。删除客户端配额时,同时删除客户端配额和客户端应用的关联关系

去调试

查询客户端配额已绑定的客户端应用列表

hcloud ROMA ListAppQuotaBoundApps

查询客户端配额已绑定的客户端应用列表。支持按客户端应用名称模糊匹配

去调试

客户端配额绑定客户端应用列表

hcloud ROMA AssociateAppsForAppQuota

客户端配额绑定客户端应用列表

去调试

解除客户端配额和客户端应用的绑定

hcloud ROMA DisassociateAppQuotaWithApp

解除客户端配额和客户端应用的绑定

去调试

查询客户端配额可绑定的客户端应用列表

hcloud ROMA ListAppQuotaBindableApps

查询客户端配额可绑定的客户端应用列表。支持按客户端应用名称模糊搜索

去调试

实例管理

API名称

命令

描述

操作

查看实例约束信息

hcloud ROMA ShowRestrictionOfInstanceV2

查看实例约束信息

去调试

查看实例详情

hcloud ROMA ShowDetailsOfInstanceV2

查看实例详情

去调试

VPC通道管理-项目级

API名称

命令

描述

操作

查询项目下所有实例的VPC通道列表

hcloud ROMA ListProjectVpcChannelsV2

查询项目下所有实例的VPC通道列表

去调试

项目下创建VPC通道

hcloud ROMA CreateProjectVpcChannel

创建相同的VPC通道关联到多个实例。同一个项目下VPC通道名称不可重复。注意:实例特性vpc_name_modifiable配置为off时才可使用。

去调试

项目下批量修改VPC通道

hcloud ROMA UpdateProjectVpcChannel

项目下根据VPC通道名称批量修改多个多个实例下的VPC通道。若实例下不存在该VPC通道则创建。注意:实例特性vpc_name_modifiable配置为off时才可使用。

去调试

项目下同步VPC通道

hcloud ROMA CreateProjectVpcChannelSyncs

同步VPC通道到多个实例。注意:实例特性vpc_name_modifiable配置为off时才可使用。

去调试

SSL证书管理

API名称

命令

描述

操作

获取SSL证书列表

hcloud ROMA ListCertificatesV2

获取SSL证书列表。

去调试

创建SSL证书

hcloud ROMA CreateCertificateV2

创建SSL证书

去调试

域名绑定SSL证书

hcloud ROMA BatchAssociateCertsV2

域名绑定SSL证书。[目前暂时仅支持单个绑定,请求体当中的certificate_ids里面有且只能有一个证书ID

去调试

域名解绑SSL证书

hcloud ROMA BatchDisassociateCertsV2

域名解绑SSL证书。目前暂时仅支持单个解绑,请求体当中的certificate_ids里面有且只能有一个证书ID

去调试

查看证书详情

hcloud ROMA ShowDetailsOfCertificateV2

查看证书详情

去调试

删除SSL证书

hcloud ROMA DeleteCertificateV2

删除ssl证书接口,删除时只有没有关联域名的证书才能被删除

去调试

修改SSL证书

hcloud ROMA UpdateCertificateV2

修改SSL证书

去调试

SSL证书绑定域名

hcloud ROMA BatchAssociateDomainsV2

SSL证书绑定域名

去调试

SSL证书解绑域名

hcloud ROMA BatchDisassociateDomainsV2

SSL证书解绑域名

去调试

获取SSL证书已绑定域名列表

hcloud ROMA ListAttachedDomainsV2

获取SSL证书已绑定域名列表。

去调试

插件管理

API名称

命令

描述

操作

创建插件

hcloud ROMA CreatePlugin

创建插件信息。

去调试

查询插件列表

hcloud ROMA ListPlugins

查询一组符合条件的API网关插件详情。

去调试

修改插件

hcloud ROMA UpdatePlugin

修改插件信息。

去调试

删除插件

hcloud ROMA DeletePlugin

删除插件。

去调试

查询插件详情

hcloud ROMA ShowPlugin

查询插件详情。

去调试

插件绑定API

hcloud ROMA AttachApiToPlugin

绑定插件到API上。

去调试

解除绑定插件的API

hcloud ROMA DetachApiFromPlugin

解除绑定在插件上的API

去调试

查询插件下绑定的API

hcloud ROMA ListPluginAttachedApis

查询指定插件下绑定的API信息

去调试

查询可绑定当前插件的API

hcloud ROMA ListPluginAttachableApis

查询可绑定当前插件的API信息。

去调试

API绑定插件

hcloud ROMA AttachPluginToApi

绑定插件到API上。

去调试

解除绑定API的插件

hcloud ROMA DetachPluginFromApi

解除绑定在API上的插件

去调试

查询API下绑定的插件

hcloud ROMA ListApiAttachedPlugins

查询指定API下绑定的插件信息

去调试

查询可绑定当前API的插件

hcloud ROMA ListApiAttachablePlugins

查询可绑定当前API的插件信息。

去调试

相关文档