すべてのプロダクト
Search

このプロダクト

    PolarDB:DescribeParameterGroups

    ドキュメントセンター

    PolarDB:DescribeParameterGroups

    最終更新日:Dec 11, 2025

    この操作は、指定されたリージョン内のパラメーターテンプレートを照会します。

    操作説明

    パラメーターテンプレートを使用すると、クラスターのパラメーターをバッチで管理し、PolarDB クラスターに迅速に適用できます。詳細については、「パラメーターテンプレートの使用」をご参照ください。

    説明

    この機能は、PolarDB for MySQL クラスターでのみ利用可能です。

    今すぐお試しください

    この 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:DescribeParameterGroups

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    リージョン ID。

    説明

    DescribeRegions 操作を呼び出して、リージョン ID を含む、アカウントで利用可能なすべてのリージョンの情報を照会できます。

    cn-hangzhou
    DBType

    string

    任意

    データベースエンジンのタイプ。MySQL のみがサポートされています。

    MySQL
    DBVersion

    string

    任意

    データベースエンジンのバージョン。有効な値：

    • 5.6

    • 5.7

    • 8.0

    8.0
    ResourceGroupId

    string

    任意

    リソースグループの ID。

    rg-************

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答のスキーマ

    RequestId

    string

    リクエスト ID。

    944CED46-A6F7-40C6-B6DC-C6E5CC******
    ParameterGroups

    array<object>

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

    object

    DBType

    string

    データベースエンジンのタイプ。

    MySQL
    DBVersion

    string

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

    8.0
    ParameterGroupName

    string

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

    test
    ForceRestart

    string

    パラメーターテンプレートを有効にするためにクラスターの再起動が必要かどうかを示します。有効な値：

    • 0：再起動は不要です。

    • 1：再起動が必要です。

    1
    ParameterGroupType

    string

    パラメーターテンプレートのタイプ。有効な値：

    • 0：システムのデフォルトテンプレート

    • 1：ユーザー定義テンプレート

    • 2：自動バックアップテンプレート (新しいテンプレートを適用した後、システムは以前のパラメーター設定をテンプレートとして自動的にバックアップします。)

    1
    ParameterCounts

    integer

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

    2
    ParameterGroupDesc

    string

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

    testgroup
    CreateTime

    string

    パラメーターテンプレートが作成された時間。時間は yyyy-MM-ddTHH:mm:ssZ 形式の UTC 時間です。

    2023-03-10T08:40:39Z
    ParameterGroupId

    string

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

    pcpg-**************

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "944CED46-A6F7-40C6-B6DC-C6E5CC******",
  "ParameterGroups": [
    {
      "DBType": "MySQL",
      "DBVersion": "8.0",
      "ParameterGroupName": "test",
      "ForceRestart": "1",
      "ParameterGroupType": "1",
      "ParameterCounts": 2,
      "ParameterGroupDesc": "testgroup",
      "CreateTime": "2023-03-10T08:40:39Z",
      "ParameterGroupId": "pcpg-**************"
    }
  ]
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InvalidRegionId.Malformed The specified parameter RegionId is not valid.
    400 InvalidEngine.Unsupported The specified Engine does not support this feature.

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

    変更履歴

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