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 | Create Topic |
| UpdateTopic | UpdateTopic | Update Topic |
| DeleteTopic | DeleteTopic | Deletes a specified topic. |
| ListTopics | ListTopics | Query Topic List |
| GetTopic | GetTopic | Query Topic Details |
ConsumerGroup
| API | Title | Description |
|---|---|---|
| CreateConsumerGroup | CreateConsumerGroup | Creates a consumer group. |
| UpdateConsumerGroup | UpdateConsumerGroup | Update ConsumerGroup |
| DeleteConsumerGroup | DeleteConsumerGroup | Deletes a specified consumer group. |
| ListConsumerGroups | ListConsumerGroups | List Consumer Groups |
| GetConsumerGroup | GetConsumerGroup | Queries the details of a specified consumer group. |
Subscription Relationship
| API | Title | Description |
|---|---|---|
| ListTopicSubscriptions | ListTopicSubscriptions | Queries the subscriptions of a specific topic. |
| ListConsumerGroupSubscriptions | ListConsumerGroupSubscriptions | Queries the subscriptions of a specific consumer group. |
| GetConsumerGroupSubscription | GetConsumerGroupSubscription | Queries the subscriptions of a consumer group. |
| DeleteConsumerGroupSubscription | DeleteConsumerGroupSubscription | Deletes the subscriptions of a consumer group. |
Consumption
| API | Title | Description |
|---|---|---|
| ListConsumerConnections | ListConsumerConnections | Queries the connections of a specific consumer client. |
| GetConsumerGroupLag | GetConsumerGroupLag | Query Consumer Group Backlog Information |
| 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. |
Message
| API | Title | Description |
|---|---|---|
| ListMessages | ListMessages | Queries messages. |
| GetMessageDetail | GetMessageDetail | Obtains the details of a specific message. |
| 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. |
Trajectory
| 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. |
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. |
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 | Query Disaster Recovery Plan List |
| GetDisasterRecoveryPlan | GetDisasterRecoveryPlan | |
| AddDisasterRecoveryItem | AddDisasterRecoveryItem | Add Disaster Recovery Plan Entry |
| UpdateDisasterRecoveryItem | UpdateDisasterRecoveryItem | Updates a topic mapping in a global message backup plan. |
| DeleteDisasterRecoveryItem | DeleteDisasterRecoveryItem | |
| StartDisasterRecoveryItem | StartDisasterRecoveryItem | Enable Disaster Recovery Plan Entry |
| StopDisasterRecoveryItem | StopDisasterRecoveryItem | Deactivate Disaster Recovery Plan Entry |
| ListDisasterRecoveryItems | ListDisasterRecoveryItems | Query Disaster Recovery Plan Entry List |
| GetDisasterRecoveryItem | GetDisasterRecoveryItem | |
| ListDisasterRecoveryCheckpoints | ListDisasterRecoveryCheckpoints | Query disaster recovery plan consumption progress information |
| SyncDisasterRecoveryCheckpoint | SyncDisasterRecoveryCheckpoint | Synchronize Disaster Recovery Plan Consumption Progress |
Label
| 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 Group
| 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. |
| ListMetricMeta | ListMetricMeta | Query Monitoring Items List |