全部產品
Search

搜尋本產品

    PolarDB：DescribeConsumers

    文件中心

    PolarDB：DescribeConsumers

    更新時間：Jul 03, 2026

    查詢消費者列表。

    調試

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

    調試

    授權資訊

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

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    polardb:DescribeConsumers

    get

    *全部資源。

    *

    		 無 無

    請求文法

    POST  HTTP/1.1

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    RegionId

    string

    否

    地域 ID。

    cn-beijing
    GwClusterId

    string

    是

    閘道執行個體 ID。

    pg-xxxxxxxxxx
    ConsumerId

    string

    否

    使用者 ID。

    c-mqveroemc***
    ConsumerGroupId

    string

    否

    使用者群組 ID。

    cg-xxxxxxxx
    PageSize

    integer

    否

    每頁記錄數，取值範圍如下：

    • 30

    • 50

    • 100 預設值為 30。

    30
    PageNumber

    integer

    否

    查詢頁碼，預設值為 1。

    1

    否

    每頁記錄數，取值範圍如下：

    • 30

    • 50

    • 100 預設值為 30。

    否

    查詢頁碼，預設值為 1。

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    Schema of Response

    RequestId

    string

    Id of the request

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

    integer

    總記錄數。

    1
    PageRecordCount

    integer

    本頁記錄數。

    1
    PageNumber

    integer

    頁碼。

    1
    PageSize

    integer

    每頁記錄數，取值範圍為 30、50、100，預設值為 30。

    30
    Items

    array<object>

    使用者列表。

    object

    使用者物件。

    ConsumerId

    string

    使用者 ID。

    c-mqveroemc***
    Name

    string

    使用者名稱。

    test
    ConsumerGroupId

    string

    使用者群組 ID。

    cg-xxxxxx
    ConsumerGroupName

    string

    使用者群組名稱。

    test
    NickName

    string

    使用者暱稱。

    yonghu
    GmtCreated

    string

    建立時間。

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

    string

    更新時間。

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

    string

    完整 APIKey，僅本次返回。

    xxxxxxxx
    AllowedModels

    string

    支援的模型列表。

    "[]"
    MtdCostCount

    integer

    當月使用量。

    10
    LifetimeCostCount

    integer

    累積使用總量。

    1000
    LifetimeTokenCount

    integer

    當月費用總量。

    100
    MtdTokenCount

    integer

    累積費用總量。

    10000

    樣本

    正常返回樣本

    JSON格式

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

    錯誤碼

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

    變更歷史

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