CLI Command Reference

Creating a Kafka Instance

hcloud Kafka CreatePostPaidKafkaInstance

This API is used to create an instance.

Go debug

Listing All Instances

hcloud Kafka ListInstances

This API is used to query the instances of an account by the specified conditions.

Go debug

Querying an Instance

hcloud Kafka ShowInstance

This API is used to query the details about a specified instance.

Go debug

Deleting an Instance

hcloud Kafka DeleteInstance

This API is used to delete an instance to release all the resources occupied by it.

Go debug

Modifying Instance Information

hcloud Kafka UpdateInstance

This API is used to modify the instance information.

Go debug

Batch Restarting or Deleting Instances

hcloud Kafka BatchRestartOrDeleteInstances

This API is used to restart or delete instances in batches.

Go debug

Obtaining Instance Configurations

hcloud Kafka ShowInstanceConfigs

This API is used to obtain instance configurations.

Go debug

Modifying Instance Configurations

hcloud Kafka ModifyInstanceConfigs

This API is used to modify instance configurations.

Go debug

Upgrading an Instance

hcloud Kafka UpgradeInstance

This API is used to upgrading the kernel of an instance.

Go debug

Querying the Kafka Instance Version

hcloud Kafka ShowUpgradeInstanceVersion

This API is used to query the Kafka instance version information.

Go debug

Resetting the Password

hcloud Kafka ResetPassword

This API is used to reset the password for an instance with SSL enabled.

Go debug

Resetting Kafka Manager Password

hcloud Kafka ResetManagerPassword

This API is used to reset the Kafka Manager password.

Go debug

Restarting Kafka Manager

hcloud Kafka RestartManager

This API is used to restart Kafka Manager.

Go debug

Modifying the Private IP Address for Cross-VPC Access

hcloud Kafka UpdateInstanceCrossVpcIp

This API is used to modify the private IP address for cross-VPC access.

Go debug

Querying Kafka Cluster Metadata

hcloud Kafka ShowCluster

This API is used to query Kafka cluster metadata.

Go debug

Querying Coordinator Details of a Kafka Instance

hcloud Kafka ShowCoordinators

This API is used to query coordinator details of a Kafka instance.

Go debug

Modifying Kafka Access Modes

hcloud Kafka UpdateKafkaPortProtocol

This API is used to modify private or public access for Kafka.

Go debug

Querying the Disk Storage Status of Topics

hcloud Kafka ShowKafkaTopicPartitionDiskusage

This API is used to query the disk usage of topics on brokers.

Go debug

Restoring Instances from the Recycle Bin

hcloud Kafka RestoreRecycleInstance

This API is used to restore instances from the recycle bin.

Go debug

Querying the Recycle Bin Instance List

hcloud Kafka ShowRecycleInstances

This API is used to query the recycle bin instance list.

Go debug

Updating the Recycle Bin Policy

hcloud Kafka ModifyRecyclePolicy

This API is used to update the recycle bin policy.

Go debug

Disabling Kafka Manager

hcloud Kafka CloseKafkaManager

This API is used to disable Kafka Manager. After Kafka Manager is disabled, the related management APIs will become unavailable.

Go debug

Querying Kafka Instance Rebalancing Log Details

hcloud Kafka ShowKafkaRebalanceLog

This API is used to query rebalancing log details of a Kafka instance.

Go debug

Enabling Kafka Instance Rebalancing Logging

hcloud Kafka CreateKafkaRebalanceLogTask

This API is used to enable Kafka instance rebalancing logging.

Go debug

Disabling Kafka Instance Rebalancing Logging

hcloud Kafka StopKafkaRebalanceLogTask

This API is used to disable Kafka instance rebalancing logging.

Go debug

Configuring Public Access to a Kafka Instance

hcloud Kafka ModifyKafkaPublicIpAccessSwitch

This API is used to enable or disable public access to a Kafka instance.

Go debug

Querying Kafka Cluster Information

hcloud Kafka ShowKafkaCluster

This API is used to query Kafka cluster information.

Go debug

Querying Resource Information Required for Enabling Smart Connect

hcloud Kafka ShowConnectorResourceInfo

This API is used to query resources to be used for enabling Smart Connect.

Go debug

Enabling Smart Connect (Pay-per-Use Instance)

hcloud Kafka CreateConnector

This API is used to enable Smart Connect so you can create a connector.

Go debug

Disabling Smart Connect (Pay-per-Use Instance)

hcloud Kafka DeleteConnector

This API is used to disable Smart Connect for a pay-per-use instance.

Go debug

Creating a Smart Connect Task

hcloud Kafka CreateConnectorTask

This API is used to create a Smart Connect task.

Go debug

Querying Smart Connect Tasks

hcloud Kafka ListConnectorTasks

This API is used to query Smart Connect tasks.

Go debug

Querying Smart Connect Task Details

hcloud Kafka ShowConnectorTask

This API is used to query details about a Smart Connect task.

Go debug

Deleting a Smart Connect Task

hcloud Kafka DeleteConnectorTask

This API is used to delete a Smart Connect task.

Go debug

Modifying the Configuration of a Smart Connect Task

hcloud Kafka ModifyConnectorTask

This API is used to modify the Smart Connect task configuration.

Go debug

Verifying Connector Connectivity

hcloud Kafka ValidateConnectorConnectivity

This API is used to verify the connector connectivity.

Go debug

Pausing a Smart Connect Task

hcloud Kafka PauseConnectorTask

This API is used to pause a Smart Connect task.

Go debug

Restarting a Smart Connect Task

hcloud Kafka ResumeConnectorTask

This API is used to restart a Smart Connect task.

Go debug

Starting a Smart Connect Task or Restarting a Paused or Running Smart Connect Task

hcloud Kafka RestartConnectorTask

This API is used to start a Smart Connect task or restart a paused or running Smart Connect task. Note that the sync progress will reset and the task will restart.

Go debug

Querying the OBS Bucket List

hcloud Kafka ListObsBuckets

This API is used to query the list of OBS buckets.

Go debug

Increasing Instance Specifications

hcloud Kafka ResizeKafkaInstance

This API is used to modify instance specifications. Currently, this API can be only used to increase the specifications of pay-per-use instances.

Go debug

Querying Product Information for Instance Specification Modification

hcloud Kafka ShowKafkaInstanceExtendProductInfo

This API is used to query the product information for instance specification modification.

Go debug

Querying the Automatic Disk Storage Expansion Configuration

hcloud Kafka ShowVolumeExpandConfig

This API is used to query the automatic disk storage expansion configuration covering whether this feature is enabled, the threshold, increase, and upper limit.

Go debug

Modifying the Automatic Disk Storage Expansion Configuration

hcloud Kafka UpdateVolumeExpansionConfig

This API is used to modify the automatic disk storage expansion configuration covering whether this feature is enabled, the threshold, increase, and upper limit.

Go debug

Obtaining Pre-check Information Before Expanding a Kafka Instance

hcloud Kafka ShowKafkaScalePreCheckInfo

This API is used to obtain pre-check information before expanding a Kafka instance.

Go debug

Configuring Automatic Topic Creation

hcloud Kafka UpdateInstanceAutoCreateTopic

This API is used to configure automatic topic creation.

Go debug

Producing Messages to Kafka

hcloud Kafka SendKafkaMessage

This API is used to send specific messages to a Kafka instance on the console.

Go debug

Creating a Topic for a Kafka Instance

hcloud Kafka CreateInstanceTopic

This API is used to create a topic for a Kafka instance.

Go debug

Listing Topics of a Kafka Instance

hcloud Kafka ListInstanceTopics

This API is used to query details about topics of a Kafka instance.

Go debug

Modifying Topics of a Kafka Instance

hcloud Kafka UpdateInstanceTopic

This API is used to modify topics of a Kafka instance.

Go debug

Obtaining Kafka Topic Details

hcloud Kafka ShowKafkaTopicDetail

This API is used to obtain Kafka topic details.

Go debug

Batch Deleting Topics of a Kafka Instance

hcloud Kafka BatchDeleteInstanceTopic

This API is used to delete multiple topics of a Kafka instance in batches. If some topics are deleted successfully while some fail to be deleted, a success response is returned with information about topics that fail to be deleted.

Go debug

Querying the Partition List of a Topic

hcloud Kafka ListTopicPartitions

This API is used to query the partition list of a topic.

Go debug

Querying the Current Producer List of a Topic

hcloud Kafka ListTopicProducers

This API is used to query the current producer list of a topic.

Go debug

Deleting a Topic Quota

hcloud Kafka DeleteKafkaTopicQuota

This API is used to submit a topic-level quota deletion task to a Kafka instance. If the task is successfully submitted, a job ID of the quota task is returned.

Go debug

Creating a Topic Quota

hcloud Kafka CreateKafkaTopicQuota

This API is used to submit a topic-level quota creation task to a Kafka instance. If the task is successfully submitted, a job ID of the quota task is returned.

Go debug

Modifying a Topic Quota

hcloud Kafka ModifyKafkaTopicQuota

This API is used to submit a topic-level quota modification task to a Kafka instance. If the task is successfully submitted, a job ID of the quota task is returned.

Go debug

Querying a Topic Quota

hcloud Kafka ShowKafkaTopicQuota

This API is used to query a topic-level quota task.

Go debug

Initiating Partition Reassignment for a Kafka Instance

hcloud Kafka CreateKafkaReassignmentTask

This API is used to submit a partition reassignment task for a Kafka instance. If the task is successfully submitted, its job ID is returned.

Go debug

Querying Consumer Group Details

hcloud Kafka ShowGroups

This API is used to query consumer group details.

Go debug

Resetting Consumer Group Offset to the Specified Position

hcloud Kafka ResetMessageOffsetWithEngine

Kafka instances do not support resetting the consumer offset online. Before resetting, stop the client for which the offset is to be reset. After a client is stopped, the server considers the client offline only after the time period specified in ConsumerConfig.SESSION_TIMEOUT_MS_CONFIG (1000 ms by default).

Go debug

Querying All Consumer Groups

hcloud Kafka ListInstanceConsumerGroups

This API is used to query all consumer groups.

Go debug

Deleting Consumer Groups of a Kafka Instance in Batches

hcloud Kafka BatchDeleteGroup

This API is used to delete multiple consumer groups of a Kafka instance in batches.

Go debug

Creating a Consumer Group

hcloud Kafka CreateKafkaConsumerGroup

This API is used to create a consumer group.

Go debug

Querying the Offset of a Consumer Group

hcloud Kafka ListInstanceConsumerGroupMessageOffset

This API is used to query the offset of a consumer group.

Go debug

Modifying All Consumer Groups

hcloud Kafka UpdateInstanceGroup

This API is used to modify all consumer groups.

Go debug

Querying a Specified Consumer Group

hcloud Kafka ListInstanceConsumerGroup

This API is used to query a specified consumer group.

Go debug

Deleting a Specified Consumer Group

hcloud Kafka DeleteInstanceConsumerGroup

This API is used to delete a specified consumer group.

Go debug

Modifying a Specified Consumer Group

hcloud Kafka UpdateInstanceConsumerGroup

This API is used to modify a specified consumer group.

Go debug

Querying Topics of a Specified Consumer Group

hcloud Kafka ListInstanceConsumerGroupTopics

This API is used to query topics of a specified consumer group.

Go debug

Deleting Consumer Offset in a Specified Topic

hcloud Kafka DeleteConsumerGroupOffsets

This API is used to delete consumer offset in a specified topic.

Go debug

Querying Consumers in a Specified Consumer Group

hcloud Kafka ListInstanceConsumerGroupMembers

This API is used to query consumers in a specified consumer group.

Go debug

Deleting a User or Client Quota

hcloud Kafka DeleteKafkaUserClientQuotaTask

This API is used to submit a task of deleting a user or client quota from a Kafka instance. A job_id is returned if the task succeeds.

Go debug

Querying User or Client Quotas

hcloud Kafka ShowKafkaUserClientQuota

This API is used to query quotas of a Kafka instance. A list of quotas is returned if the query succeeds.

Go debug

Creating User or Client Quotas

hcloud Kafka CreateKafkaUserClientQuotaTask

This API is used to submit a task to create user or client quotas for a Kafka instance. A job_id is returned if the task succeeds.

Go debug

Modifying User or Client Quotas

hcloud Kafka UpdateKafkaUserClientQuotaTask

This API is used to submit a task to modify user or client quotas of a Kafka instance. A job_id is returned if the task succeeds.

Go debug

Querying the User List

hcloud Kafka ShowInstanceUsers

This API is used to query the user list.

Go debug

Creating a User

hcloud Kafka CreateInstanceUser

This API is used to create a user for a Kafka instance for which SASL is enabled. For Kafka instances created before July 15, 2023, a maximum of 20 users can be created for each instance. For Kafka instances created since July 15, 2023, a maximum of 500 users can be created for each instance.

Go debug

Deleting Users in Batches

hcloud Kafka BatchDeleteInstanceUsers

This API is used to delete multiple users of a Kafka instance.

Go debug

Resetting a User Password

hcloud Kafka ResetUserPasswrod

This API is used to reset a user password.

Go debug

Modifying User Parameters

hcloud Kafka UpdateInstanceUser

This API is used to modify user parameters.

Go debug

Querying User Permissions

hcloud Kafka ShowTopicAccessPolicy

This API is used to query user permissions.

Go debug

Granting User Permissions

hcloud Kafka UpdateTopicAccessPolicy

This API is used to grant user permissions.

Go debug

Querying Messages

hcloud Kafka ShowInstanceMessages

Kafka instances support two message query modes.

Go debug

Querying a Message with a Specified Offset

hcloud Kafka ShowPartitionMessage

This API is used to query a message with a specified offset.

Go debug

Querying a Message with a Specified Time Period

hcloud Kafka ShowMessages

This API is used to query a message with a specified time period.

Go debug

Querying Offset of the Earliest Message in a Partition

hcloud Kafka ShowPartitionBeginningMessage

This API is used to query the offset of the earliest message in a partition.

Go debug

Querying Offset of the Latest Message in a Partition

hcloud Kafka ShowPartitionEndMessage

This API is used to query the offset of the latest message in a partition.

Go debug

Deleting Kafka Messages

hcloud Kafka DeleteKafkaTopicMessages

This API is used to delete Kafka messages.

Go debug

Listing Background Tasks

hcloud Kafka ListBackgroundTasks

This API is used to list background tasks of an instance.

Go debug

Querying a Background Task

hcloud Kafka ShowBackgroundTask

This API is used to query a specified background task.

Go debug

Deleting a Background Task

hcloud Kafka DeleteBackgroundTask

This API is used to delete a specified background task.

Go debug

Querying the Scheduled Task List of an Instance

hcloud Kafka ListScheduledTasks

This API is used to query the scheduled task list of an instance.

Go debug

Querying the Change Progress of a Specified Instance in a Background Task

hcloud Kafka ShowBackgroundTaskProgress

This API is used to query the change progress of a specified instance in a background task.

Go debug

Deleting a Specified Scheduled Task

hcloud Kafka DeleteScheduledTask

This API is used to delete a specified scheduled task. This operation can be performed only when the scheduled task is in the successful or canceled state.

Go debug

Modifying a Specified Scheduled Task

hcloud Kafka UpdateScheduledTask

This API is used to modify a specified scheduled task.

Go debug

Batch Adding or Deleting Tags

hcloud Kafka BatchCreateOrDeleteKafkaTag

This API is used to add or delete instance tags in batches.

Go debug

Listing Tags of an Instance

hcloud Kafka ShowKafkaTags

This API is used to query instance tags.

Go debug

Listing Tags of a Project

hcloud Kafka ShowKafkaProjectTags

This API is used to query project tags.

Go debug

Pre-check Before Diagnosing Message Stack

hcloud Kafka ShowDiagnosisPreCheck

This API is used to pre-check before diagnosing message stack.

Go debug

Creating a Message Stack Diagnosis Task

hcloud Kafka CreateMessageDiagnosisTask

This API is used to create a message stack diagnosis task.

Go debug

Querying the Message Stack Diagnosis Report List

hcloud Kafka ListMessageDiagnosisReports

This API is used to query the message stack diagnosis report list.

Go debug

Batch Deleting Message Stack Diagnosis Reports

hcloud Kafka BatchDeleteMessageDiagnosisReports

This API is used to delete message stack diagnosis reports in batches.

Go debug

Querying Diagnosis Report Details

hcloud Kafka ShowMessageDiagnosisReport

This API is used to query diagnosis report details.

Go debug

Listing Maintenance Time Windows

hcloud Kafka ShowMaintainWindows

This API is used to query the start time and end time of maintenance time windows.

Go debug

Listing AZ Information

hcloud Kafka ListAvailableZones

This API is used to query the AZ ID for creating an instance.

Go debug

Querying Product Specifications List

hcloud Kafka ListEngineProducts

This API is used to query the product specifications list.

Go debug

Querying Kafka Instance Monitoring Dimensions

hcloud Kafka ShowCesHierarchy

This API is used to query Kafka instance monitoring dimensions.

Go debug

Querying vCPUs of a Kafka Flavor

hcloud Kafka ShowKafkaProductCores

This API is used to query the number of vCPUs of a Kafka flavor.

Go debug

Querying the Feature Switch List

hcloud Kafka ListConfigFeatures

This API is used to obtain the feature switch list.

Go debug

Querying a Log Task

hcloud Kafka ShowKafkaLogTask

This API is used to query a log task.

Go debug

Enabling a Log Task

hcloud Kafka StartKafkaLogTask

This API is used to enable a log task.

Go debug

Stopping a Log Task

hcloud Kafka StopKafkaLogTask

This API is used to stop a log task.

Go debug