Overview of API

Last updated: 2020-02-26 15:14:32

PDF

Queue model

Interface function Action ID Description
Create a queue CreateQueue Used to create a new queue under the user account.
Get queue list ListQueue It is used to list the queues under the account, and the data can be obtained by page.
Get queue properties GetQueueAttributes Used to get the properties of a created queue.
Modify queue properties SetQueueAttributes Used to modify the properties of the message queue.
Delete queue DeleteQueue Used to delete a created queue.

Interface function Action ID Description
Message sending SendMessage Used to send a message to the specified queue.
Send messages in batch BatchSendMessage Used to send batch messages to the specified queue.
Consumption message ReceiveMessage Used to consume a message in the queue.
Bulk consumption of messages BatchReceiveMessage Used to consume multiple messages in the queue.
Delete message DeleteMessage Used to delete messages that have been consumed.
Bulk delete messages BatchDeleteMessage Used to delete messages that have been consumed in batches.

Topic model

|Interface function|Action ID|Description|
|-|-|-|
|Create topic
|CreateTopic|Used to create a new topic under the user account.|
|Modify Topic Attributes|SetTopicAttributes|Used to modify the properties of a created topic.|
|Get topic list|ListTopic|It is used to list the list of topic under the account, and the data can be obtained by page.|
|Get topic attribute|GetTopicAttributes|Used to get the properties of a created topic.|
|Delete topic|DeleteTopic|Used to delete a created topic.|

|Interface function|Action ID|Description|
|-|-|-|
|Publish news
|PublishMessage|Used for publish to send a message to the designated topic.|
|Batch publish messages|BatchPublishMessage|Used for publish batch messages to the specified topic.|

|Interface function|Action ID|Description|
|-|-|-|
|Create a subscription
|Subscribe|Used to create a new subscription under the user account.|
|Get subscription list|ListSubscriptionByTopic|It is used to list the subscriptions under topic, and the data can be obtained by page.|
|Modify subscription properties|SetSubscriptionAttributes|Used to set the properties of a created subscription.|
|Get subscription properties|GetSubscriptionAttributes|Used to get the properties of a created subscription.|
|Delete Subscription|Unsubscribe|Used to delete a subscription that has been created.|