すべてのプロダクト
Search

このプロダクト

    PolarDB:DescribeRateLimitPolicy

    ドキュメントセンター

    PolarDB:DescribeRateLimitPolicy

    最終更新日:May 22, 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:DescribeRateLimitPolicy

    get

    *All Resource

    *

    		 なし なし

    リクエスト構文

    POST  HTTP/1.1

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    任意

    リージョン ID です。

    cn-beijing
    GwClusterId

    string

    必須

    ゲートウェイインスタンスの ID です。

    pg-xxxxxxx
    PolicyId

    string

    任意

    レート制限ポリシーの ID です。

    02eccf7c61cf4d05a543075ee907f3**
    ScopeType

    string

    任意

    レート制限ポリシーのスコープ。有効な値：

    • ConsumerGroup ：ポリシーはコンシューマーグループに適用されます。

    • Consumer ：ポリシーは特定のコンシューマーに適用されます。

    ConsumerGroup

    ScopeRefId

    string

    任意

    ターゲットリソースの ID です。ScopeType の値に応じて、コンシューマーグループまたはコンシューマーの ID を指定できます。

    cg-xxxxxxxx
    PageSize

    integer

    任意

    ページあたりのエントリ数。デフォルト値は 30 です。有効な値：

    • 30

    • 50

    • 100

    30
    PageNumber

    integer

    任意

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

    1

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスオブジェクトです。

    RequestId

    string

    リクエスト ID です。

    CED079B7-A408-41A1-BFF1-EC608E******
    TotalRecordCount

    string

    一致するエントリの総数です。

    1
    PageSize

    string

    1 ページあたりに返されるエントリ数です。

    30
    PageNumber

    string

    返されたページ番号です。

    1
    PageRecordCount

    string

    現在のページで返されるエントリ数です。

    30
    Items

    array<object>

    レート制限ポリシーオブジェクトの配列です。

    object

    レート制限ポリシーオブジェクトです。

    PolicyId

    string

    レート制限ポリシーの ID です。

    02eccf7c61cf4d05a543075ee907f3**

    GwClusterId

    string

    ゲートウェイインスタンスの ID です。

    pg-xxxxxxxx
    PolicyType

    string

    ポリシータイプです。

    RateLimit
    ScopeType

    string

    ポリシーのスコープです。有効な値：

    • ConsumerGroup：ポリシーはコンシューマーグループに適用されます。

    • Consumer：ポリシーは特定のコンシューマーに適用されます。

    ConsumerGroup

    ScopeRefId

    string

    ポリシーのスコープ内のオブジェクト (コンシューマーグループやコンシューマーなど) の ID です。

    cg-xxxxxxx
    RateLimitRpm

    string

    1 分あたりの最大リクエスト数 (RPM) です。

    10
    RateLimitTpm

    string

    1 分あたりの最大トークン数 (TPM) です。

    10
    Status

    string

    ポリシーのステータスです。有効な値：

    • Enabled：ポリシーは有効です。

    • Disabled：ポリシーは無効です。

    Enabled
    GmtCreated

    string

    作成時刻です。

    2025-12-01T17:52:05+08:00
    GmtModified

    string

    変更時刻です。

    2026-01-19T16:47:25+08:00

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "CED079B7-A408-41A1-BFF1-EC608E******",
  "TotalRecordCount": "1",
  "PageSize": "30",
  "PageNumber": "1",
  "PageRecordCount": "30",
  "Items": [
    {
      "PolicyId": "02eccf7c61cf4d05a543075ee907f3**\n",
      "GwClusterId": "pg-xxxxxxxx",
      "PolicyType": "RateLimit",
      "ScopeType": "ConsumerGroup ",
      "ScopeRefId": "cg-xxxxxxx",
      "RateLimitRpm": "10",
      "RateLimitTpm": "10",
      "Status": "Enabled",
      "GmtCreated": "2025-12-01T17:52:05+08:00",
      "GmtModified": "2026-01-19T16:47:25+08:00"
    }
  ]
}

    エラーコード

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

    変更履歴

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