全部產品
Search

搜尋本產品

    PolarDB：DescribeBudgetPolicies

    文件中心

    PolarDB：DescribeBudgetPolicies

    更新時間：Jul 03, 2026

    查詢預算策略。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    polardb:DescribeBudgetPolicies

    get

    *全部資源。

    *

    		 無 無

    請求文法

    POST  HTTP/1.1

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    BudgetPolicyId

    string

    否

    預算策略 ID。

    023aacc1effc4b56bb154bfbec6baxxx
    PageSize

    integer

    否

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

    • 30

    • 50

    • 100

    預設值為 30。

    30
    PageNumber

    integer

    否

    頁碼。

    1
    GwClusterId

    string

    是

    閘道執行個體 ID。

    pg-xxxxxxx
    Status

    string

    否

    策略狀態，列舉值：

    • Enabled 開啟

    • Disenabled 關閉

    Enabled
    BudgetDimensionType

    string

    否

    策略類型，列舉值：

    • ConsumerGroup 使用者群組總預算

    • Consumer 使用者總預算

    ConsumerGroup

    BudgetDimensionRefId

    string

    否

    維度物件 ID（當 BudgetDimensionType 為 ConsumerGroup 或 Consumer 時必填）。

    cg-p3gk2oh55c**
    RegionId

    string

    否

    地域 ID。

    cn-beijing

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    Schema of Response

    RequestId

    string

    Id of the request

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

    integer

    總記錄數。

    2
    PageRecordCount

    integer

    本頁記錄數。

    1
    PageNumber

    integer

    頁碼。

    1
    PageSize

    integer

    每頁記錄數，取值為 30、50 或 100。

    預設值為 30。

    30
    Items

    array<object>

    預算策略列表。

    object

    預算策略物件。

    BudgetPolicyId

    string

    預算策略 ID。

    023aacc1effc4b56bb154bfbec6ba9**
    GwClusterId

    string

    閘道執行個體 ID。

    pg-xxxxxxxx
    Status

    string

    策略狀態，列舉值：

    • Enabled 開啟

    • Disenabled 關閉

    Enabled
    BudgetType

    string

    預算類型，列舉值：

    • GlobalTotal 全域總預算

    • ConsumerTotal 使用者總預算

    • ConsumerGroupTotal 使用者群組總預算

    GlobalTotal
    BudgetDimensionType

    string

    策略類型，列舉值：

    • ConsumerGroup 使用者群組總預算

    • Consumer 使用者總預算

    ConsumerGroup

    BudgetDimensionRefId

    string

    維度物件 ID（當 BudgetDimensionType 為 ConsumerGroup 或 Consumer 時必填）。

    cg-p3gk2oh55c**
    ResetDayOfMonth

    string

    每月重置日（1-28）。

    2
    BudgetPoints

    string

    預算點數。

    10000
    AlertThresholdPct

    string

    告警閾值百分比（0-100）。

    80
    UsedPoints

    integer

    已使用點數。

    10
    GmtCreated

    string

    建立時間。

    2025-03-19T14:13:53+08:00
    GmtModified

    string

    更新時間。

    2025-04-08T10:43:28+08:00
    AlertTriggered

    boolean

    是否觸發告警閾值。

    false
    Exceeded

    string

    是否超出配額。

    false

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "24A1990B-4F6E-482B-B8CB-75C612******",
  "TotalRecordCount": 2,
  "PageRecordCount": 1,
  "PageNumber": 1,
  "PageSize": 30,
  "Items": [
    {
      "BudgetPolicyId": "023aacc1effc4b56bb154bfbec6ba9**",
      "GwClusterId": "pg-xxxxxxxx",
      "Status": "Enabled",
      "BudgetType": "GlobalTotal",
      "BudgetDimensionType": "ConsumerGroup ",
      "BudgetDimensionRefId": "cg-p3gk2oh55c**",
      "ResetDayOfMonth": "2",
      "BudgetPoints": "10000",
      "AlertThresholdPct": "80",
      "UsedPoints": 10,
      "GmtCreated": "2025-03-19T14:13:53+08:00",
      "GmtModified": "2025-04-08T10:43:28+08:00",
      "AlertTriggered": false,
      "Exceeded": "false"
    }
  ]
}

    錯誤碼

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

    變更歷史

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