調用GetConsumerGroupSubscription查詢消費者組訂閱關係詳情及用戶端分布-雲訊息佇列 RocketMQ 版-阿里雲

擷取消費組訂閱關係詳情，包括用戶端分布等資訊。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

rocketmq:GetConsumerGroupSubscription

get

*ConsumerGroup

acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId}

無

請求文法

GET /instances/{instanceId}/consumerGroups/{consumerGroupId}/subscriptions/{topicName} HTTP/1.1

路徑參數

名稱	類型	必填	描述	樣本值
instanceId	string	是	執行個體 ID。	rmq-cn-uqm32kqyy11
consumerGroupId	string	是	消費者分組 ID，表示需要查詢哪個消費者分組的訂閱關係。	common_dev
topicName	string	是	消費者分組訂閱的主題名稱。	mq003

請求參數

名稱

類型

必填

描述

樣本值

當前API無需請求參數

返回參數

名稱	類型	描述	樣本值
	object	Result<List>
requestId	string	請求 ID	157DF7D4-53FB-58C6-BEBC-A9400E7EF68A
success	boolean	是否成功	true
data	array<object>	返回結果
	array<object>	訂閱資訊列表
subscriptionDTO	object	訂閱資訊
consumerGroupId	string	消費者組	GID_inspector_group
topicName	string	訂閱主題	Topic_normal_inspector
messageModel	string	消費者分組的消費模式。 BROADCASTING：廣播模式 CLUSTERING：叢集模式	BROADCASTING
subscriptionStatus	string	訂閱狀態。 ONLINE：線上。消費者分組下如果有多個消費者，只要有一個消費者線上則顯訂閱狀態為線上。 OFFLINE：離線。消費者分組下如果有多個消費者，所有消費者都處於離線時訂閱狀態才顯示離線。	ONLINE
filterExpression	string	過濾運算式	*
filterExpressionType	string	過濾運算式類型。 SQL：SQL 過濾 TAG：Tag 過濾。	UNSPECIFIED
connectionDTO	object	串連詳情資訊
clientId	string	用戶端識別碼	192.168.50.191@19908#-2093249153#1534215565#40385215750900
hostname	string	主機名稱	nginx
egressIp	string	宿主機 IP/公網出網 IP	xx.xx.xx.xx
language	string	用戶端語言	zh
version	string	用戶端版本	1.0.0
messageModel	string	消費者分組的消費模式。 BROADCASTING：廣播模式 CLUSTERING：叢集模式	BROADCASTING
code	string	錯誤碼	Instance.NotFound
message	string	錯誤資訊	Parameter instanceId is mandatory for this action .
httpStatusCode	integer	HTTP 狀態代碼	200
dynamicCode	string	動態錯誤碼	InstanceId
dynamicMessage	string	動態錯誤資訊	instanceId

樣本

正常返回樣本

JSON格式

{
  "requestId": "157DF7D4-53FB-58C6-BEBC-A9400E7EF68A",
  "success": true,
  "data": [
    {
      "subscriptionDTO": {
        "consumerGroupId": "GID_inspector_group",
        "topicName": "Topic_normal_inspector",
        "messageModel": "BROADCASTING",
        "subscriptionStatus": "ONLINE",
        "filterExpression": "*",
        "filterExpressionType": "UNSPECIFIED"
      },
      "connectionDTO": {
        "clientId": "192.168.50.191@19908#-2093249153#1534215565#40385215750900",
        "hostname": "nginx",
        "egressIp": "xx.xx.xx.xx",
        "language": "zh",
        "version": "1.0.0",
        "messageModel": "BROADCASTING"
      }
    }
  ],
  "code": "Instance.NotFound",
  "message": "Parameter instanceId is mandatory for this action .",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId"
}

錯誤碼

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

變更歷史

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