All Products
Search
Document Center

PolarDB:DescribeConsumers

Last Updated:Jun 10, 2026

Mengembalikan daftar 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

RegionId

string

No

ID wilayah.

cn-beijing

GwClusterId

string

Yes

ID instance gateway.

pg-xxxxxxxxxx

ConsumerId

string

No

ID konsumen.

c-mqveroemc***

ConsumerGroupId

string

No

ID grup konsumen.

cg-xxxxxxxx

PageSize

integer

No

Jumlah entri yang dikembalikan pada setiap halaman. Nilai yang valid adalah:

  • 30

  • 50

  • 100. Nilai default adalah 30.

30

PageNumber

integer

No

Nomor halaman. Nilai default adalah 1.

1

Elemen respons

Element

Type

Description

Example

object

Objek respons.

RequestId

string

ID permintaan.

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

TotalRecordCount

integer

Jumlah total catatan.

1

PageRecordCount

integer

Jumlah entri yang dikembalikan pada halaman saat ini.

1

PageNumber

integer

Nomor halaman.

1

PageSize

integer

Ukuran halaman. Nilai yang valid: 30, 50, dan 100. Nilai default adalah 30.

30

Items

array<object>

Daftar konsumen.

object

Detail tentang konsumen.

ConsumerId

string

ID konsumen.

c-mqveroemc***

Name

string

Nama konsumen.

test

ConsumerGroupId

string

ID grup konsumen.

cg-xxxxxx

ConsumerGroupName

string

Nama grup konsumen.

test

NickName

string

Nama panggilan konsumen.

yonghu

GmtCreated

string

Waktu saat konsumen dibuat.

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

GmtModified

string

Waktu saat konsumen terakhir diubah.

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

ApiKey

string

Kunci API lengkap. Nilai ini hanya dikembalikan oleh operasi ini.

xxxxxxxx

AllowedModels

string

Model yang diizinkan untuk diakses oleh konsumen, ditentukan sebagai larik JSON dalam format string.

"[]"

MtdCostCount

integer

Penggunaan dari awal bulan hingga saat ini.

10

LifetimeCostCount

integer

Penggunaan total.

1000

LifetimeTokenCount

integer

Jumlah total token yang dikonsumsi.

100

MtdTokenCount

integer

Jumlah token yang dikonsumsi dari awal bulan hingga saat ini.

10000

Contoh

Respons sukses

JSONformat

{
  "RequestId": "24A1990B-4F6E-482B-B8CB-75C612******",
  "TotalRecordCount": 1,
  "PageRecordCount": 1,
  "PageNumber": 1,
  "PageSize": 30,
  "Items": [
    {
      "ConsumerId": "c-mqveroemc***",
      "Name": "test",
      "ConsumerGroupId": "cg-xxxxxx",
      "ConsumerGroupName": "test",
      "NickName": "yonghu",
      "GmtCreated": "2026-01-28T09:56:03+08:00",
      "GmtModified": "2026-01-04T16:09:29+08:00",
      "ApiKey": "xxxxxxxx",
      "AllowedModels": "\"[]\"",
      "MtdCostCount": 10,
      "LifetimeCostCount": 1000,
      "LifetimeTokenCount": 100,
      "MtdTokenCount": 10000
    }
  ]
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.