# CLI命令参考 #### 生命周期管理 | API名称 | 命令 | 描述 | 操作 | |:---|:---|:---|:---| | 查询所有实例列表 | hcloud RocketMQ ListInstances | 查询租户的实例列表，支持按照条件查询。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=ListInstances) | | 创建实例 | hcloud RocketMQ CreateInstanceByEngine | 创建实例，该接口支持创建按需和包周期两种计费方式的实例。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=CreateInstanceByEngine) | | 查询指定实例 | hcloud RocketMQ ShowInstance | 查询指定实例的详细信息。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=ShowInstance) | | 删除指定的实例 | hcloud RocketMQ DeleteInstance | 删除指定的实例，释放该实例的所有资源。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=DeleteInstance) | | 修改实例信息 | hcloud RocketMQ UpdateInstance | 修改实例相关信息。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=UpdateInstance) | | 批量删除实例 | hcloud RocketMQ BatchDeleteInstances | 批量删除实例。**实例删除后，实例中原有的数据将被删除，且没有备份，请谨慎操作。** | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=BatchDeleteInstances) | | 查询代理列表 | hcloud RocketMQ ListBrokers | 查询代理列表。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=ListBrokers) | #### 消费组管理 | API名称 | 命令 | 描述 | 操作 | |:---|:---|:---|:---| | 查询消费组列表 | hcloud RocketMQ ListInstanceConsumerGroups | 查询消费组列表。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=ListInstanceConsumerGroups) | | 创建消费组或批量删除消费组 | hcloud RocketMQ CreateConsumerGroupOrBatchDeleteConsumerGroup | 创建消费组或批量删除消费组。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=CreateConsumerGroupOrBatchDeleteConsumerGroup) | | 批量修改消费组 | hcloud RocketMQ BatchUpdateConsumerGroup | 批量修改消费组。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=BatchUpdateConsumerGroup) | | 删除指定消费组 | hcloud RocketMQ DeleteConsumerGroup | 删除指定消费组。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=DeleteConsumerGroup) | | 查询指定消费组 | hcloud RocketMQ ShowGroup | 查询指定消费组详情。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=ShowGroup) | | 修改消费组 | hcloud RocketMQ UpdateConsumerGroup | 修改指定消费组参数。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=UpdateConsumerGroup) | | 查询消费列表或详情 | hcloud RocketMQ ShowConsumerListOrDetails | 查询消费列表或详情。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=ShowConsumerListOrDetails) | | 重置消费进度 | hcloud RocketMQ ResetConsumeOffset | 重置消费进度。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=ResetConsumeOffset) | | 查询消费者列表 | hcloud RocketMQ ShowConsumerConnections | 查询消费组内消费者列表。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=ShowConsumerConnections) | #### Topic管理 | API名称 | 命令 | 描述 | 操作 | |:---|:---|:---|:---| | 创建主题或批量删除主题 | hcloud RocketMQ CreateTopicOrBatchDeleteTopic | 创建主题或批量删除主题。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=CreateTopicOrBatchDeleteTopic) | | 查询主题列表 | hcloud RocketMQ ListRocketInstanceTopics | 该接口用于查询指定RocketMQ实例的Topic列表。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=ListRocketInstanceTopics) | | 删除指定主题 | hcloud RocketMQ DeleteTopic | 删除指定主题。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=DeleteTopic) | | 查询单个主题 | hcloud RocketMQ ShowOneTopic | 查询单个主题。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=ShowOneTopic) | | 修改主题 | hcloud RocketMQ UpdateTopic | 修改主题。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=UpdateTopic) | | 查询主题消费组列表 | hcloud RocketMQ ListConsumerGroupOfTopic | 查询主题消费组列表。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=ListConsumerGroupOfTopic) | | 查询主题的消息数 | hcloud RocketMQ ShowTopicStatus | 查询主题的消息数。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=ShowTopicStatus) | #### 消息管理 | API名称 | 命令 | 描述 | 操作 | |:---|:---|:---|:---| | 查询消息 | hcloud RocketMQ ListMessages | 查询消息。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=ListMessages) | | 发送消息 | hcloud RocketMQ SendMessage | 发送消息。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=SendMessage) | | 查询消息轨迹 | hcloud RocketMQ ListMessageTrace | 查询消息轨迹。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=ListMessageTrace) | | 重发死信消息 | hcloud RocketMQ SendDlqMessage | 重发死信消息。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=SendDlqMessage) | | 消费验证 | hcloud RocketMQ ValidateConsumedMessage | 消费验证。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=ValidateConsumedMessage) | #### 用户管理 | API名称 | 命令 | 描述 | 操作 | |:---|:---|:---|:---| | 创建用户 | hcloud RocketMQ CreateUser | 创建用户。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=CreateUser) | | 查询用户列表 | hcloud RocketMQ ListUser | 查询用户列表。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=ListUser) | | 修改用户参数 | hcloud RocketMQ UpdateUser | 修改用户参数。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=UpdateUser) | | 查询用户详情 | hcloud RocketMQ ShowUser | 查询用户详情。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=ShowUser) | | 删除用户 | hcloud RocketMQ DeleteUser | 删除用户。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=DeleteUser) | | 查询主题的授权用户列表 | hcloud RocketMQ ListTopicAccessPolicy | 查询主题的授权用户列表。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=ListTopicAccessPolicy) | | 查询消费组的授权用户列表 | hcloud RocketMQ ListConsumeGroupAccessPolicy | 查询消费组的授权用户列表。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=ListConsumeGroupAccessPolicy) | #### 元数据迁移 | API名称 | 命令 | 描述 | 操作 | |:---|:---|:---|:---| | 新建元数据迁移任务 | hcloud RocketMQ CreateRocketMqMigrationTask | 新建元数据迁移任务。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=CreateRocketMqMigrationTask) | | 查询实例下所有迁移任务或查询指定迁移任务信息 | hcloud RocketMQ ListRocketMqMigrationTask | 查询实例下所有迁移任务或查询指定迁移任务信息。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=ListRocketMqMigrationTask) | | 批量删除元数据迁移任务 | hcloud RocketMQ BatchDeleteRocketMqMigrationTask | 批量删除元数据迁移任务。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=BatchDeleteRocketMqMigrationTask) | #### 参数管理 | API名称 | 命令 | 描述 | 操作 | |:---|:---|:---|:---| | 查询RocketMQ配置 | hcloud RocketMQ ShowRocketMqConfigs | 该接口用于查询RocketMQ配置，若成功则返回配置的相关信息。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=ShowRocketMqConfigs) | | 修改RocketMQ配置 | hcloud RocketMQ UpdateRocketMqConfigs | 该接口用于修改RocketMQ配置。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=UpdateRocketMqConfigs) | #### 标签管理 | API名称 | 命令 | 描述 | 操作 | |:---|:---|:---|:---| | 批量添加或删除实例标签 | hcloud RocketMQ BatchCreateOrDeleteRocketmqTag | 批量添加或删除实例标签。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=BatchCreateOrDeleteRocketmqTag) | | 查询实例标签 | hcloud RocketMQ ShowRocketmqTags | 查询实例标签。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=ShowRocketmqTags) | | 查询项目标签 | hcloud RocketMQ ShowRocketmqProjectTags | 查询项目标签。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=ShowRocketmqProjectTags) | #### 实例诊断 | API名称 | 命令 | 描述 | 操作 | |:---|:---|:---|:---| | 创建实例诊断任务 | hcloud RocketMQ CreateDiagnosisTask | 创建实例诊断任务。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=CreateDiagnosisTask) | | 查询实例诊断报告列表 | hcloud RocketMQ ListDiagnosisReports | 查询实例诊断报告列表。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=ListDiagnosisReports) | | 批量删除实例诊断报告 | hcloud RocketMQ BatchDeleteDiagnosisRecords | 批量删除实例诊断报告。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=BatchDeleteDiagnosisRecords) | | 查询实例诊断报告 | hcloud RocketMQ ShowDiagnosisReport | 查询实例诊断报告。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=ShowDiagnosisReport) | | 查询stack信息 | hcloud RocketMQ ShowDiagnosisStack | 查询stack信息。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=ShowDiagnosisStack) | #### 规格变更管理 | API名称 | 命令 | 描述 | 操作 | |:---|:---|:---|:---| | 查询实例的扩容规格列表 | hcloud RocketMQ ShowEngineInstanceExtendProductInfo | 查询实例的扩容规格列表。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=ShowEngineInstanceExtendProductInfo) | | 实例规格变更 | hcloud RocketMQ ResizeInstance | 实例规格变更。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=ResizeInstance) | | 查询磁盘自动扩容配置 | hcloud RocketMQ ShowVolumeExpandConfig | 查询磁盘自动扩容配置，包括磁盘自动扩容是否开启，以及开启后的扩容阈值、扩容步长、扩容上限信息。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=ShowVolumeExpandConfig) | | 修改磁盘自动扩容配置 | hcloud RocketMQ UpdateVolumeExpansionConfig | 该接口用于修改磁盘自动扩容配置，包含磁盘自动扩容是否开启、扩容阈值、扩容步长，以及扩容上限的配置。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=UpdateVolumeExpansionConfig) | | 查询RocketMQ实例扩容前置检查信息 | hcloud RocketMQ ShowRocketMqScalePreCheckInfo | 获取RocketMQ实例扩容前置检查信息。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=ShowRocketMqScalePreCheckInfo) | #### 实例管理 | API名称 | 命令 | 描述 | 操作 | |:---|:---|:---|:---| | 查询实例节点 | hcloud RocketMQ ShowInstanceNodes | 查询实例节点信息。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=ShowInstanceNodes) | | 修改实例SSL相关配置 | hcloud RocketMQ ModifyInstanceSslConfig | 修改实例SSL相关配置。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=ModifyInstanceSslConfig) | | 恢复回收站实例 | hcloud RocketMQ RestoreRecycleInstance | 恢复回收站实例。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=RestoreRecycleInstance) | | 查询回收站实例列表 | hcloud RocketMQ ShowRecycleInstances | 查询回收站实例列表。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=ShowRecycleInstances) | | 更新回收站策略 | hcloud RocketMQ ModifyRecyclePolicy | 更新回收站策略。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=ModifyRecyclePolicy) | #### 后台任务管理 | API名称 | 命令 | 描述 | 操作 | |:---|:---|:---|:---| | 查询实例的后台任务列表 | hcloud RocketMQ ListBackgroundTasks | 查询实例的后台任务列表。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=ListBackgroundTasks) | | 查询后台任务管理中的指定记录 | hcloud RocketMQ ShowBackgroundTask | 查询后台任务管理中的指定记录。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=ShowBackgroundTask) | | 删除后台任务管理中的指定记录 | hcloud RocketMQ DeleteBackgroundTask | 删除后台任务管理中的指定记录。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=DeleteBackgroundTask) | | 删除定时任务管理中的指定记录 | hcloud RocketMQ DeleteScheduledTask | 删除定时任务管理中的指定记录。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=DeleteScheduledTask) | | 修改定时任务管理中的指定记录 | hcloud RocketMQ UpdateScheduledTask | 修改定时任务管理中的指定记录。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=UpdateScheduledTask) | | 查询实例的定时任务列表 | hcloud RocketMQ ListScheduledTasks | 查询实例的定时任务列表。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=ListScheduledTasks) | | 查询实例变更记录的进度 | hcloud RocketMQ ShowBackgroundTaskProgress | 查询后台任务管理中的指定实例变更记录的进度。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=ShowBackgroundTaskProgress) | #### 其他接口 | API名称 | 命令 | 描述 | 操作 | |:---|:---|:---|:---| | 查询可用区信息 | hcloud RocketMQ ListAvailableZones | 在创建实例时，需要配置实例所在的可用区ID，可通过该接口查询可用区的ID。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=ListAvailableZones) | | 查询产品规格列表 | hcloud RocketMQ ListEngineProducts | 查询相应引擎的产品规格列表。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=ListEngineProducts) | | 查询实例在CES的监控层级关系 | hcloud RocketMQ ShowCesHierarchy | 查询实例在CES的监控层级关系。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=ShowCesHierarchy) | | 获取特性开关列表 | hcloud RocketMQ ListConfigFeatures | 获取特性开关列表。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=ListConfigFeatures) | | 查询RocketMQ产品规格核数 | hcloud RocketMQ ShowRocketMqProductCores | 查询RocketMQ产品规格核数。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/cli?api=ShowRocketMqProductCores) |