API standard and pre-built SDKs in multi-language
The OpenAPI specification of this product (RocketMQ/2022-08-01) follows the ROA standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.
Custom signature
If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. Create a Resource Access Management (RAM) user with API-only access and use RAM policies to apply the principle of least privilege (PoLP). Alibaba Cloud accounts are only used when explicitly required.
To call APIs securely, configure the following:
A RAM user account
An AccessKey pair for the account
Instance
|
API |
Title |
Description |
| CreateInstance | CreateInstance | Creates an ApsaraMQ for RocketMQ 5.x instance. |
| UpdateInstance | UpdateInstance | Updates the basic information and specifications of an ApsaraMQ for RocketMQ instance. |
| DeleteInstance | DeleteInstance | Releases an instance. |
| ListInstances | ListInstances | Lists all ApsaraMQ for RocketMQ instances in a specified region. |
| GetInstance | GetInstance | Retrieves the details of a specified instance. |
Subject
|
API |
Title |
Description |
| CreateTopic | CreateTopic | Creates a topic in ApsaraMQ for RocketMQ. A topic is a top-level container for message transmission and storage. It identifies messages that belong to the same business logic. In the message model, producers send messages to a topic, and consumers subscribe to the topic to consume the messages. |
| UpdateTopic | UpdateTopic | Updates the remarks for a topic. |
| DeleteTopic | DeleteTopic | Deletes a specified topic. |
| ListTopics | ListTopics | Queries the topics in a specified instance. |
| GetTopic | GetTopic | Retrieves details about a specified topic. |
Consumer groups
|
API |
Title |
Description |
| CreateConsumerGroup | CreateConsumerGroup | Creates a consumer group for ApsaraMQ for RocketMQ. A consumer group is a load balancing group that contains multiple consumers with the same consumption behavior. Consumers must specify a consumer group and the relevant topics to subscribe to messages. |
| UpdateConsumerGroup | UpdateConsumerGroup | Update ConsumerGroup |
| DeleteConsumerGroup | DeleteConsumerGroup | Deletes a specified consumer group. |
| ListConsumerGroups | ListConsumerGroups | Lists the consumer groups in a specified instance. |
| GetConsumerGroup | GetConsumerGroup | Retrieves the details of a specified consumer group. |
Subscription Relationships
|
API |
Title |
Description |
| ListTopicSubscriptions | ListTopicSubscriptions | Queries the subscriptions of a specific topic. |
| ListConsumerGroupSubscriptions | ListConsumerGroupSubscriptions | Lists the subscription relationships for a consumer group. |
| GetConsumerGroupSubscription | GetConsumerGroupSubscription | Queries the subscriptions of a consumer group. |
| DeleteConsumerGroupSubscription | DeleteConsumerGroupSubscription | Deletes the subscriptions of a consumer group. |
Usage
|
API |
Title |
Description |
| ListConsumerConnections | ListConsumerConnections | Retrieves the connection information for clients in a specified consumer group. |
| GetConsumerGroupLag | GetConsumerGroupLag | Queries the message accumulation of a consumer group. |
| GetConsumerStack | GetConsumerStack | Queries the stack information about a consumer. |
| ResetConsumeOffset | ResetConsumeOffset | Resets the consumer offset of a consumer group. If you reset a consumer offset, the offset from which a consumer starts to consume messages is changed. If faults occur or wrong messages are consumed during message consumption, you can reset the consumer offset to roll back the consumption to a specific offset for reconsumption. You can also reset the consumer offset to the latest offset and temporarily leave the accumulated messages unhandled. |
Messages
|
API |
Title |
Description |
| ListMessages | ListMessages | Queries a list of messages. |
| GetMessageDetail | GetMessageDetail | Retrieves the details of a specific message. |
| VerifySendMessage | VerifySendMessage | Tests whether messages can be sent to a specified topic in an instance. |
| VerifyConsumeMessage | VerifyConsumeMessage | Verifies the consumption status of a message in a specific topic on a specific instance. |
Trail
|
API |
Title |
Description |
| ListTraces | ListTraces | Queries the message traces for a specified topic. |
| GetTrace | GetTrace | Retrieves the trace of a specified message in a specified topic. |
Access control list (ACL)
|
API |
Title |
Description |
| CreateInstanceAccount | CreateInstanceAccount | Creates an account that is used to access an instance. |
| UpdateInstanceAccount | UpdateInstanceAccount | Updates the information about a specific account in a specific instance. |
| DeleteInstanceAccount | DeleteInstanceAccount | Delete access control ACL user |
| ListInstanceAccount | ListInstanceAccount | Queries the accounts that are used to access a specific instance. |
| GetInstanceAccount | GetInstanceAccount | Obtains the account used to access a specific instance. |
| CreateInstanceAcl | CreateInstanceAcl | Creates an access control list (ACL) in a specific instance. |
| UpdateInstanceAcl | UpdateInstanceAcl | Updates the permissions on the resources of a specific instance for a specific user. |
| DeleteInstanceAcl | DeleteInstanceAcl | Deletes the permissions of a specific account of an instance. |
| ListInstanceAcl | ListInstanceAcl | Queries the access control lists (ACLs) of an instance. |
| GetInstanceAcl | GetInstanceAcl | Queries information about the access control list (ACL) of an instance. |
| CreateInstanceIpWhitelist | CreateInstanceIpWhitelist | Creates an IP address whitelist. |
| DeleteInstanceIpWhitelist | DeleteInstanceIpWhitelist | Deletes a specific IP address whitelist from an instance. |
| ListInstanceIpWhitelist | ListInstanceIpWhitelist | Queries the IP address whitelists of an instance. |
| GetInstanceIpWhitelist | GetInstanceIpWhitelist | Queries the information about the IP address whitelist of an instance. |
Cloud migration
|
API |
Title |
Description |
| ListMigrationOperations | ListMigrationOperations | Queries a list of migration operations. |
| ExecuteMigrationOperation | ExecuteMigrationOperation | Executes a specified operation on a migration task. |
| FinishMigrationStage | FinishMigrationStage | Completes the current migration stage for a specified migration task. |
Global Replicator
|
API |
Title |
Description |
| CreateDisasterRecoveryPlan | CreateDisasterRecoveryPlan | Create Disaster Recovery Plan |
| DeleteDisasterRecoveryPlan | DeleteDisasterRecoveryPlan | Deletes a global message backup plan. |
| UpdateDisasterRecoveryPlan | UpdateDisasterRecoveryPlan | Modifies a global message backup plan. |
| ListDisasterRecoveryPlans | ListDisasterRecoveryPlans | Queries Global Replicator tasks. |
| GetDisasterRecoveryPlan | GetDisasterRecoveryPlan | Queries the details of a Global Replicator task. |
| AddDisasterRecoveryItem | AddDisasterRecoveryItem | Adds a topic mapping to a Global Replicator task. |
| UpdateDisasterRecoveryItem | UpdateDisasterRecoveryItem | Updates a topic mapping in a global message backup plan. |
| DeleteDisasterRecoveryItem | DeleteDisasterRecoveryItem | Deletes a topic mapping of a Global Replicator task. |
| StartDisasterRecoveryItem | StartDisasterRecoveryItem | Starts a topic mapping of a Global Replicator task. |
| StopDisasterRecoveryItem | StopDisasterRecoveryItem | Stops a topic mapping of a Global Replicator task. |
| ListDisasterRecoveryItems | ListDisasterRecoveryItems | Queries the Global Replicator tasks of an instance. |
| GetDisasterRecoveryItem | GetDisasterRecoveryItem | Queries the details of a topic mapping in a Global Replicator task. |
| ListDisasterRecoveryCheckpoints | ListDisasterRecoveryCheckpoints | Queries consumer progress synchronization tasks. |
| SyncDisasterRecoveryCheckpoint | SyncDisasterRecoveryCheckpoint | Synchronize Disaster Recovery Plan Consumption Progress |
Tags
|
API |
Title |
Description |
| ListTagResources | ListTagResources | Queries the tags that are added to resources. |
| TagResources | TagResources | Creates resource tags. |
| UntagResources | UntagResources | Removes tags from resources. |
Resource groups
|
API |
Title |
Description |
| ChangeResourceGroup | ChangeResourceGroup | Changes the resource group to which a ApsaraMQ for RocketMQ instance belongs. |
Other
|
API |
Title |
Description |
| GetConsumeTimespan | GetConsumeTimespan | Queries the time range in which a consumer offset can be reset for a topic. |
| ListRegions | ListRegions | Queries regions in which ApsaraMQ for RocketMQ is available. |
| ListAvailableZones | ListAvailableZones | Queries the supported zones. |
| ListMetricMeta | ListMetricMeta | Query Monitoring Items List |
Others
|
API |
Title |
Description |
| ListMigrations | ListMigrations | Queries migration tasks. |