All Products
Search

This Product

    PolarDB:DescribeConsumerGroups

    Document Center

    PolarDB:DescribeConsumerGroups

    Last Updated:Jun 10, 2026

    Mengambil daftar grup konsumen.

    Coba sekarang

    Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

    Test

    RAM authorization

    Tidak ada otorisasi untuk operasi ini. Jika Anda mengalami masalah saat menjalankan operasi ini, hubungi dukungan teknis.

    Sintaks permintaan

    POST  HTTP/1.1

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    GwClusterId

    string

    Yes

    ID instans gateway.

    pg-xxxxxxx
    ConsumerGroupId

    string

    No

    ID grup konsumen.

    cg-xxxxxxxx
    PageSize

    integer

    No

    Jumlah record yang dikembalikan per halaman. Nilai yang valid:

    • 30

    • 50

    • 100

    Nilai default adalah 30.

    30
    PageNumber

    integer

    No

    Nomor halaman yang dikembalikan. Nilai default adalah 1.

    1
    RegionId

    string

    No

    ID region.

    cn-beijing

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Objek respons.

    RequestId

    string

    ID permintaan.

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

    integer

    Jumlah total record.

    1
    PageRecordCount

    integer

    Jumlah record pada halaman saat ini.

    30
    PageNumber

    integer

    Nomor halaman.

    1
    PageSize

    integer

    Jumlah record yang dikembalikan per halaman. Nilai yang valid: 30, 50, dan 100. Nilai default: 30.

    30
    Items

    array<object>

    Daftar grup konsumen.

    object

    Objek grup konsumen.

    IsDefault

    string

    Menunjukkan apakah grup konsumen adalah grup default. Nilai yang valid:

    • 0: Tidak

    • 1: Ya

    0
    ConsumerGroupId

    string

    ID grup konsumen.

    cg-xxxxxxxx
    ConsumerGroupName

    string

    Nama grup konsumen.

    test
    NickName

    string

    Nama panggilan grup konsumen.

    test
    GmtCreated

    string

    Waktu pembuatan.

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

    string

    Waktu pembaruan.

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

    string

    Daftar model yang didukung.

    "[]"

    Contoh

    Respons sukses

    JSONformat

    {
  "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": "\"[]\""
    }
  ]
}

    Kode kesalahan

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.