Updated on 2025-06-20 GMT+08:00

API Overview

Table 1 APIs for managing instances

API

Description

Lifecycle Management

Includes

  • Querying the Instance List
  • Creating an Instance
  • Querying an Instance
  • Deleting an Instance
  • Modifying Instance Information
  • Batch Deleting Instances
  • Querying the Broker List
  • Enabling Domain Name Access to a RocketMQ Instance

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
  • Sending a Message
  • 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
  • Querying Instance Tags
  • Querying Project Tags

Diagnosing an Instance

Includes:

  • Creating an Instance Diagnosis Task
  • Querying an Instance Diagnosis Report List
  • Deleting Instance Diagnosis Records in Batches
  • Querying an Instance Diagnosis Report
  • Querying Stack Information

Specification Modification Management

Includes:

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

Managing Instances

Includes:

  • Querying an Instance Broker
  • Restarting an Instance
  • Modifying SSL of an Instance

Managing Background Tasks

Includes:

  • Querying a Specific Record from Background Tasks
  • Deleting a Specific Record from Background Tasks
  • Querying a Background Task List of an Instance

Other APIs

Includes:

  • Querying AZ Information
  • Querying Flavor List
  • Querying vCPUs of a RocketMQ Flavor