ListSubscriptionByTopic - Simple Message Queue (formerly MNS)

You can call the ListSubscriptionByTopic operation to retrieve a paginated list of subscriptions for a topic.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

mns:ListSubscriptionByTopic

list

*Subscription

acs:mns:{#regionId}:{#accountId}:/topics/{#TopicName}/subscriptions

None

Request parameters

Parameter	Type	Required	Description	Example
TopicName	string	No	The topic name.	test
PageNum	integer	No	The page number of the results to return. Valid values: 1 to 100000000. If the value is less than 1, the system uses 1. If the value is greater than 100000000, the system uses 100000000.	1
PageSize	integer	No	The number of entries to return on each page. Valid values: 10 to 50. If the value is less than 10, the system uses 10. If the value is greater than 50, the system uses 50.	20
SubscriptionName	string	No	The subscription name.	demo-subscription
EndpointType	string	No
EndpointValue	string	No

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	06273500-249F-5863-121D-74D51123****
Code	integer	The response code.	200
Status	string	The response status.	Success
Message	string	The response message.	operation success
Success	boolean	Indicates whether the request was successful.	true
Data	object	The response data.
PageNum	integer	The page number of the returned page.	1
PageSize	integer	The number of entries returned per page.	50
Size	integer	The number of entries on the current page.	20
Pages	integer	The total number of pages.	3
Total	integer	The total number of entries.	130
PageData	array<object>	The entries on the current page.
	array<object>	The data entries.
SubscriptionName	string	The subscription name.	MySubscription
TopicOwner	string	The AccountId of the owner of the topic to which the subscription belongs.	123456789098****
TopicName	string	The name of the topic to which the subscription belongs.	MyTopic
Endpoint	string	The endpoint of the subscription.	http://example.com
FilterTag	string	The tag for message filtering in the subscription. Only messages with the same tag are pushed.	important
CreateTime	integer	The time when the subscription was created, in Unix time format.	1449554806
LastModifyTime	integer	The time when the subscription properties were last modified. This value is a UNIX timestamp.	1449554806
NotifyStrategy	string	The retry policy for message push failures to the endpoint. Valid values: BACKOFF_RETRY: backoff retry. EXPONENTIAL_DECAY_RETRY: exponential decay retry.	BACKOFF_RETRY
NotifyContentFormat	string	The format of the message content pushed to the endpoint. Valid values: XML JSON SIMPLIFIED	XML
DlqPolicy	object	The dead-letter queue policy.
Enabled	boolean	Indicates whether dead-letter message delivery is enabled.	true
DeadLetterTargetQueue	string	The destination queue for dead-letter messages.	dead-letter-queue

Examples

Success response

JSON format

{
  "RequestId": "06273500-249F-5863-121D-74D51123****",
  "Code": 200,
  "Status": "Success",
  "Message": "operation success",
  "Success": true,
  "Data": {
    "PageNum": 1,
    "PageSize": 50,
    "Size": 20,
    "Pages": 3,
    "Total": 130,
    "PageData": [
      {
        "SubscriptionName": "MySubscription",
        "TopicOwner": "123456789098****",
        "TopicName": "MyTopic",
        "Endpoint": "http://example.com",
        "FilterTag": "important\n",
        "CreateTime": 1449554806,
        "LastModifyTime": 1449554806,
        "NotifyStrategy": "BACKOFF_RETRY",
        "NotifyContentFormat": "XML",
        "DlqPolicy": {
          "Enabled": true,
          "DeadLetterTargetQueue": "dead-letter-queue"
        }
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.