使用GetConsumerGroup擷取消費者分組詳情-雲訊息佇列 RocketMQ 版-阿里雲

擷取某個指定消費者分組的詳細資料。

介面說明

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

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

rocketmq:GetConsumerGroup

get

*ConsumerGroup

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

無

請求文法

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

路徑參數

名稱	類型	必填	描述	樣本值
instanceId	string	是	待查詢消費者分組所屬的執行個體的 ID。	rmq-cn-7e22ody****
consumerGroupId	string	是	待查詢消費者分組的 ID。	CID-TEST

請求參數

名稱

類型

必填

描述

樣本值

當前API無需請求參數

返回參數

名稱	類型	描述	樣本值
	object	Result
requestId	string	請求 ID，每個請求的 ID 都是唯一的，可用於排查和定位問題。	C7F94090-3358-506A-97DC-34BC803C****
success	boolean	執行結果是否成功。	true
data	object	返回結果。
regionId	string	執行個體所屬的地區 ID。	cn-hangzhou
instanceId	string	消費者分組所屬的執行個體的 ID。	rmq-cn-7e22ody****
consumerGroupId	string	消費者分組的 ID。	CID-TEST
status	string	消費者分組的狀態。枚舉值： RUNNING : 運行中 CREATING : 建立中	RUNNING
remark	string	消費者分組的備忘資訊。	This is the remark for test.
createTime	string	消費者分組的建立時間。	2022-08-01 20:05:50
updateTime	string	消費者分組的最後更新時間。	2022-08-01 20:05:50
deliveryOrderType	string	消費者分組的投遞順序性。枚舉值： Concurrently : 並發投遞 Orderly : 順序投遞	Concurrently
consumeRetryPolicy	object	消費者分組的消費重試策略。更多資訊，請參見消費重試。
retryPolicy	string	重試策略類型。枚舉值： FixedRetryPolicy : 固定間隔重試 DefaultRetryPolicy : 階梯退避重試	DefaultRetryPolicy
maxRetryTimes	integer	最大重試次數。	16
deadLetterTargetTopic	string	死信 Topic。消費者出現異常消費某條訊息失敗，且訊息重試後依然未成功，訊息將被投遞至死信 Topic 中，以便後續進行業務恢複或回溯。更多資訊，請參見消費重試與死信。	DLQ_mqtest
fixedIntervalRetryTime	integer	固定稍候再試，取之範圍，單位：秒 Concurrently(並發投遞)：10-1800 Orderly(順序投遞): 1-600	20
maxReceiveTps	integer	消費訊息 tps 上限	2000
messageModel	string	消費模式： CLUSTERING：叢集消費 LITE_SELECTIVE：LITE_SELECTIVE	LITE_SELECTIVE
topicName	string	lite 類型的 topicName	test1
code	string	錯誤碼。	InvalidConsumerGroupId
message	string	錯誤資訊。	Parameter consumerGroupId is invalid.
httpStatusCode	integer	HTTP 狀態代碼。	400
dynamicCode	string	動態錯誤碼。	ConsumerGroupId
dynamicMessage	string	動態錯誤資訊。	consumerGroupId

樣本

正常返回樣本

JSON格式

{
  "requestId": "C7F94090-3358-506A-97DC-34BC803C****",
  "success": true,
  "data": {
    "regionId": "cn-hangzhou",
    "instanceId": "rmq-cn-7e22ody****",
    "consumerGroupId": "CID-TEST",
    "status": "RUNNING",
    "remark": "This is the remark for test.",
    "createTime": "2022-08-01 20:05:50",
    "updateTime": "2022-08-01 20:05:50",
    "deliveryOrderType": "Concurrently",
    "consumeRetryPolicy": {
      "retryPolicy": "DefaultRetryPolicy",
      "maxRetryTimes": 16,
      "deadLetterTargetTopic": "DLQ_mqtest",
      "fixedIntervalRetryTime": 20
    },
    "maxReceiveTps": 2000,
    "messageModel": "LITE_SELECTIVE",
    "topicName": "test1"
  },
  "code": "InvalidConsumerGroupId",
  "message": "Parameter consumerGroupId is invalid.",
  "httpStatusCode": 400,
  "dynamicCode": "ConsumerGroupId",
  "dynamicMessage": "consumerGroupId"
}

錯誤碼

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

變更歷史

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