CLI Command Reference

Querying the Instance List

hcloud RocketMQ ListInstances

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

Go debug

Creating an Instance

hcloud RocketMQ CreateInstanceByEngine

This API is used to create an instance, and pay-per-use and yearly/monthly billing modes are supported.

Go debug

Querying an Instance

hcloud RocketMQ ShowInstance

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

Go debug

Deleting an Instance

hcloud RocketMQ DeleteInstance

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

Go debug

Modifying Instance Information

hcloud RocketMQ UpdateInstance

This API is used to modify instance information.

Go debug

Batch Deleting Instances

hcloud RocketMQ BatchDeleteInstances

This API is used to delete instances in batches. Data in the instances will be deleted without any backup. Exercise caution when performing this operation.

Go debug

Querying the Broker List

hcloud RocketMQ ListBrokers

This API is used to query the list of brokers.

Go debug

Querying the Consumer Group List

hcloud RocketMQ ListInstanceConsumerGroups

This API is used to query the consumer group list.

Go debug

Creating a Consumer Group or Batch Deleting Consumer Groups

hcloud RocketMQ CreateConsumerGroupOrBatchDeleteConsumerGroup

This API is used to create a consumer group or batch deleting consumer groups.

Go debug

Batch Modifying Consumer Groups

hcloud RocketMQ BatchUpdateConsumerGroup

This API is used to modify consumer groups in batches.

Go debug

Deleting a Consumer Group

hcloud RocketMQ DeleteConsumerGroup

This API is used to delete a specified consumer group.

Go debug

Querying a Consumer Group

hcloud RocketMQ ShowGroup

This API is used to query details about a specified consumer group.

Go debug

Modifying a Consumer Group

hcloud RocketMQ UpdateConsumerGroup

This API is used to modify parameters of a specified consumer group.

Go debug

Querying the Consumer Group List or Details

hcloud RocketMQ ShowConsumerListOrDetails

This API is used to query the consumer group list or details.

Go debug

Resetting the Consumer Offset

hcloud RocketMQ ResetConsumeOffset

This API is used to reset the consumer offset.

Go debug

Querying the Consumer List

hcloud RocketMQ ShowConsumerConnections

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

Go debug

Creating a Topic or Deleting Topics in Batches

hcloud RocketMQ CreateTopicOrBatchDeleteTopic

This API is used to create a topic or delete topics in batches.

Go debug

Querying the Topic List

hcloud RocketMQ ListRocketInstanceTopics

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

Go debug

Deleting a Topic

hcloud RocketMQ DeleteTopic

This API is used to delete a specified topic.

Go debug

Querying a Topic

hcloud RocketMQ ShowOneTopic

This API is used to query a topic.

Go debug

Modifying a Topic

hcloud RocketMQ UpdateTopic

This API is used to modify a topic.

Go debug

Querying the Topic Consumer Group List

hcloud RocketMQ ListConsumerGroupOfTopic

This API is used to query the topic consumer group list.

Go debug

Querying the Number of Messages in a Topic

hcloud RocketMQ ShowTopicStatus

This API is used to query the number of messages in a topic.

Go debug

Querying Messages

hcloud RocketMQ ListMessages

This API is used to query messages.

Go debug

Sending a Message

hcloud RocketMQ SendMessage

This API is used to send a message.

Go debug

Querying the Message Trace

hcloud RocketMQ ListMessageTrace

This API is used to query the message trace.

Go debug

Resending Dead Letter Messages

hcloud RocketMQ SendDlqMessage

Resending dead letter messages

Go debug

Verifying Consumption

hcloud RocketMQ ValidateConsumedMessage

This API is used to verify consumption.

Go debug

Creating a User

hcloud RocketMQ CreateUser

This API is used to create a user.

Go debug

Querying the User List

hcloud RocketMQ ListUser

This API is used to query the user list.

Go debug

Modifying User Parameters

hcloud RocketMQ UpdateUser

This API is used to modify user parameters.

Go debug

Querying User Details

hcloud RocketMQ ShowUser

This API is used to query user details.

Go debug

Deleting a User

hcloud RocketMQ DeleteUser

This API is used to delete a user.

Go debug

Querying Users Granted Permissions for a Topic

hcloud RocketMQ ListTopicAccessPolicy

This API is used to query the list of users that have been granted permissions for a topic.

Go debug

Querying Users Granted Permissions for a Consumer Group

hcloud RocketMQ ListConsumeGroupAccessPolicy

This API is used to query the list of users granted permissions for a consumer group.

Go debug

Creating a Metadata Migration Task

hcloud RocketMQ CreateRocketMqMigrationTask

This API is used to create a metadata migration task.

Go debug

Querying All Migration Tasks or a Specified Migration Task of an Instance

hcloud RocketMQ ListRocketMqMigrationTask

This API is used to query all migration tasks or a specified migration task of an instance.

Go debug

Deleting Metadata Migration Tasks in Batches

hcloud RocketMQ BatchDeleteRocketMqMigrationTask

This API is used to delete metadata migration tasks in batches.

Go debug

Querying RocketMQ Configurations

hcloud RocketMQ ShowRocketMqConfigs

This API is used to query RocketMQ configurations. Configuration details will be returned.

Go debug

Modifying RocketMQ Configurations

hcloud RocketMQ UpdateRocketMqConfigs

This API is used to modify RocketMQ configurations.

Go debug

Adding or Deleting Instance Tags in Batches

hcloud RocketMQ BatchCreateOrDeleteRocketmqTag

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

Go debug

Querying Instance Tags

hcloud RocketMQ ShowRocketmqTags

This API is used to query instance tags.

Go debug

Querying Project Tags

hcloud RocketMQ ShowRocketmqProjectTags

This API is used to query tags of a project.

Go debug

Creating an Instance Diagnosis Task

hcloud RocketMQ CreateDiagnosisTask

This API is used to create an instance diagnosis task.

Go debug

Querying an Instance Diagnosis Report List

hcloud RocketMQ ListDiagnosisReports

This API is used to query an instance diagnosis report list.

Go debug

Deleting Instance Diagnosis Reports in Batches

hcloud RocketMQ BatchDeleteDiagnosisRecords

This API is used to delete diagnosis reports of an instance in batches.

Go debug

Querying an Instance Diagnosis Report

hcloud RocketMQ ShowDiagnosisReport

This API is used to query an instance diagnosis report.

Go debug

Querying Stack Information

hcloud RocketMQ ShowDiagnosisStack

This API is used to query stack information.

Go debug

Querying Product Information for Instance Specification Modification

hcloud RocketMQ ShowEngineInstanceExtendProductInfo

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

Go debug

Modifying Instance Specifications

hcloud RocketMQ ResizeInstance

This API is used to change instance specifications.

Go debug

Querying the Automatic Disk Storage Expansion Configuration

hcloud RocketMQ 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 RocketMQ 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

Querying Pre-check Information Before Expanding a RocketMQ Instance

hcloud RocketMQ ShowRocketMqScalePreCheckInfo

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

Go debug

Querying an Instance Broker

hcloud RocketMQ ShowInstanceNodes

This APi is used to query instance broker information.

Go debug

Modifying SSL of an Instance

hcloud RocketMQ ModifyInstanceSslConfig

This API is used to modify the SSL configuration of an instance.

Go debug

Restoring Instances from the Recycle Bin

hcloud RocketMQ RestoreRecycleInstance

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

Go debug

Querying the Recycle Bin Instance List

hcloud RocketMQ ShowRecycleInstances

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

Go debug

Updating the Recycle Bin Policy

hcloud RocketMQ ModifyRecyclePolicy

This API is used to update the recycle bin policy.

Go debug

Querying a Background Task List of an Instance

hcloud RocketMQ ListBackgroundTasks

This API is used to query a background task list of an instance.

Go debug

Querying a Specific Record from Background Tasks

hcloud RocketMQ ShowBackgroundTask

This API is used to query a specific record from background tasks.

Go debug

Deleting a Specific Record from Background Tasks

hcloud RocketMQ DeleteBackgroundTask

This API is used to delete a specific record from background tasks.

Go debug

Deleting Specified Records in Scheduled Task Management

hcloud RocketMQ DeleteScheduledTask

This API is used to delete specified records in scheduled task management.

Go debug

Modifying Specified Records in Scheduled Task Management

hcloud RocketMQ UpdateScheduledTask

This API is used to modify specified records in scheduled task management.

Go debug

Querying the Scheduled Task List of an Instance

hcloud RocketMQ ListScheduledTasks

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

Go debug

Querying Progress of an Instance Change Record

hcloud RocketMQ ShowBackgroundTaskProgress

Querying Progress of a Specified Instance Change Record in Background Task Management

Go debug

Querying AZ Information

hcloud RocketMQ ListAvailableZones

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

Go debug

Querying Flavor List

hcloud RocketMQ ListEngineProducts

This API is used to query the flavor list of an engine.

Go debug

Querying Instance Monitoring Dimensions

hcloud RocketMQ ShowCesHierarchy

This API is used to query instance monitoring dimensions.

Go debug

Obtaining the Feature Switch List

hcloud RocketMQ ListConfigFeatures

This API is used to obtain the feature switch list.

Go debug

Querying vCPUs of a RocketMQ Flavor

hcloud RocketMQ ShowRocketMqProductCores

This API is used to query the number of cores of a RocketMQ flavor.

Go debug