すべてのプロダクト
Search

このプロダクト

    PolarDB:DescribeParameterGroups

    ドキュメントセンター

    PolarDB:DescribeParameterGroups

    最終更新日:Sep 10, 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    polardbx:DescribeParameterGroups

    none

    *すべてのリソース。

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    任意

    インスタンスが存在するリージョン。

    cn-hangzhou

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスのスキーマ。

    RequestId

    string

    リクエスト ID。

    9B2F3840-5C98-475C-B269-2D5C3A31797C
    Data

    object

    インスタンスの詳細。

    RequestId

    string

    リクエスト ID。

    1E5DCFFC-A00D-****-836E-73318F8CA577
    ParameterGroups

    array<object>

    パラメータテンプレート名。

    object

    パラメータテンプレートのリスト。

    ParameterGroupId

    string

    パラメータテンプレートID。

    説明

    DescribeParameterGroups オペレーションを呼び出すことで、指定したリージョン内のすべてのパラメータテンプレートの詳細（パラメータテンプレートIDを含む）を照会できます。

    rpg-s1y1xy06****fqs7y
    GmtCreated

    string

    アカウントの作成時刻。

    2024-12-19T16:41:31+08:00
    GmtModified

    string

    変更時刻（タイムスタンプ形式）。

    1605079985000
    DbType

    string

    データベースのタイプ。

    polarx
    DbVersion

    string

    データベースエンジンのバージョン。

    5.7
    DnParamCount

    integer

    DN パラメータの数。

    10
    DnForceRestart

    boolean

    DN の強制再起動が必要かどうかを示します。

    CnParamCount

    integer

    CN パラメータの数。

    10
    CnForceRestart

    boolean

    CN の強制再起動が必要かどうかを示します。

    Series

    string

    インスタンスのエディション。有効な値：

    • enterprise：Enterprise Edition。

    • standard：Standard Edition。

    enterprise
    ParameterGroupName

    string

    パラメータテンプレート名。

    dstest_api_new
    ParameterGroupType

    string

    パラメータテンプレートのタイプ。

    0

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "9B2F3840-5C98-475C-B269-2D5C3A31797C",
  "Data": {
    "RequestId": "1E5DCFFC-A00D-****-836E-73318F8CA577",
    "ParameterGroups": [
      {
        "ParameterGroupId": "rpg-s1y1xy06****fqs7y",
        "GmtCreated": "2024-12-19T16:41:31+08:00",
        "GmtModified": "1605079985000",
        "DbType": "polarx",
        "DbVersion": "5.7",
        "DnParamCount": 10,
        "DnForceRestart": false,
        "CnParamCount": 10,
        "CnForceRestart": false,
        "Series": "enterprise",
        "ParameterGroupName": "dstest_api_new",
        "ParameterGroupType": "0"
      }
    ]
  }
}

    エラーコード

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

    変更履歴

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