All Products
Search
Document Center

Simple Message Queue (formerly MNS):ListSubscriptionByTopic

Last Updated:Mar 06, 2025

Queries all subscriptions to a topic. The subscriptions are displayed by page.

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
mns:ListSubscriptionByTopiclist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TopicNamestringNo

The topic name.

test
PageNumlongNo

The page number. Valid values: 1 to 100000000. If you set this parameter to a value smaller than 1, the value of this parameter is 1 by default. If you set this parameter to a value greater than 100000000, the value of this parameter is 100000000 by default.

1
PageSizelongNo

The number of entries per page. Value values: 10 to 50. If you set this parameter to a value smaller than 10, the value of this parameter is 10 by default. If you set this parameter to a value greater than 50, the value of this parameter is 50 by default.

20
SubscriptionNamestringNo

The name of the subscription.

demo-subscription

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

06273500-249F-5863-121D-74D51123****
Codelong

The response code.

200
Statusstring

The response status.

Success
Messagestring

The returned message.

operation success
Successboolean

Indicates whether the request was successful.

true
Dataobject

The data returned.

PageNumlong

The page number.

1
PageSizelong

The number of entries per page.

50
Sizelong

The number of entries on the current page.

20
Pageslong

The total number of pages returned.

3
Totallong

The total number of entries returned.

130
PageDataarray<object>

The data returned on the current page.

pageDataobject

The data entries.

SubscriptionNamestring

The name of the subscription.

MySubscription
TopicOwnerstring

The Alibaba Cloud account ID of the topic owner.

123456789098****
TopicNamestring

The name of the topic.

MyTopic
Endpointstring

The endpoint to which the messages are pushed.

http://example.com
FilterTagstring

The tag that is used to filter messages. Only the messages that are attached with the specified tag can be pushed.

important
CreateTimelong

The time when the subscription was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

1449554806
LastModifyTimelong

The time when the subscription was last modified. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

1449554806
NotifyStrategystring

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
NotifyContentFormatstring

The content format of the messages that are pushed to the endpoint. Valid values:

  • XML
  • JSON
  • SIMPLIFIED
XML
DlqPolicyobject

The dead-letter queue policy.

Enabledboolean

Specifies whether to enable the dead-letter message delivery.

true
DeadLetterTargetQueuestring

The queue to which dead-letter messages are delivered.

dead-letter-queue

Examples

Sample success responses

JSONformat

{
  "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

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

Change history

Change timeSummary of changesOperation
2025-02-08The response structure of the API has changedView Change Details
2024-07-31The internal configuration of the API is changed, but the call is not affectedView Change Details
2024-06-17The internal configuration of the API is changed, but the call is not affectedView Change Details