The following tables list API operations available for use in Message Queue for Apache RocketMQ.
Region management
| Operation | Description |
|---|---|
| OnsRegionList | Queries the regions where Message Queue for Apache RocketMQ is supported. |
Service activation
| Operation | Description |
|---|---|
| OpenOnsService | Activates the Message Queue for Apache RocketMQ service. |
Instance management
| Operation | Description |
|---|---|
| OnsInstanceBaseInfo | Queries the basic information of a Message Queue for Apache RocketMQ instance and the endpoints for sending and subscribing to messages. |
| OnsInstanceCreate | Creates a Message Queue for Apache RocketMQ instance. |
| OnsInstanceDelete | Deletes a Message Queue for Apache RocketMQ instance. |
| OnsInstanceInServiceList | Queries all Message Queue for Apache RocketMQ instances in a region under the current account. |
| OnsInstanceUpdate | Updates the name and description of a Message Queue for Apache RocketMQ 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 in the current topic and the time when the topic was last updated. |
| OnsTopicUpdate | Configures the read/write mode for a specified topic. |
| OnsTopicSubDetail | Queries online consumer groups that have subscribed to a specified topic. |
Group management
| Operation | Description |
|---|---|
| OnsGroupCreate | Creates a consumer group with a specified group ID. |
| OnsGroupDelete | Deletes a consumer group that you created by calling the OnsGroupCreate operation. |
| OnsGroupList | Queries one or more consumer group IDs. This operation does not query details about each consumer group ID. |
| OnsGroupSubDetail | Queries all topics to which a consumer group with a specified group ID has subscribed. If no consumer instance in the consumer group is online, no data is found. |
| OnsGroupConsumerUpdate | Configures the permission for a consumer group with a specified group ID to read messages. |
Tag management
| Operation | Description |
|---|---|
| TagResources | Binds a tag to a resource. |
| ListTagResources | Queries the tags bound to a resource. |
| UntagResources | Unbinds and deletes a tag from a resource. |
Consumption management
| Operation | Description |
|---|---|
| OnsConsumerAccumulate | Queries the message accumulation information about a consumer group with a specified group ID, including the current number of accumulated messages and the consumption latency. |
| OnsConsumerStatus | Queries the detailed information of a consumer group with a specified group ID, including the subscriptions, consumption transactions per second (TPS), load balancing status, and consumer client connections. |
| OnsConsumerGetConnection | Queries the connection status of consumer instances in a consumer group with a specified group ID. |
| OnsConsumerResetOffset | Resets the consumer offset of a consumer group with a specified group ID to a specified timestamp. |
| OnsConsumerTimeSpan | Queries the timestamps when the topics to which a consumer group with a specified group ID has subscribed store the earliest and latest messages and the latest timestamp when consumers consume messages. |
| OnsMessagePush | Pushes a message to a specified consumer. |
Message query
| Operation | Description |
|---|---|
| OnsMessageTrace | Queries the consumption status of a message by specifying the message ID. |
| OnsMessageGetByMsgId | Queries the information about a message by specifying the message ID to determine whether the message has been consumed. The information includes properties such as the sending time, broker, message key, and message tag. |
| OnsMessageGetByKey | Queries messages by specifying the topic name and message key. |
| OnsMessagePageQueryByTopic | Queries all messages of a specified topic within a specified time range by page. |
Publishing and subscription statistics
| Operation | Description |
|---|---|
| OnsTrendTopicInputTps | Queries messages of a specified topic within a specified time range and writes the query results to a report. |
| OnsTrendGroupOutputTps | Queries the statistics on the messages consumed by a consumer group with a specified group ID within a specified time range. |
Message tracing
| Operation | Description |
|---|---|
| OnsTraceGetResult | Queries tracing results by specifying the ID of the trace query task. |
| OnsTraceQueryByMsgId | Creates a trace query task by specifying the topic name and message ID to obtain the ID of the query task. |
| OnsTraceQueryByMsgKey | Creates a trace query task by specifying the topic name and message key to obtain the ID of the query task. |
Dead-letter queues
| Operation | Description |
|---|---|
| OnsDLQMessageGetById | Queries a dead-letter message by specifying the message ID. The information includes the storage time, message body, and properties such as the message key and message tag. |
| OnsDLQMessagePageQueryByGroupId | Queries all dead-letter messages for a consumer group with a specified group ID within a specified time range by page. |
| OnsDLQMessageResendById | Resends a dead-letter message by specifying the message ID so that the message can be consumed again. |