全部產品
Search
文件中心

PolarDB:DescribeConsumerGroups - 查詢消費者組列表

更新時間:Apr 28, 2026

查詢消費者組列表

調試

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

調試

授權資訊

當前API暫無授權資訊透出。

請求文法

POST  HTTP/1.1

請求參數

名稱

類型

必填

描述

樣本值

GwClusterId

string

網關執行個體 ID。

pg-xxxxxxx

ConsumerGroupId

string

使用者組 ID。

cg-xxxxxxxx

PageSize

integer

每頁記錄數,取值範圍如下:

  • 30

  • 50

  • 100

預設值為 30。

30

PageNumber

integer

查詢頁碼,預設值為 1。

1

RegionId

string

地區 ID。

cn-beijing

返回參數

名稱

類型

描述

樣本值

object

Schema of Response

RequestId

string

Id of the request

24A1990B-4F6E-482B-B8CB-75C612******

TotalRecordCount

integer

總記錄數。

1

PageRecordCount

integer

本頁記錄數。

30

PageNumber

integer

頁碼。

1

PageSize

integer

每頁記錄數,取值為 30、50 或 100。 預設值為 30。

30

Items

array<object>

使用者組列表

object

使用者組對象

IsDefault

string

是否預設組,枚舉值:

  • 0

  • 1

0

ConsumerGroupId

string

使用者組 ID。

cg-xxxxxxxx

ConsumerGroupName

string

使用者組名稱

test

NickName

string

使用者組暱稱

test

GmtCreated

string

建立時間

2026-01-28T09:56:03+08:00

GmtModified

string

更新時間

2026-01-04T16:09:29+08:00

AllowedModels

string

支援的模型列表

"[]"

樣本

正常返回樣本

JSON格式

{
  "RequestId": "24A1990B-4F6E-482B-B8CB-75C612******",
  "TotalRecordCount": 1,
  "PageRecordCount": 30,
  "PageNumber": 1,
  "PageSize": 30,
  "Items": [
    {
      "IsDefault": "0",
      "ConsumerGroupId": "cg-xxxxxxxx",
      "ConsumerGroupName": "test",
      "NickName": "test",
      "GmtCreated": "2026-01-28T09:56:03+08:00",
      "GmtModified": "2026-01-04T16:09:29+08:00",
      "AllowedModels": "\"[]\""
    }
  ]
}

錯誤碼

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

變更歷史

更多資訊,參考變更詳情