API Category
Last updated: 2025-12-02 11:00:57
Topic APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| DeleteTopic | Delete a topic | 20 |
| ModifyTopic | Modify topic attributes. | 20 |
| DescribeTopicList | Query a topic list | 20 |
| DescribeTopic | Query topic details | 200 |
| DescribeTopicListByGroup | Query a consumption group's subscribed topic list | 20 |
| DescribeProducerList | Query producer information list | 20 |
Consumer Group APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| CreateConsumerGroup | Create consumer groups. | 10000 |
| DeleteConsumerGroup | Delete consumer groups. | 10000 |
| ModifyConsumerGroup | Modify consumer group attributes. | 10000 |
| DescribeConsumerGroup | Query consumer group details. | 10000 |
| DescribeConsumerClient | Query consumer client details. | 20 |
| DescribeConsumerClientList | Query client connections under a consumer group list | 20 |
| ResetConsumerGroupOffset | Reset the consumption position. | 10000 |
| DescribeConsumerLag | Queries the number of heaped messages for a specified consumer group | 200 |
Message APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| DescribeMessageList | Query a message list | 20 |
| DescribeMessage | Query message details. | 20 |
| DescribeMessageTrace | Queries message trajectory | 20 |
| ResendDeadLetterMessage | Resends a dead letter message | 20 |
Role Authentication APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| CreateRole | Create a role | 20 |
| DescribeRoleList | Queries the list of roles | 20 |
| ModifyRole | Modify a role | 20 |
| DeleteRole | Deletes a role | 20 |
Hitless Migration APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| ChangeMigratingTopicToNextStage | Smooth migration: modify the Topic status during migration to go to Next step | 20 |
| DescribeMigratingTopicList | Smoothly migrate: queries a Topic migration status list | 20 |
| DescribeMigratingTopicStats | Queries real-time data of a migration topic | 50 |
| DescribeSmoothMigrationTaskList | Query a smooth migration task list | 20 |
| DescribeSourceClusterGroupList | Smooth migration: retrieves the group list of the source cluster | 20 |
| DoHealthCheckOnMigratingTopic | Queries the health check of a migration topic | 20 |
| RollbackMigratingTopicStage | Rolls back the migration progress of a topic to the previous phase | 20 |
| DeleteSmoothMigrationTask | Delete a smooth migration task | 20 |
| DescribeMigratingGroupStats | Views real-time data of a migration consumption group | 200 |
| RemoveMigratingTopic | Remove the topic being smoothly migrated | 20 |
Cloud Migration APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| DescribeMigrationTaskList | Retrieve the data migration task list | 20 |
Cluster APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| CreateInstance | Creates a cluster | 20 |
| DeleteInstance | Deleting a cluster | 20 |
| ModifyInstance | Modifying cluster attributes | 20 |
| DescribeFusionInstanceList | Query a Cluster List | 200 |
| DescribeInstanceList | Queries a 5.X cluster list | 20 |
| DescribeInstance | Query Cluster Information | 20 |
| ModifyInstanceEndpoint | Modifies a cluster access point | 20 |
| DescribeProductSKUs | Query product sales specifications | 20 |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No
Feedback