API standards and multilingual preset SDKs
The OpenAPI of this product (RocketMQ/2022-08-01) uses the ROA signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
Instances
|
API |
Title |
Description |
| CreateTopic | CreateTopic | Creates a topic in ApsaraMQ for RocketMQ. A topic is the primary container for message transmission and storage. It is used to categorize messages that share the same business logic. In the producer-consumer model, producers send messages to topics, and consumers subscribe to these topics to consume the messages. |
| UpdateTopic | UpdateTopic | Updates the remarks for a topic. |
Topics
|
API |
Title |
Description |
| ListConsumerGroups | ListConsumerGroups | Lists the consumer groups in a specified instance. |
| GetConsumerGroup | GetConsumerGroup | Retrieves the details of a specified consumer group. |
Consumer groups
|
API |
Title |
Description |
| ListConsumerGroupSubscriptions | ListConsumerGroupSubscriptions | Lists the subscription relationships for a consumer group. |
Subscriptions
|
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. |
Consumption
|
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. |
Messages
|
API |
Title |
Description |
| CreateInstanceAccount | CreateInstanceAccount | Creates an access account for an instance. |
| UpdateInstanceAccount | UpdateInstanceAccount | Updates information for a specified account in a specified instance. |
| ListInstanceAccount | ListInstanceAccount | Retrieves the access accounts for a specified instance. |
| GetInstanceAccount | GetInstanceAccount | Retrieves the account details for a specified 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. |
Traces
|
API |
Title |
Description |
| ListMigrations | ListMigrations | Queries migration tasks. |
| ListMigrationOperations | ListMigrationOperations | Lists migration operations. |
| ExecuteMigrationOperation | ExecuteMigrationOperation | Executes a specified operation on a migration task. |
| FinishMigrationStage | FinishMigrationStage | Completes the current migration stage for a specified migration task. |
ACL
|
API |
Title |
Description |
| CreateDisasterRecoveryPlan | CreateDisasterRecoveryPlan | Create Disaster Recovery 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. |
| ListDisasterRecoveryItems | ListDisasterRecoveryItems | Queries the Global Replicator tasks of an instance. |
Cloud migration
|
API |
Title |
Description |
| GetConsumeTimespan | GetConsumeTimespan | Queries the time range in which a consumer offset can be reset for a topic. |
Global Replicator
|
API |
Title |
Description |
| AddDisasterRecoveryItem | AddDisasterRecoveryItem | Adds a topic mapping to a Global Replicator task. |
| ChangeResourceGroup | ChangeResourceGroup | Changes the resource group to which a ApsaraMQ for RocketMQ instance belongs. |
| 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. |
| CreateInstance | CreateInstance | Creates an ApsaraMQ for RocketMQ 5.x instance. |
| CreateInstanceIpWhitelist | CreateInstanceIpWhitelist | Creates an IP address whitelist. |
| DeleteConsumerGroup | DeleteConsumerGroup | Deletes a specified consumer group. |
| DeleteConsumerGroupSubscription | DeleteConsumerGroupSubscription | Deletes the subscriptions of a consumer group. |
| DeleteDisasterRecoveryItem | DeleteDisasterRecoveryItem | Deletes a topic mapping of a Global Replicator task. |
| DeleteDisasterRecoveryPlan | DeleteDisasterRecoveryPlan | Deletes a global message backup plan. |
| DeleteInstance | DeleteInstance | Releases an instance. |
| DeleteInstanceAccount | DeleteInstanceAccount | Delete access control ACL user |
| DeleteInstanceAcl | DeleteInstanceAcl | Deletes the permissions of a specific account of an instance. |
| DeleteInstanceIpWhitelist | DeleteInstanceIpWhitelist | Deletes a specific IP address whitelist from an instance. |
| DeleteTopic | DeleteTopic | Deletes a specified topic. |
| GetConsumerGroupSubscription | GetConsumerGroupSubscription | Queries the subscriptions of a consumer group. |
| GetConsumerStack | GetConsumerStack | Queries the stack information about a consumer. |
| GetDisasterRecoveryItem | GetDisasterRecoveryItem | Queries the details of a topic mapping in a Global Replicator task. |
| GetInstance | Get details of a specified instance | Retrieves the detailed information of a specified instance. |
| GetInstanceAcl | GetInstanceAcl | Queries information about the access control list (ACL) of an instance. |
| GetInstanceIpWhitelist | GetInstanceIpWhitelist | Queries the information about the IP address whitelist of an instance. |
| GetTopic | GetTopic | Retrieves the details of a specified topic. |
| GetTrace | GetTrace | Retrieves the trace of a specified message in a specified topic. |
| ListAvailableZones | ListAvailableZones | Queries the supported zones. |
| ListDisasterRecoveryCheckpoints | ListDisasterRecoveryCheckpoints | Queries consumer progress synchronization tasks. |
| ListInstanceAcl | ListInstanceAcl | Queries the access control lists (ACLs) of an instance. |
| ListInstanceIpWhitelist | ListInstanceIpWhitelist | Queries the IP address whitelists of an instance. |
| ListInstances | ListInstances | Queries the ApsaraMQ for RocketMQ instances in a specified region. |
| ListMetricMeta | ListMetricMeta | Query Monitoring Items List |
| ListRegions | ListRegions | Queries regions in which ApsaraMQ for RocketMQ is available. |
| ListTagResources | ListTagResources | Queries the tags that are added to resources. |
| ListTopicSubscriptions | ListTopicSubscriptions | Queries the subscriptions of a specific topic. |
| ListTopics | ListTopics | Queries the topics in a specified instance. |
| ListTraces | ListTraces | Queries the message traces for a specified topic. |
| 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. |
| StartDisasterRecoveryItem | StartDisasterRecoveryItem | Starts a topic mapping of a Global Replicator task. |
| StopDisasterRecoveryItem | StopDisasterRecoveryItem | Stops a topic mapping of a Global Replicator task. |
| SyncDisasterRecoveryCheckpoint | SyncDisasterRecoveryCheckpoint | Synchronize Disaster Recovery Plan Consumption Progress |
| TagResources | TagResources | Creates resource tags. |
| UntagResources | UntagResources | Removes tags from resources. |
| UpdateConsumerGroup | UpdateConsumerGroup | Updates the basic information and the consumption retry policy for a consumer group. |
| UpdateDisasterRecoveryItem | UpdateDisasterRecoveryItem | Updates a topic mapping in a global message backup plan. |
| UpdateInstance | UpdateInstance | Updating the basic information and specifications of a Message Queue for Apache RocketMQ instance. |
| VerifyConsumeMessage | VerifyConsumeMessage | Verifies the consumption status of a message in a specific topic on a specific instance. |