This product(
RocketMQ/2022-08-01) OpenAPI adopts ROA Signature style. See signature details in Description of the signature mechanism. We have packaged SDKs for common programming languages for developers. Developers can directly call the OpenAPI of this product by downloading the SDK without paying attention to the technical details. If the existing SDK cannot meet the usage requirements, you can connect through the signature mechanism. It will take about 5 working days. Therefore, it is recommended to join our DingTalk service group (78410016550) and sign under the guidance of experts. Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (SDK, CLI, etc.). For details see getAccessKey.
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 | Queries all ApsaraMQ for RocketMQ instances in a specific region. |
| GetInstance | GetInstance | Queries the detailed information about an instance. |
Topic
| API | Title | Description |
|---|---|---|
| CreateTopic | CreateTopic | Creates a topic. |
| UpdateTopic | UpdateTopic | Updates the basic information about a topic. |
| DeleteTopic | DeleteTopic | Deletes a specified topic. |
| ListTopics | ListTopics | Queries the topics in a specified instance. |
| GetTopic | GetTopic | Queries the details of a specified topic. |
ConsumerGroup
| API | Title | Description |
|---|---|---|
| CreateConsumerGroup | CreateConsumerGroup | Creates a consumer group on an ApsaraMQ for RocketMQ instance. In ApsaraMQ for RocketMQ, a consumer group is a load balancing group that contains consumers that have the same consumption behaviors. To subscribe to messages, a consumer must specify a consumer group to subscribe to the topic to which the messages belong. |
| UpdateConsumerGroup | UpdateConsumerGroup | Updates the basic information about and the consumption retry policy of a consumer group. |
| DeleteConsumerGroup | DeleteConsumerGroup | Deletes a specified consumer group. |
| ListConsumerGroups | ListConsumerGroups | Queries the consumer groups in a specified instance. |
| GetConsumerGroup | GetConsumerGroup | Queries the details of a specified consumer group. |
| API | Title | Description |
|---|---|---|
| ListTopicSubscriptions | ListTopicSubscriptions | Queries the subscriptions of a topic. |
| DeleteConsumerGroupSubscription | DeleteConsumerGroupSubscription | Deletes the subscriptions of a consumer group. |
| ListConsumerGroupSubscriptions | ListConsumerGroupSubscriptions | Queries the subscriptions of a consumer group. |
| GetConsumerGroupSubscription | GetConsumerGroupSubscription | Queries the subscriptions of a consumer group. |
| API | Title | Description |
|---|---|---|
| ResetConsumeOffset | ResetConsumeOffset | Resets the consumer offset of a consumer group. |
| GetConsumerGroupLag | GetConsumerGroupLag | Query Consumer Group Backlog Information |
| GetConsumerStack | GetConsumerStack | Queries the stack information about a consumer. |
| ListConsumerConnections | ListConsumerConnections |
| API | Title | Description |
|---|---|---|
| VerifySendMessage | VerifySendMessage | Verifies the message sending feature of a specific topic on a specific instance. |
| VerifyConsumeMessage | VerifyConsumeMessage | Verifies the consumption status of a message in a specific topic on a specific instance. |
| ListMessages | ListMessages | Queries the list of messages. |
| GetMessageDetail | GetMessageDetail | Obtains the details of a specific message. |
| API | Title | Description |
|---|---|---|
| ListTraces | ListTraces | Queries the message traces of a specific topic. |
| GetTrace | GetTrace | Queries the trace of a specific message in a specific topic. |
| API | Title | Description |
|---|---|---|
| CreateInstanceAccount | CreateInstanceAccount | Creates an account that is used to access an instance. |
| CreateInstanceAcl | CreateInstanceAcl | Creates an access control list (ACL) in a specific instance. |
| DeleteInstanceAccount | DeleteInstanceAccount | Delete access control ACL user |
| CreateInstanceIpWhitelist | CreateInstanceIpWhitelist | Creates an IP address whitelist. |
| DeleteInstanceAcl | DeleteInstanceAcl | Deletes the permissions of a specific account of an instance. |
| DeleteInstanceIpWhitelist | DeleteInstanceIpWhitelist | Deletes a specific IP address whitelist from an instance. |
| UpdateInstanceAcl | UpdateInstanceAcl | Updates the permissions on the resources of a specific instance for a specific user. |
| UpdateInstanceAccount | UpdateInstanceAccount | Updates the information about a specific account in a specific instance. |
| ListInstanceIpWhitelist | ListInstanceIpWhitelist | Queries the IP address whitelists of an instance. |
| ListInstanceAcl | ListInstanceAcl | Queries the access control lists (ACLs) of an instance. |
| ListInstanceAccount | ListInstanceAccount | Queries the accounts that are used to access a specific instance. |
| GetInstanceAccount | GetInstanceAccount | Obtains the account used to access a specific instance. |
| API | Title | Description |
|---|---|---|
| ListTagResources | ListTagResources | Query visible resource tag relationships |
| UntagResources | UntagResources | Removes tags from resources. |
| TagResources | TagResources | Creates resource tags. |
| API | Title | Description |
|---|---|---|
| ChangeResourceGroup | ChangeResourceGroup | Changes the resource group to which a ApsaraMQ for RocketMQ instance belongs. |
Others
| API | Title | Description |
|---|---|---|
| ListRegions | ListRegions | Queries regions in which ApsaraMQ for RocketMQ is available. |
| ListAvailableZones | ListAvailableZones | Queries the supported zones. |