CLI命令参考

创建Kafka实例

hcloud Kafka CreatePostPaidKafkaInstance

创建实例。

去调试

查询所有实例列表

hcloud Kafka ListInstances

查询租户的实例列表，支持按照条件查询。

去调试

查询指定实例

hcloud Kafka ShowInstance

查询指定实例的详细信息。

去调试

删除指定的实例

hcloud Kafka DeleteInstance

删除指定的实例，释放该实例的所有资源。

去调试

修改实例信息

hcloud Kafka UpdateInstance

修改实例信息。

去调试

批量重启或删除实例

hcloud Kafka BatchRestartOrDeleteInstances

批量重启或删除实例。

去调试

获取实例配置

hcloud Kafka ShowInstanceConfigs

获取实例配置。

去调试

修改实例配置

hcloud Kafka ModifyInstanceConfigs

修改实例配置。

去调试

实例升级

hcloud Kafka UpgradeInstance

实例内核升级。

去调试

查询Kafka实例版本信息

hcloud Kafka ShowUpgradeInstanceVersion

查询Kafka实例版本信息。

去调试

重置密码

hcloud Kafka ResetPassword

重置密码（只针对开通SSL的实例）。

去调试

重置Manager密码

hcloud Kafka ResetManagerPassword

重置Manager密码。

去调试

重启Manager

hcloud Kafka RestartManager

重启Manager。

去调试

修改实例跨VPC访问的内网IP

hcloud Kafka UpdateInstanceCrossVpcIp

修改实例跨VPC访问的内网IP。

去调试

查询Kafka集群元数据信息

hcloud Kafka ShowCluster

查询Kafka集群元数据信息。

去调试

查询Kafka实例的协调器信息

hcloud Kafka ShowCoordinators

查询Kafka实例的协调器信息。

去调试

修改Kafka的接入方式

hcloud Kafka UpdateKafkaPortProtocol

修改Kafka的内网或者公网接入方式。

去调试

查询Topic的磁盘存储情况

hcloud Kafka ShowKafkaTopicPartitionDiskusage

查询Topic在Broker上磁盘占用情况。

去调试

恢复回收站实例

hcloud Kafka RestoreRecycleInstance

恢复回收站实例。

去调试

查询回收站实例列表

hcloud Kafka ShowRecycleInstances

查询回收站实例列表。

去调试

更新回收站策略

hcloud Kafka ModifyRecyclePolicy

更新回收站策略。

去调试

关闭Kafka Manager

hcloud Kafka CloseKafkaManager

关闭Kafka Manager，相应的原来开放出的management相关接口也将不可用。

去调试

查询Kafka实例重平衡日志详情

hcloud Kafka ShowKafkaRebalanceLog

查询Kafka实例重平衡日志详情。

去调试

开启Kafka实例重平衡日志功能

hcloud Kafka CreateKafkaRebalanceLogTask

开启Kafka实例重平衡日志功能。

去调试

关闭Kafka实例重平衡日志功能

hcloud Kafka StopKafkaRebalanceLogTask

关闭Kafka实例重平衡日志功能。

去调试

开启或者关闭Kafka实例公网访问功能

hcloud Kafka ModifyKafkaPublicIpAccessSwitch

开启或者关闭Kafka实例公网访问功能。

去调试

查询Kafka集群信息

hcloud Kafka ShowKafkaCluster

查询Kafka集群信息。

去调试

查询开启Smart Connect功能所需资源信息

hcloud Kafka ShowConnectorResourceInfo

查询开启Smart Connect功能所需要使用的资源的情况

去调试

开启Smart Connect（按需实例）

hcloud Kafka CreateConnector

开启Smart Connect，提交创建Smart Connect节点任务。

去调试

关闭Smart Connect（按需实例）

hcloud Kafka DeleteConnector

介绍按需实例如何关闭Smart Connect。

去调试

创建Smart Connect任务

hcloud Kafka CreateConnectorTask

创建Smart Connect任务。

去调试

查询Smart Connect任务列表

hcloud Kafka ListConnectorTasks

查询Smart Connect任务列表。

去调试

查询Smart Connect任务详情

hcloud Kafka ShowConnectorTask

查询Smart Connect任务详情。

去调试

删除Smart Connect任务

hcloud Kafka DeleteConnectorTask

删除Smart Connect任务。

去调试

修改Smart Connect任务配置

hcloud Kafka ModifyConnectorTask

修改Smart Connect任务配置。

去调试

校验Connector连通性

hcloud Kafka ValidateConnectorConnectivity

校验Connector连通性。

去调试

暂停Smart Connect任务

hcloud Kafka PauseConnectorTask

暂停Smart Connect任务。

去调试

启动已暂停的Smart Connect任务

hcloud Kafka ResumeConnectorTask

启动已暂停的Smart Connect任务。

去调试

启动未启动的Smart Connect任务/重启已暂停或者运行中的Smart Connect任务

hcloud Kafka RestartConnectorTask

用于启动未启动的Smart Connect任务以及重启已暂停或者运行中的Smart Connect任务。注意，重启Smart Connect任务将重置同步进度，并重新开始同步任务。

去调试

查询OBS桶列表

hcloud Kafka ListObsBuckets

查询OBS桶列表。

去调试

实例扩容

hcloud Kafka ResizeKafkaInstance

实例规格变更。当前通过调用API，只支持按需实例进行实例扩容。

去调试

查询实例的扩容规格列表

hcloud Kafka ShowKafkaInstanceExtendProductInfo

查询实例的扩容规格列表。

去调试

查询磁盘自动扩容配置

hcloud Kafka ShowVolumeExpandConfig

查询磁盘自动扩容配置，包括磁盘自动扩容是否开启，以及开启后的扩容阈值、扩容步长、扩容上限信息。

去调试

修改磁盘自动扩容配置

hcloud Kafka UpdateVolumeExpansionConfig

该接口用于修改磁盘自动扩容配置，包含磁盘自动扩容是否开启、扩容阈值、扩容步长，以及扩容上限的配置。

去调试

获取Kafka实例扩容前置检查信息

hcloud Kafka ShowKafkaScalePreCheckInfo

获取Kafka实例扩容前置检查信息。

去调试

开启或关闭实例自动创建Topic功能

hcloud Kafka UpdateInstanceAutoCreateTopic

开启或关闭实例自动创建Topic功能。

去调试

Kafka生产消息

hcloud Kafka SendKafkaMessage

在控制台发送指定消息到Kafka实例。

去调试

Kafka实例创建Topic

hcloud Kafka CreateInstanceTopic

该接口用于向Kafka实例创建Topic。

去调试

Kafka实例查询Topic

hcloud Kafka ListInstanceTopics

该接口用于查询指定Kafka实例的Topic详情。

去调试

修改Kafka实例Topic

hcloud Kafka UpdateInstanceTopic

修改Kafka实例Topic

去调试

获取Kafka Topic详细信息

hcloud Kafka ShowKafkaTopicDetail

获取Kafka Topic详细信息。

去调试

Kafka实例批量删除Topic

hcloud Kafka BatchDeleteInstanceTopic

该接口用于向Kafka实例批量删除Topic。批量删除多个Topic时，部分删除成功，部分失败，此时接口返回删除成功，并在返回中显示删除失败的Topic信息。

去调试

查询Topic的分区列表

hcloud Kafka ListTopicPartitions

查询Topic的分区列表。

去调试

查询Topic的当前生产者列表

hcloud Kafka ListTopicProducers

查询Topic的当前生产者列表。

去调试

删除Topic流控配置

hcloud Kafka DeleteKafkaTopicQuota

该接口用于向Kafka实例提交删除Topic级别的流控任务，若成功则返回流控任务的job_id。

去调试

创建Topic流控配置

hcloud Kafka CreateKafkaTopicQuota

该接口用于向Kafka实例提交创建Topic级别的流控任务，若成功则返回流控任务的job_id。

去调试

修改Topic流控配置

hcloud Kafka ModifyKafkaTopicQuota

该接口用于向Kafka实例提交修改Topic级别的流控任务，若成功则返回流控任务的job_id。

去调试

查询Topic流控配置

hcloud Kafka ShowKafkaTopicQuota

该接口用于查询Topic级别的流控任务。

去调试

Kafka实例开始分区平衡任务

hcloud Kafka CreateKafkaReassignmentTask

该接口用于向Kafka实例提交分区平衡任务，若成功则返回分区平衡任务的job id。

去调试

查询消费组信息

hcloud Kafka ShowGroups

查询消费组信息。

去调试

重置消费组消费进度到指定位置

hcloud Kafka ResetMessageOffsetWithEngine

Kafka实例不支持在线重置消费进度。在执行重置消费进度之前，必须停止被重置消费组客户端。

去调试

查询所有消费组

hcloud Kafka ListInstanceConsumerGroups

查询所有消费组。

去调试

Kafka实例批量删除消费组

hcloud Kafka BatchDeleteGroup

该接口用于向Kafka实例批量删除消费组。

去调试

创建消费组

hcloud Kafka CreateKafkaConsumerGroup

实例创建消费组。

去调试

查询消费组消息位点

hcloud Kafka ListInstanceConsumerGroupMessageOffset

查询消费组消息位点。

去调试

修改所有消费组

hcloud Kafka UpdateInstanceGroup

修改所有消费组。

去调试

查询指定消费组

hcloud Kafka ListInstanceConsumerGroup

查询指定消费组。

去调试

删除指定消费组

hcloud Kafka DeleteInstanceConsumerGroup

删除指定消费组。

去调试

修改指定消费组

hcloud Kafka UpdateInstanceConsumerGroup

修改指定消费组。

去调试

查询指定消费组的Topic

hcloud Kafka ListInstanceConsumerGroupTopics

查询指定消费组的Topic。

去调试

删除消费组在指定Topic的消费位点

hcloud Kafka DeleteConsumerGroupOffsets

删除消费组在指定Topic的消费位点。

去调试

查询指定消费组的消费成员

hcloud Kafka ListInstanceConsumerGroupMembers

查询指定消费组的消费成员。

去调试

删除用户/客户端流控配置

hcloud Kafka DeleteKafkaUserClientQuotaTask

该接口用于向Kafka实例提交删除用户、客户端级别的流控任务，若成功则返回流控任务的job_id。

去调试

查询用户/客户端流控配置

hcloud Kafka ShowKafkaUserClientQuota

该接口用于向Kafka实例查询流控的配置，若成功则返回流控配置的列表。

去调试

创建用户/客户端流控配置

hcloud Kafka CreateKafkaUserClientQuotaTask

该接口用于向Kafka实例提交创建用户、客户端级别的流控任务，若成功则返回流控任务的job_id。

去调试

修改用户/客户端流控配置

hcloud Kafka UpdateKafkaUserClientQuotaTask

该接口用于向Kafka实例提交修改用户、客户端级别的流控任务，若成功则返回流控任务的job_id。

去调试

查询用户列表

hcloud Kafka ShowInstanceUsers

查询用户列表。

去调试

创建用户

hcloud Kafka CreateInstanceUser

创建Kafka实例的用户，用户可连接开启SASL的Kafka实例。 2023年7月15日前创建的Kafka实例，一个实例最多创建20个用户。2023年7月15日及以后创建的Kafka实例，一个实例最多创建500个用户。

去调试

批量删除用户

hcloud Kafka BatchDeleteInstanceUsers

批量删除Kafka实例的用户。

去调试

重置用户密码

hcloud Kafka ResetUserPasswrod

重置用户密码

去调试

修改用户参数

hcloud Kafka UpdateInstanceUser

修改用户参数

去调试

查询用户权限

hcloud Kafka ShowTopicAccessPolicy

查询用户权限。

去调试

设置用户权限

hcloud Kafka UpdateTopicAccessPolicy

设置用户权限。

去调试

查询消息

hcloud Kafka ShowInstanceMessages

Kafka实例查询消息。

去调试

查询分区指定偏移量的消息

hcloud Kafka ShowPartitionMessage

查询分区指定偏移量的消息。

去调试

查询分区指定时间段的消息

hcloud Kafka ShowMessages

查询分区指定时间段的消息。

去调试

查询分区最早消息的位置

hcloud Kafka ShowPartitionBeginningMessage

查询分区最早消息的位置。

去调试

查询分区最新消息的位置

hcloud Kafka ShowPartitionEndMessage

查询分区最新消息的位置。

去调试

删除Kafka消息

hcloud Kafka DeleteKafkaTopicMessages

删除Kafka消息。

去调试

查询实例的后台任务列表

hcloud Kafka ListBackgroundTasks

查询实例的后台任务列表。

去调试

查询后台任务管理中的指定记录

hcloud Kafka ShowBackgroundTask

查询后台任务管理中的指定记录。

去调试

删除后台任务管理中的指定记录

hcloud Kafka DeleteBackgroundTask

删除后台任务管理中的指定记录。

去调试

查询实例的定时任务列表

hcloud Kafka ListScheduledTasks

查询实例的定时任务列表。

去调试

查询后台任务中的指定实例的变更进度

hcloud Kafka ShowBackgroundTaskProgress

查询后台任务中的指定实例的变更进度。

去调试

删除指定的定时任务

hcloud Kafka DeleteScheduledTask

删除指定的定时任务。仅当定时任务处于执行成功或已取消状态时，方可执行删除操作。

去调试

修改指定的定时任务

hcloud Kafka UpdateScheduledTask

修改指定的定时任务。

去调试

批量添加或删除实例标签

hcloud Kafka BatchCreateOrDeleteKafkaTag

批量添加或删除实例标签。

去调试

查询实例标签

hcloud Kafka ShowKafkaTags

查询实例标签。

去调试

查询项目标签

hcloud Kafka ShowKafkaProjectTags

查询项目标签。

去调试

消息积压诊断预检查

hcloud Kafka ShowDiagnosisPreCheck

消息积压诊断预检查。

去调试

创建消息积压诊断任务

hcloud Kafka CreateMessageDiagnosisTask

创建消息积压诊断任务。

去调试

查询消息积压诊断报告列表

hcloud Kafka ListMessageDiagnosisReports

查询消息积压诊断报告列表。

去调试

批量删除消息积压诊断报告

hcloud Kafka BatchDeleteMessageDiagnosisReports

批量删除消息积压诊断报告。

去调试

查询诊断报告详情

hcloud Kafka ShowMessageDiagnosisReport

查询诊断报告详情。

去调试

查询维护时间窗时间段

hcloud Kafka ShowMaintainWindows

查询维护时间窗开始时间和结束时间。

去调试

查询可用区信息

hcloud Kafka ListAvailableZones

在创建实例时，需要配置实例所在的可用区ID，可通过该接口查询可用区的ID。

去调试

查询产品规格列表

hcloud Kafka ListEngineProducts

查询产品规格列表。

去调试

查询实例在CES的监控层级关系

hcloud Kafka ShowCesHierarchy

查询实例在CES的监控层级关系。

去调试

查询Kafka产品规格核数

hcloud Kafka ShowKafkaProductCores

查询Kafka产品规格核数。

去调试

查询特性开关列表

hcloud Kafka ListConfigFeatures

获取特性开关列表。

去调试

查询日志任务

hcloud Kafka ShowKafkaLogTask

查询日志任务。

去调试

开启日志任务

hcloud Kafka StartKafkaLogTask

开启日志任务。

去调试

停止日志任务

hcloud Kafka StopKafkaLogTask

停止日志任务。

去调试