Updated on 2024-05-06 GMT+08:00

API Overview

Table 1 APIs for managing instances

API

Description

Lifecycle management

Create instances, modify instance information, query and delete instances, and query the broker list.

Consumer group management

Query, create, delete, and modify consumer groups, query the consumer list or details, and reset the consumer offset.

Topic management

Create, delete, query, and modify topics, query the consumer group list of a topic, and query the number of messages in a topic.

Message management

Query messages and their traces, export and resend dead letter messages, and verify consumption.

User management

Create, query, modify, and delete users, query the authorized user list of a topic, and query the authorized user list of a consumer group.

Metadata migration APIs

Create a metadata migration task, query a specified or all migration tasks of an instance, and delete a metadata migration task.

Parameter management APIs

Query and modify RocketMQ configurations.

Tag management

Add or delete tags, list tags of an instance, and list tags of a project.

Other APIs

Query AZ information.

Specification modification management APIs

Query product information for instance specification modification, and modify instance specifications.