使用ListTopicSubscriptions API查詢主題的訂閱關係列表-雲訊息佇列 RocketMQ 版-阿里雲

查詢主題訂閱關係列表。

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

rocketmq:ListTopicSubscriptions

list

*Topic

acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}

無

請求文法

GET /instances/{instanceId}/topics/{topicName}/subscriptions HTTP/1.1

路徑參數

名稱	類型	必填	描述	樣本值
instanceId	string	是	執行個體 ID。	rmq-cn-zpr34udri0w
topicName	string	是	主題名稱。	dev4-HMH_INSURANCE_NOMAL_TOPIC

請求參數

名稱

類型

必填

描述

樣本值

當前API無需請求參數

返回參數

名稱	類型	描述	樣本值
	object	Result<List>
requestId	string	請求 ID	92A9BE4E-B794-50C8-979C-0456E4D32943
success	boolean	是否成功	true
data	array<object>	返回結果
	object	主題訂閱列表。
consumerGroupId	string	消費者組	CID-TEST
topicName	string	訂閱主題	topic_test
messageModel	string	消費者分組的消費模式。 BROADCASTING：廣播模式 CLUSTERING：叢集模式	BROADCASTING
subscriptionStatus	string	訂閱狀態。 ONLINE：線上。消費者分組下如果有多個消費者，只要有一個消費者線上則顯訂閱狀態為線上。 OFFLINE：離線。消費者分組下如果有多個消費者，所有消費者都處於離線時訂閱狀態才顯示離線。	ONLINE
filterExpression	string	過濾運算式	*
filterExpressionType	string	過濾運算式類型。 SQL：SQL 過濾 TAG：Tag 過濾。	SQL
consistency	string	訂閱關係的一致性。訂閱關係不一致為 false。訂閱關係一致為 true。	true
code	string	錯誤碼	MissingInstanceId
message	string	錯誤資訊	The instance cannot be found.
httpStatusCode	integer	HTTP 狀態代碼	200
dynamicCode	string	動態錯誤碼	Topic
dynamicMessage	string	動態錯誤資訊	instanceId

樣本

正常返回樣本

JSON格式

{
  "requestId": "92A9BE4E-B794-50C8-979C-0456E4D32943",
  "success": true,
  "data": [
    {
      "consumerGroupId": "CID-TEST",
      "topicName": "topic_test",
      "messageModel": "BROADCASTING",
      "subscriptionStatus": "ONLINE",
      "filterExpression": "*",
      "filterExpressionType": "SQL",
      "consistency": "true"
    }
  ],
  "code": "MissingInstanceId",
  "message": "The instance cannot be found.",
  "httpStatusCode": 200,
  "dynamicCode": "Topic",
  "dynamicMessage": "instanceId"
}

錯誤碼

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

變更歷史

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