Subscribe - Simple Message Queue (formerly MNS) - Alibaba Cloud Documentation Center

Creates a subscription to a topic.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
mns:Subscribe	update	*Subscription `acs:mns:{#regionId}:{#accountId}:/topics/{#TopicName}/subscriptions/{#SubscriptionName}`	mns:PushType	none

Request parameters

Parameter	Type	Required	Description	Example
TopicName	string	Yes	The name of the topic.	test
SubscriptionName	string	Yes	The name of the subscription.	testSubscription
PushType	string	Yes	The terminal type. Valid values: http: HTTP services queue: queues mpush: mobile devices alisms: Alibaba Cloud Short Message Service (SMS) email: emails	queue
Endpoint	string	Yes	The receiver endpoint. The format of the endpoint varies based on the terminal type. If you set PushType to http, set Endpoint to an `HTTP URL that starts with http:// or https://`. If you set PushType to queue, set Endpoint to a `queue name`. If you set PushType to mpush, set Endpoint to an `AppKey`. If you set PushType to alisms, set Endpoint to a `mobile number`. If you set PushType to email, set Endpoint to an `email address`.	http://example.com
NotifyStrategy	string	No	The retry policy that is applied if an error occurs when Message Service (MNS) pushes messages to the endpoint. Valid values: BACKOFF_RETRY EXPONENTIAL_DECAY_RETRY	BACKOFF_RETRY
NotifyContentFormat	string	No	The content format of the messages that are pushed to the endpoint. Valid values: XML JSON SIMPLIFIED	XML
MessageTag	string	No	The tag that is used to filter messages. Only messages that have the same tag can be pushed. Set the value to a string of no more than 16 characters. By default, no tag is specified to filter messages.	important
DlqPolicy	object	No	The dead-letter queue policy.
Enabled	boolean	No	Specifies whether to enable the dead-letter message delivery.	true
DeadLetterTargetQueue	string	No	The queue to which dead-letter messages are delivered.	deadLetterTargetQueue

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	06273500-249F-5863-121D-74D51123****
Code	long	The response code.	200
Status	string	The response status.	Success
Message	string	The returned message.	operation success
Success	boolean	Indicates whether the request was successful.	true
Data	string	The returned data.	{'Code': 200, 'Success': True}

Examples

Sample success responses

JSONformat

{
  "RequestId": "06273500-249F-5863-121D-74D51123****",
  "Code": 200,
  "Status": "Success",
  "Message": "operation success",
  "Success": true,
  "Data": "{'Code': 200, 'Success': True}"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2025-02-08	The request parameters of the API has changed	View Change Details
2024-04-24	The internal configuration of the API is changed, but the call is not affected	View Change Details