API overview
API standard and pre-built SDKs in multi-language
The OpenAPI specification of this product (Mns-open/2022-01-19) follows the RPC standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.
Custom signature
If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. To call APIs securely, create a Resource Access Management (RAM) user with API access only, configure its AccessKey pairs, and implement the principle of least privilege (PoLP) through RAM policies. Use the Alibaba Cloud account only when its permissions are explicitly required for specific scenarios.
Topic management
|
API |
Title |
Description |
| CreateTopic | CreateTopic | You can call the CreateTopic operation to create a topic. |
| SetTopicAttributes | SetTopicAttributes | Modifies the attributes of a topic. |
| GetTopicAttributes | GetTopicAttributes | You can call the GetTopicAttributes operation to retrieve the properties of a topic. |
| DeleteTopic | DeleteTopic | Deletes a topic. |
| ListTopic | ListTopic | Queries a paginated list of topics in an Alibaba Cloud account. |
Queue management
|
API |
Title |
Description |
| CreateQueue | CreateQueue | The CreateQueue operation creates a queue. |
| SetQueueAttributes | SetQueueAttributes | Modifies a queue. |
| GetQueueAttributes | GetQueueAttributes | Retrieves the properties of an existing queue. |
| DeleteQueue | DeleteQueue | Deletes a queue. |
| ListQueue | ListQueue | You can call the ListQueue operation to list all queues in a specified Alibaba Cloud account. The results are paginated. |
Subscription management
|
API |
Title |
Description |
| Subscribe | Subscribe | Creates a subscription to a topic. |
| SetSubscriptionAttributes | SetSubscriptionAttributes | The SetSubscriptionAttributes operation modifies the properties of a subscription. |
| GetSubscriptionAttributes | GetSubscriptionAttributes | Queries the attributes of a subscription. |
| Unsubscribe | Unsubscribe | Deletes a subscription. |
| ListSubscriptionByTopic | ListSubscriptionByTopic | Queries all subscriptions to a topic. The subscriptions are displayed by page. |
Access point management
|
API |
Title |
Description |
| DisableEndpoint | DisableEndpoint | You can call this operation to disenable the endpoint of a type. After the endpoint is disabled, all requests from the endpoint are blocked and an error is returned. |
| EnableEndpoint | EnableEndpoint | You can call this operation to enable the endpoint of a type. If the endpoint is enabled, requests from the endpoint that are included in the access control lists (ACLs) are not blocked. |
| GetEndpointAttribute | GetEndpointAttribute | GetEndpointAttribute |
| RevokeEndpointAcl | RevokeEndpointAcl | You can call this operation to delete one or more ACL rules for the endpoint of a specified type. |
| AuthorizeEndpointAcl | AuthorizeEndpointAcl | You can call this operation to add one or more access control list (ACL) rules for the endpoint of a specified type. |
Event Notification Management
|
API |
Title |
Description |
| GetEventRule | GetEventRule | Retrieves an event notification rule. |
| ListEventRules | ListEventRules | Queries a list of event rules. |
| CreateEventRule | CreateEventRule | Creates an event rule. |
| DeleteEventRule | DeleteEventRule | Deletes an event rule. |