すべてのプロダクト
Search

このプロダクト

    PolarDB:DescribeBudgetPolicies

    ドキュメントセンター

    PolarDB:DescribeBudgetPolicies

    最終更新日: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:DescribeBudgetPolicies

    get

    *All resources.

    *

    		 なし なし

    リクエスト構文

    POST  HTTP/1.1

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    BudgetPolicyId

    string

    任意

    予算ポリシー ID。

    023aacc1effc4b56bb154bfbec6baxxx
    PageSize

    integer

    任意

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

    • 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

    レスポンスのスキーマ。

    RequestId

    string

    リクエストの ID。

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

    integer

    レコードの総数。

    2
    PageRecordCount

    integer

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

    1
    PageNumber

    integer

    ページ番号。

    1
    PageSize

    integer

    1 ページあたりのエントリ数。有効な値: 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

    例

    成功レスポンス

    JSONJSON

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

    エラーコード

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

    変更履歴

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