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 | Create a topic | Calls the CreateTopic operation to create a topic. |
| SetTopicAttributes | Modify topic attributes | Calls the SetTopicAttributes operation to modify the attributes of a topic. |
| GetTopicAttributes | Get topic attributes | Queries the attributes of a topic. |
| DeleteTopic | Delete a topic | Calls the DeleteTopic operation to delete a topic. |
| ListTopic | Query topic list under an Alibaba Cloud account | Queries the list of topics under an Alibaba Cloud account with paginated results. |
Queue management
|
API |
Title |
Description |
| CreateQueue | Create a queue | Calls the CreateQueue operation to create a queue. |
| SetQueueAttributes | Modify queue attributes | Modifies the attributes of a queue by calling the SetQueueAttributes operation. |
| GetQueueAttributes | Get queue attributes | Retrieves the attributes of a created queue. |
| DeleteQueue | Delete a queue | Calls the DeleteQueue operation to delete a created queue. |
| ListQueue | List all queues under a specified Alibaba Cloud account | Lists all queues under a specified Alibaba Cloud account with pagination support. |
Subscription management
|
API |
Title |
Description |
| Subscribe | Create a subscription for a topic | Calls the Subscribe operation to create a subscription for a topic. |
| SetSubscriptionAttributes | SetSubscriptionAttributes | Call the SetSubscriptionAttributes operation to modify a subscription's attributes. |
| GetSubscriptionAttributes | GetSubscriptionAttributes | Retrieves the properties of a subscription. |
| Unsubscribe | Unsubscribe | You can call Unsubscribe to cancel an existing subscription. |
| ListSubscriptionByTopic | ListSubscriptionByTopic | You can call the ListSubscriptionByTopic operation to retrieve a paginated list of subscriptions for a topic. |
Endpoint management
|
API |
Title |
Description |
| DisableEndpoint | DisableEndpoint | This operation disables an endpoint of a specified type, blocking all subsequent requests from the endpoint and returning an error. |
| EnableEndpoint | EnableEndpoint | This operation enables an endpoint of a specified type. After the endpoint is enabled, requests that originate from the endpoint and are on the Access Control List (ACL) whitelist are not blocked. |
| GetEndpointAttribute | GetEndpointAttribute | Queries the attributes of an endpoint. |
| RevokeEndpointAcl | RevokeEndpointAcl | Revokes one or more Access Control List (ACL) rules for a specified endpoint type. |
| AuthorizeEndpointAcl | AuthorizeEndpointAcl | Adds one or more Access Control List (ACL) rules to an 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 notification rules. |
| CreateEventRule | CreateEventRule | Creates an event rule. |
| DeleteEventRule | DeleteEventRule | Deletes an event rule. |
Others
|
API |
Title |
Description |
| GetAccountAttributes | Retrieve user log configuration | Retrieves the log configuration of a user. |
| SetAccountAttributes | Set user log configuration | Sets the user log configuration. |