全部產品
Search
文件中心

:ListSubscriptionByTopic

更新時間:Jan 24, 2025

調用ListSubscriptionByTopic介面列出某個主題下的Subscription列表,可分頁擷取資料。

授權資訊

預設僅限阿里雲帳號使用本介面,RAM使用者只有在被授予了相關API操作許可權後方可使用。本介面的授權資訊如下表所示。更多資訊,請參見授權策略和樣本

NameValue
APIListSubscriptionByTopic
RAM授權操作mns:ListSubscriptionByTopic
資源acs:mns:$region:$accountid:/topics/$topicName/subscriptions

使用說明

如果本次請求結果返回的Subscription總數超過本次請求的x-mns-ret-number參數值,返回的XML結果中包含的NextMarker表示下一頁開始位置,在下一次請求時將該值賦予x-mns-marker參數以返回下一頁的結果。

請求訊息

請求訊息由請求行、HTTP頭和訊息體三部分組成:

  • 請求行

    GET /topics/$TopicName/subscriptions HTTP/1.1

  • 特有Request Header
    參數名稱類型是否必選樣本值描述
    x-mns-prefixStringtopic按照該首碼開頭的SubscriptionName進行尋找。
    x-mns-markerInteger10請求下一個分頁的開始位置,從上次分頁結果返回的NextMarker擷取。
    x-mns-ret-numberInteger2單次請求結果的最大返回個數。

    取值範圍:1~1000。

    其它Request Header,請參見公用參數

  • Request Body

    無。

返回訊息

返回訊息由返回狀態行、HTTP頭和訊息體三部分組成:

  • HTTP Status Code

    HTTP/1.1 200 OK

  • 特有Response Header

    無。

  • Response Body

    返回XML格式的結果,頂層Subscriptions元素下包含多個Subscription元素,Subscription元素中包含SubscriptionURLSubscriptionURL表示Subscription的URL訪問地址。如果返回結果超過x-mns-ret-number的參數值,包含NextMarker元素表示下個分頁的起始位置。

樣本

請求樣本:

GET /topics/$TopicName/subscriptions HTTP/1.1
x-mns-marker: 10
x-mns-ret-number:2
Host: $AccountId.mns.cn-hangzhou.aliyuncs.com
Date: Tue, 08 Dec 2015 06:16:18 GMT
Authorization: MNS 15B4D3461F177624206A:dXSLY5yGG8Ri5f26ZEmxMCq1****
x-mns-version: 2015-06-06

返回樣本:

HTTP/1.1 200 OK
x-mns-request-id:566675B2B2B71C9C1600****
x-mns-version: 2015-06-06

<?xml version="1.0" encoding="utf-8"?>
<Subscriptions xmlns="http://mns.aliyuncs.com/doc/v1/">
    <Subscription>
        <SubscriptionURL>http://$AccountId.mns.cn-hangzhou.aliyuncs.com/$TopicName/subscriptions/$SubscriptionName1</SubscriptionURL>
    </Subscription>
    <Subscription>
        <SubscriptionURL>http://$AccountId.mns.cn-hangzhou.aliyuncs.com/$TopicName/subscriptions/$SubscriptionName2</SubscriptionURL>
    </Subscription>
    <NextMarker>OTczNjU4MTcvYmRwejd6NXluby8yNjg0Mi9+fn5FI1Rlc3RUb3BpYy0xI2JkcHo3ejV5bm8jVGVzdFN1Yi0zLzA=</NextMarker>
</Subscriptions>