API standards and multilingual preset SDKs
The OpenAPI of this product (Mns-open/2022-01-19) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
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. |
Endpoint 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. |