全部產品
Search

搜尋本產品

    Simple Message Queue (formerly MNS)：Subscribe

    文件中心

    Simple Message Queue (formerly MNS)：Subscribe

    更新時間：Jun 30, 2026

    呼叫 Subscribe 介面，為主題建立 Subscription。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    mns:Subscribe

    update

    *Subscription

    acs:mns:{#regionId}:{#accountId}:/topics/{#TopicName}/subscriptions/{#SubscriptionName}
    • mns:PushType
    		 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    TopicName

    string

    是

    主題的名稱。

    topic****1
    SubscriptionName

    string

    是

    訂閱名稱。

    testSubscription

    PushType

    string

    是

    訂閱的推送類型

    取值：

    • http：HTTP/HTTPS 推送，將訊息推送到指定的 HTTP 或 HTTPS 回呼地址。

    • queue：佇列推送，將訊息推送到指定的 SMQ 佇列。

    • dm：郵箱推送，透過郵件服務（DirectMail）傳送通知。需同時設定 DmAttributes 和 StsRoleArn 參數。

    • dysms：簡訊推送，透過阿里雲簡訊服務傳送通知。需同時設定 DysmsAttributes 參數。

    • fc：函數計算推送，將訊息推送到阿里雲函數計算（FC）。

    • eventbus：事件匯流排推送，將訊息推送到 EventBridge 事件匯流排。

    說明： 以下值已廢棄，僅用於相容舊訂閱：

    • mpush：行動推送

    • alisms：舊版簡訊

    • email：舊版郵箱，請使用 dm

    • kafka：Kafka 推送類型已廢棄。

    queue
    Endpoint

    string

    是

    接收訊息的終端地址

    格式根據 PushType 不同而不同：

    • PushType=http：HTTP/HTTPS 回呼 URL，如 http://example.com/callback 或 https://example.com/callback。

    • PushType=queue：目標佇列 ARN，格式為 acs:mns:{RegionId}:{主帳號 UID}:queues/{QueueName}。

    • PushType=dm：郵箱推送終端，格式固定為 smq-ep:dm:{主帳號 UID}:__dynamic，其中 {主帳號 UID} 替換為您的阿里雲主帳號 UID。

    • PushType=dysms：簡訊推送終端，格式為 smq-ep:dysms:{主帳號 UID}:{手機號碼}。

    • PushType=kafka：Kafka 推送終端，Kafka 推送類型已廢棄。

    • PushType=fc：函數計算終端，格式為 acs:fc:{RegionId}:{主帳號 UID}:services/{ServiceName}/functions/{FunctionName}。

    • PushType=eventbus：事件匯流排終端，格式為 acs:eventbridge:{RegionId}:{主帳號 UID}:eventbus/{EventBusName}。

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

    string

    否

    向 Endpoint 推送訊息錯誤時的重試策略。取值說明如下：

    • BACKOFF_RETRY：退避重試。

    • EXPONENTIAL_DECAY_RETRY：指數衰減重試。

    BACKOFF_RETRY
    NotifyContentFormat

    string

    否

    推送的訊息內容格式

    取值：

    • XML：訊息體以 XML 格式推送（預設）。

    • JSON：訊息體以 JSON 格式推送。

    • SIMPLIFIED：僅推送訊息體原始內容，不包含 SMQ 的中繼資訊包裝。

    XML
    MessageTag

    string

    否

    該訂閱中訊息過濾的標籤（標籤一致的訊息才會被推送）。 取值範圍：不超過 16 個字元的字串。

    預設不進行訊息過濾。

    important
    DlqPolicy

    object

    否

    死信佇列策略。

    Enabled

    boolean

    否

    是否開啟死信訊息投遞。

    true
    DeadLetterTargetQueue

    string

    否

    死信訊息投遞目標佇列。

    deadLetterTargetQueue
    TenantRateLimitPolicy

    object

    否

    限流策略。

    Enabled

    boolean

    否

    是否啟用限流策略，true 啟用，false 關閉。

    MaxReceivesPerSecond

    integer

    否

    每秒最大推送/消費次數。

    50
    StsRoleArn

    string

    否

    服務扮演的 RAM 角色 ARN。格式為 acs:ram::{主帳號 UID}:role/{RoleName}，其中 {主帳號 UID} 必須替換為呼叫 OpenAPI 的阿里雲主帳號 UID。

    acs:ram::1234567890:role/AliyunMNSNotificationRole
    DmAttributes

    object

    否

    郵箱推送相關屬性，當 PushType=dm 時必填。JSON 格式，包含以下欄位：

    • AccountName：發信地址，即 DirectMail 中設定的發信地址（如 notify@example.com）。

    • Subject：郵件主題。

    AccountName

    string

    否

    發信地址。

    notify@example.com
    Subject

    string

    否

    郵件主題。

    notify
    DysmsAttributes

    object

    否

    簡訊推送相關屬性，當 PushType=alisms 時必填。JSON 格式，包含以下欄位：

    • TemplateCode：簡訊範本 Code，在簡訊服務主控台中取得。

    • SignName：簡訊簽名名稱。

    TemplateCode

    string

    否

    簡訊範本 Code。

    123456
    SignName

    string

    否

    簡訊簽名名稱。

    阿里云短信测试专用
    KafkaAttributes

    object

    否

    Kafka 推送類型已廢棄。

    BusinessMode

    string

    否

    Kafka 推送類型已廢棄。

    Default empty string

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    RequestId

    string

    請求的 ID。

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

    integer

    回應 code。

    200
    Status

    string

    回應的狀態。

    Success
    Message

    string

    回應資訊。

    operation success
    Success

    boolean

    請求是否成功。

    true
    Data

    string

    回應資料。

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

    樣本

    正常返回樣本

    JSON格式

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

    錯誤碼

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。