API Overview

Lifecycle Management

Includes

• Creating a Pay-per-Use Instance
• 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
• Sending a Message
• Querying the Message Trace
• 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 Metadata Migration Tasks in Batches

Parameter Management

Includes:

• Querying RocketMQ Configurations
• Modifying RocketMQ Configurations

Tag Management

Includes:

• Adding or Deleting Tags in Batches
• Querying Instance Tags
• Querying Project Tags

Instance Diagnosis

Includes:

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

Specification Modification Management

Includes:

• Querying Product Information for Instance Specification Modification
• Modifying Instance Specifications
• Querying Pre-check Information Before Expanding a RocketMQ Instance

Instance Management

Includes:

• Querying an Instance Broker
• Modifying SSL of an Instance

Background Task Management

Includes:

• Querying a Specific Record from Background Tasks
• Deleting a Specific Record from Background Tasks
• Querying a Background Task List of an Instance
• Querying the Scheduled Task List of an Instance
• Querying Progress of an Instance Change Record

Other APIs

Includes:

• Querying AZ Information
• Querying Flavor List
• Querying vCPUs of a RocketMQ Flavor
• Querying RocketMQ Instance Monitoring Dimensions
• Obtaining the Feature Switch List