Message Queue for Apache RocketMQ (RocketMQ) provides the following API operations.

Region management

Operation Description
OnsRegionList Obtains the regions in which RocketMQ provides services.

Instance management

Operation Description
OnsInstanceBaseInfo Queries basic information about an instance and the endpoint for sending and subscribing to messages.
OnsInstanceCreate Creates an instance.
OnsInstanceDelete Deletes an instance.
OnsInstanceInServiceList Queries all instances in a region under the current account.
OnsInstanceUpdate Updates the name and description of an instance.

Topic management

Operation Description
OnsTopicCreate Creates a topic.
OnsTopicDelete Deletes a specified topic under your account.
OnsTopicList Queries all topics under your account.
OnsTopicStatus Queries the total number of messages on the current topic and the last time when the topic was updated.
OnsTopicUpdate Configures the read and write mode of the topic.
OnsTopicSubDetail Queries the groups that have subscribed to the topic.

Group management

Operation Description
OnsGroupCreate Creates a group.
OnsGroupDelete Deletes groups that were created by the OnsGroupCreate operation.
OnsGroupList Displays your group IDs, but does not query specific information.
OnsGroupSubDetail Queries the topics that a group has subscribed to. If no consumer instance corresponding to the group ID is online, no data will be found.
OnsGroupConsumerUpdate Configures the permissions for a consumer cluster with a specified group ID to access messages.

Message management

Operation Description
OnsConsumerAccumulate Queries the message accumulation for a consumer with a specified group ID, including the current number of accumulated messages and the consumption latency.
OnsConsumerStatus Queries the detailed status data of a consumer with a specified group ID, including the subscription relationship, statistics on consumption transactions per second (TPS), load balancing status, and consumer connection.
OnsConsumerGetConnection Queries the connection of a consumer with a specified group ID.
OnsConsumerResetOffset Resets the consumption offset of a consumer with a specified group ID to the specified timestamp.
OnsConsumerTimeSpan Queries the latest message timestamp and latest consumption time of a message on a topic subscribed by a specific group ID.

Message query

Operation Description
OnsMessageTrace Checks whether a target message has been consumed based on the message ID.
OnsMessageGetByMsgId Queries a specified message based on the input message ID and identifies whether the message has been consumed. The information includes properties such as the sending time, broker, key, and tag.
OnsMessageGetByKey Performs fuzzy querying based on the input topic name and message key to obtain a list of messages that meet the conditions.
OnsMessagePageQueryByTopic Queries all messages on a topic within a specified time period by page based on the input topic name and time period.

Publishing and subscription relationship statistics

Operation Description
OnsTrendTopicInputTps Queries the messages on a specified topic within a specified time period and writes the query result into a report.
OnsTrendGroupOutputTps Queries the statistics on the messages consumed by consumers with a specified group ID.

Message tracing

Operation Description
OnsTraceGetResult Obtains the trace query result based on the input trace query job ID.
OnsTraceQueryByMsgId Creates a trace query job based on the input topic name and message ID to obtain the ID of the query job.
OnsTraceQueryByMsgKey Creates a trace query job based on the input topic name and message key to obtain the ID of the query job.

Dead-letter queues

Operation Description
OnsDLQMessageGetById Queries a specified dead-letter message based on the input message ID. The queried information about the dead-letter message includes the storage time, message body, and properties including the key and tag.
OnsDLQMessagePageQueryByGroupId Queries all dead-letter messages on consumers with a specified group ID within the specified time period by page based on the input group ID and time period.
OnsDLQMessageResendById Resends a specified dead-letter message based on the input message ID so that the message can be consumed again by a consumer.