全部產品
Search

搜尋本產品

    PolarDB：DescribePolarFsQuota - 查詢Polarlakebase配額規則

    文件中心

    PolarDB：DescribePolarFsQuota - 查詢Polarlakebase配額規則

    更新時間：May 15, 2026

    擷取指定Polarlakebase執行個體下的全部配額規則資訊。

    介面說明

    請求說明

    • 本 API 用於查詢特定 Polarlakebase 執行個體下的所有配額規則，支援通過QuotaNameMatch和PatternMatch參數進行模糊比對。

    • 分頁功能暫未公開，待核心準備好後將開放使用。目前返回結果無分頁限制。

    • PolarFsInstanceId是必填項，用於指定要查詢的 Polarlakebase 執行個體。

    • 選擇性參數如QuotaNameMatch、PatternMatch等可用於進一步篩選合格配額規則。

    • 返回的資料包括但不限於配額規則總數、當前頁規則數量以及具體的規則詳情（如規則 ID、名稱、描述、容量限制等）。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    polardb:DescribePolarFsQuota

    none

    *全部資源

    *

    		 無 無

    請求文法

    POST  HTTP/1.1

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    PolarFsInstanceId

    string

    是

    Polarlakebase 執行個體 ID

    pfs-2ze0i74ka607*****
    DBClusterId

    string

    否

    叢集 ID。

    說明

    企業、基礎、湖倉版：您可以調用 DescribeDBClusters 介面可以查詢叢集 ID。

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

    string

    否

    地區 ID。

    說明

    您可以通過 DescribeRegions 介面查看當前帳號下的所有可用地區資訊，包括地區 ID。

    cn-beijing
    Path

    string

    否

    目標路徑

    /data
    QuotaType

    string

    否

    查詢的 Quota 類型

    quotaPolicy

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    Schema of Response

    RequestId

    string

    Id of the request

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

    string

    Polarlakebase 執行個體 ID

    pfs-2ze0i74ka607*****
    PageSize

    string

    每頁記錄數，取值：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 文法）。

    /a*
    Exclude

    string

    排除特定路徑的匹配規則

    • 以 / 開頭的路徑模式（支援 *、?、** 的 glob 文法）

    NULL
    SizeLimit

    integer

    限制目錄下檔案總容量。單位：GB

    • 說明：不小於 1GB

    1
    FileCountLimit

    integer

    目錄下使用者的檔案數目限制。

    77
    AccessTTL

    integer

    access time 對應的 ttl，單位 秒

    7200
    ChangeTTL

    integer

    change time 對應的 ttl，單位 秒

    7200
    Priority

    integer

    配額規則的優先順序。

    1
    Enabled

    boolean

    規則是否啟用，取值如下：

    • true：新增事件對新事物立即生效，預設值

    • false：新增事件對新事物不生效

    false
    QuotaItems

    array<object>

    配額資訊

    object

    目錄配額

    Path

    string

    目錄路徑

    /data
    Capacity

    integer

    容量，單位：Byte

    1073741824
    UsedCapacity

    integer

    使用容量，單位：Byte

    104857600
    Inodes

    integer

    Inodes

    100
    UsedInodes

    integer

    已使用 Inodes

    1
    Path

    string

    目錄路徑

    /data

    樣本

    正常返回樣本

    JSON格式

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

    錯誤碼

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

    變更歷史

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