All Products
Search

This Product

    Simple Message Queue (formerly MNS):Subscribe

    Document Center

    Simple Message Queue (formerly MNS):Subscribe

    Last Updated:Dec 19, 2025

    You can call the Subscribe operation to create a subscription 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: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.

    topic****1
    SubscriptionName

    string

    Yes

    The name of the subscription.

    testSubscription

    PushType

    string

    Yes

    The type of the endpoint.

    • http: an HTTP push.

    • queue: a queue push.

    • mpush: a Mobile Push.

    • alisms: an Alibaba Cloud text message push.

    • email: an email push.

    queue
    Endpoint

    string

    Yes

    The endpoint that receives messages in this subscription. The endpoint format varies based on the endpoint type:

    • HTTP: http(s)://{your_url}

    • Queue: {QueueName}

    • Mobile Push: {AppKey}

    • Alibaba Cloud text message: {phoneNumber}

    • Email: {emailAddress}

    http://*****.com/uri1/xxx
    NotifyStrategy

    string

    No

    The retry policy for pushing messages to the endpoint when an error occurs. Valid values:

    • BACKOFF_RETRY: backoff retry.

    • EXPONENTIAL_DECAY_RETRY: exponential decay retry.

    BACKOFF_RETRY
    NotifyContentFormat

    string

    No

    The format of the message that is pushed to the endpoint. Valid values:

    • XML

    • JSON

    • SIMPLIFIED

    XML
    MessageTag

    string

    No

    The tag for message filtering in this subscription. Only messages with the same tag are pushed. The value is a string of up to 16 characters.

    By default, messages are not filtered.

    important
    DlqPolicy

    object

    No

    The dead-letter queue policy.

    Enabled

    boolean

    No

    Specifies whether to enable dead-letter message delivery.

    true
    DeadLetterTargetQueue

    string

    No

    The target queue for dead-letter message delivery.

    deadLetterTargetQueue
    TenantRateLimitPolicy

    object

    No

    Enabled

    boolean

    No

    MaxReceivesPerSecond

    integer

    No

    StsRoleArn

    string

    No

    DmAttributes

    object

    No

    AccountName

    string

    No

    Subject

    string

    No

    DysmsAttributes

    object

    No

    TemplateCode

    string

    No

    SignName

    string

    No

    KafkaAttributes

    object

    No

    BusinessMode

    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 status of the response.

    Success
    Message

    string

    The response message.

    operation success
    Success

    boolean

    Indicates whether the request was successful.

    true
    Data

    string

    The response data.

    {'Code': 200, 'Success': True}

    Examples

    Success response

    JSON format

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

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.