Updated on 2025-04-02 GMT+08:00

API Overview

Table 1 APIs for managing instances

API

Description

Lifecycle Management

Includes

  • Querying the Instance List
  • Querying an Instance
  • Deleting an Instance
  • Modifying Instance Information
  • Batch Deleting Instances
  • Querying the Broker List

Consumer Group Management

Includes:

  • Querying the Consumer Group List
  • Creating a Consumer Group or Batch Deleting Consumer Groups
  • Batch Modifying Consumer Groups
  • Deleting a Consumer Group
  • Querying a Consumer Group
  • Modifying a Consumer Group
  • Querying the Consumer Group List or Details
  • Resetting the Consumer Offset
  • Querying the Consumer List

Topic Management

Includes:

  • Creating a Topic or Deleting Topics in Batches
  • Querying the Topic List
  • Deleting a Topic
  • Querying a Topic
  • Modifying a Topic
  • Querying the Topic Consumer Group List
  • Querying the Number of Messages in a Topic

Message Management

Includes:

  • Querying Messages
  • Querying the Message Trace
  • Exporting Dead Letter Messages
  • Resending Dead Letter Messages
  • Verifying Consumption

User Management

Includes:

  • Creating a User
  • Querying the User List
  • Modifying User Parameters
  • Querying User Details
  • Deleting a User
  • Querying Users Granted Permissions for a Topic
  • Querying Users Granted Permissions for a Consumer Group

Metadata Migration

Includes:

  • Creating a Metadata Migration Task
  • Querying All Migration Tasks or a Specified Migration Task of an Instance
  • Deleting a Metadata Migration Task

Managing Parameters

Includes:

  • Querying RocketMQ Configurations
  • Modifying RocketMQ Configurations

Tag Management

Includes:

  • Adding or Deleting Tags in Batches

Other APIs

Includes: Querying AZ Information

Specification Modification Management

Includes:

  • Querying Product Information for Instance Specification Modification
  • Modifying Instance Specifications