すべてのプロダクト
Search

このプロダクト

    PolarDB:DescribePolarFsQuota

    ドキュメントセンター

    PolarDB:DescribePolarFsQuota

    最終更新日:Sep 24, 2026

    指定された Polarlakebase インスタンスのすべてのクォータルール情報を取得します。

    操作説明

    リクエストの説明

    • この API オペレーションは、特定の Polarlakebase インスタンスのすべてのクォータルールを照会します。QuotaNameMatch パラメーターと PatternMatch パラメーターを使用してあいまい検索を実行できます。

    • ページネーション機能はまだ一般公開されておらず、カーネルの準備が整い次第リリースされます。現在、結果はページネーションの制限なしで返されます。

    • PolarFsInstanceId は必須であり、照会する Polarlakebase インスタンスを指定します。

    • QuotaNameMatch や PatternMatch などのオプションパラメーターを使用して、指定された条件を満たすクォータルールをさらにフィルター処理できます。

    • 返されるデータには、クォータルールの総数、現在のページのルール数、ルール ID、名前、説明、容量制限などの特定のルールの詳細が含まれますが、これらに限定されません。

    今すぐお試しください

    この 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:DescribePolarFsQuota

    none

    *すべてのリソース。

    *

    		 なし なし

    リクエスト構文

    POST  HTTP/1.1

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    PolarFsInstanceId

    string

    必須

    Polarlakebase インスタンスの ID。

    pfs-2ze0i74ka607*****
    DBClusterId

    string

    任意

    クラスターの ID。

    説明

    Enterprise Edition、Basic Edition、および Data Lakehouse エディション: DescribeDBClusters 操作を呼び出してクラスター ID を照会できます。

    pc-**************
    RegionId

    string

    任意

    リージョン ID。

    説明

    DescribeRegions 操作を呼び出して、現在のアカウントで利用可能なすべてのリージョン (リージョン ID を含む) を照会できます。

    cn-beijing
    Path

    string

    任意

    対象パス。

    /data
    QuotaType

    string

    任意

    クエリするクォータタイプ。

    列挙値:

    • quota :

      クォータ。

    • quotaPolicy :

      クォータポリシー。

    クォータポリシー

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスのスキーマ。

    RequestId

    string

    リクエストの ID。

    2FED790E-FB61-4721-8C1C-07C627******
    PolarFsInstanceId

    string

    Polarlakebase インスタンスの ID。

    pfs-2ze0i74ka607*****
    PageSize

    string

    1 ページあたりのレコード数。有効な値: 5～50。デフォルト値: 10。

    10
    PageNumber

    string

    ページ番号。

    1
    TotalRecordCount

    string

    レコードの総数。

    5
    PageRecordCount

    string

    現在のページのレコード数。

    5
    PolicyItems

    array<object>

    ルールの詳細。

    object

    ルール。

    Id

    integer

    ルールの ID。

    73
    Name

    string

    ルール名。

    xxxxx
    Description

    string

    ルールの説明。

    NULL
    Include

    string

    パスに一致させるための glob パターン。

    • / で始まるパスパターン (*、?、** の glob 構文をサポート)。

    /a*
    Exclude

    string

    特定のパスを除外するための一致ルール。

    • / で始まるパスパターン (*、?、** の glob 構文をサポート)。

    NULL
    SizeLimit

    integer

    ディレクトリの合計ファイル容量制限。単位: GB。

    • 注意: 値は 1 GB 以上である必要があります。

    1
    FileCountLimit

    integer

    ディレクトリ内のユーザーに対するファイル数制限。

    77
    AccessTTL

    integer

    アクセス時間の TTL。単位: 秒。

    7200
    ChangeTTL

    integer

    変更時間の TTL。単位: 秒。

    7200
    Priority

    integer

    クォータルールの優先度。

    1
    Enabled

    boolean

    ルールが有効かどうかを示します。有効な値:

    • true: 新しいイベントは、新しいトランザクション数に対してすぐに効果があります。これがデフォルト値です。

    • false: 新しいイベントは、新しいトランザクション数に対して効果はありません。

    false
    QuotaItems

    array<object>

    クォータ情報。

    object

    ディレクトリクォータ。

    Path

    string

    ディレクトリパス。

    /data
    Capacity

    integer

    容量。単位: バイト。

    1073741824
    UsedCapacity

    integer

    使用済み容量。単位: バイト。

    104857600
    Inodes

    integer

    Inode。

    100
    UsedInodes

    integer

    使用済み Inode の数。

    1
    Path

    string

    ディレクトリパス。

    /data

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "2FED790E-FB61-4721-8C1C-07C627******",
  "PolarFsInstanceId": "pfs-2ze0i74ka607*****",
  "PageSize": "10",
  "PageNumber": "1",
  "TotalRecordCount": "5",
  "PageRecordCount": "5",
  "PolicyItems": [
    {
      "Id": 73,
      "Name": "xxxxx",
      "Description": "NULL",
      "Include": "/a*",
      "Exclude": "NULL",
      "SizeLimit": 1,
      "FileCountLimit": 77,
      "AccessTTL": 7200,
      "ChangeTTL": 7200,
      "Priority": 1,
      "Enabled": false
    }
  ],
  "QuotaItems": [
    {
      "Path": "/data",
      "Capacity": 1073741824,
      "UsedCapacity": 104857600,
      "Inodes": 100,
      "UsedInodes": 1
    }
  ],
  "Path": "/data"
}

    エラーコード

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

    変更履歴

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