OnsTopicSubDetail查詢Topic的訂閱組資訊-雲訊息佇列 RocketMQ 版-阿里雲 - ApsaraMQ for RocketMQ

介面說明

重要阿里雲提供的 OpenAPI 屬於管控類 API，用於管理和查詢阿里雲服務的相關資源。僅推薦在管控鏈路整合，訊息收發的核心資料鏈路中嚴禁依賴 OpenAPI 實現，否則可能會導致鏈路產生風險。

該介面用於查詢 Group 和 Topic 之間的訂閱關係。如果 Group ID 對應的消費者執行個體不線上則查不到資料。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

mq:QueryTopicSubDetail

get

Topic

acs:mq:{#regionId}:{#accountId}:{#TopicName}

Topic

acs:mq:{#regionId}:{#accountId}:{#InstanceId}%{#TopicName}

無

mq:OnsInstanceBaseInfo

請求參數

名稱	類型	必填	描述	樣本值
InstanceId	string	是	需查詢的 Topic 所對應的執行個體 ID。	MQ_INST_111111111111_DOxxxxxx
Topic	string	是	需查詢的 Topic。	test

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	公用參數，每個請求的 ID 都是唯一的，可用於排查和定位問題。	87B6207F-2908-42B5-A134-84956DCA****
Data	object	返回 Data 對象。
SubscriptionDataList	object
SubscriptionDataList	array<object>	所有線上訂閱組。
	object
GroupId	string	訂閱該 Topic 的 Group ID。	GID_test
MessageModel	string	消費模式。取值說明如下： CLUSTERING：叢集訂閱 BROADCASTING：廣播訂閱消費模式的更多資訊，請參見叢集消費和廣播消費。	CLUSTERING
SubString	string	訂閱運算式。	*
Online	string	是否線上	true
Topic	string	Topic 名稱。	test

樣本

正常返回樣本

JSON格式

{
  "RequestId": "87B6207F-2908-42B5-A134-84956DCA****",
  "Data": {
    "SubscriptionDataList": {
      "SubscriptionDataList": [
        {
          "GroupId": "GID_test",
          "MessageModel": "CLUSTERING",
          "SubString": "*",
          "Online": "true"
        }
      ]
    },
    "Topic": "test"
  }
}

錯誤碼

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

變更歷史

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