すべてのプロダクト
Search

このプロダクト

    PolarDB:DescribeConsumers

    ドキュメントセンター

    PolarDB:DescribeConsumers

    最終更新日:Jul 03, 2026

    消費者のリストを照会します。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    polardb:DescribeConsumers

    get

    *All resources.

    *

    		 なし なし

    リクエスト構文

    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

    任意

    1 ページあたりに返されるエントリ数。有効な値は以下のとおりです。

    • 30

    • 50

    • 100。デフォルト値は 30 です。

    30
    PageNumber

    integer

    任意

    ページ番号。デフォルト値は 1 です。

    1

    任意

    ページあたりのエントリ数。有効な値:

    • 30

    • 50

    • 100 デフォルト値: 30。

    任意

    ページ番号。デフォルト値: 1。

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスのスキーマ。

    RequestId

    string

    リクエストの ID。

    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

    完全な API キー。この応答でのみ返されます。

    xxxxxxxx
    AllowedModels

    string

    サポートされているモデルのリスト。

    "[]"
    MtdCostCount

    integer

    当月の使用量。

    10
    LifetimeCostCount

    integer

    累計使用量の合計。

    1000
    LifetimeTokenCount

    integer

    当月の合計コスト。

    100
    MtdTokenCount

    integer

    累計コストの合計。

    10000

    例

    成功レスポンス

    JSONJSON

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

    エラーコード

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。