查詢指定實例下消費者分組的列表信息。
接口說明
注意 阿里云提供的 OpenAPI 屬于管控類 API，用于管理和查詢阿里云服務的相關資源。僅推薦在管控鏈路集成，消息收發的核心數據鏈路中嚴禁依賴 OpenAPI 實現，否則可能會導致鏈路產生風險。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| rocketmq:ListConsumerGroups | list | *ConsumerGroup acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/* |
| 無 |
請求語法
GET /instances/{instanceId}/consumerGroups HTTP/1.1
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| instanceId | string | 是 | 指定需要獲取哪個實例下的消費者分組列表。 | rmq-cn-7e22ody**** |
| filter | string | 否 | 查詢的過濾條件，若不輸入則查詢指定實例下所有的消費者分組。 | CID-TEST |
| pageNumber | integer | 是 | 分頁頁碼，查詢第幾頁的返回結果。 | 1 |
| pageSize | integer | 是 | 分頁大小，每頁最多顯示的返回結果數量。 取值范圍：[10,100]。 | 10 |
返回參數
示例
正常返回示例
JSON格式
{
"requestId": "5503A460-98ED-5543-92CF-4853DE28****",
"success": true,
"data": {
"pageNumber": 1,
"pageSize": 10,
"totalCount": 1,
"list": [
{
"regionId": "cn-hangzhou",
"instanceId": "rmq-cn-7e22ody****",
"consumerGroupId": "GID-TEST",
"status": "RUNNING",
"remark": "This is the remark for test.",
"createTime": "2022-08-01 20:05:50",
"updateTime": "2022-08-01 20:05:50"
}
]
},
"code": "MissingInstanceId",
"message": "Parameter InstanceId is mandatory for this action .",
"httpStatusCode": 400,
"dynamicCode": "InstanceId",
"dynamicMessage": "instanceId"
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|
暫無變更歷史