DescribeParameterGroups操作を呼び出して、リージョンで使用可能なパラメーターテンプレートを照会できます。

パラメーターテンプレートを使用して一度に多数のパラメーターを設定し、パラメーターテンプレートをインスタンスに適用できます。 詳細については、「パラメータテンプレートを使用してApsaraDB RDS For MySQLインスタンスのパラメータを設定する」または「パラメータテンプレートを使用してApsaraDB RDS for PostgreSQLインスタンスのパラメータを設定する」をご参照ください。

説明 パラメータテンプレートは、ApsaraDB RDS for MySQLインスタンスおよびApsaraDB RDS for PostgreSQLインスタンスにのみ適用できます。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

項目 データ型 必須／任意 例: 説明　
操作 String 必須 DescribeParameterGroups

実行する操作です。 このパラメーターをDescribeParameterGroupsに設定します。

RegionId String 必須 cn-hangzhou

インスタンスのリージョン ID です。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。

ResourceGroupId String 任意 rg-acfmy ****

リソースグループの ID です。

レスポンスパラメーター

項目 データ型 例: 説明　
SignalForOptimizeParams ブール 偽

指定したリージョンにパラメータテンプレートが存在するかどうかを示します。 有効な値：

  • 真実
  • 偽
RequestId String D4A23265-C5B6-42E1-98A0-EFA1EB42E723

リクエストの ID です。

ParameterGroups ParameterGroupの配列

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

ParameterGroup
UpdateTime String 2019-11-21T02:21:35Z

パラメーターテンプレートが最後に更新された時刻。 日時は ISO 8601 規格 (yyyy-MM-ddTHH:mm:ssZ 形式) に準拠します。 時刻は UTC で表示されます。

ParameterGroupDesc String 1

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

  • 0: デフォルトのパラメータテンプレート。
  • 1: カスタムパラメーターテンプレート。
  • 2: 自動バックアップパラメータテンプレート。 このタイプのテンプレートを適用すると、元のパラメーター設定が自動的にバックアップされ、バックアップがテンプレートとして保存されます。
CreateTime String 2019-11-21T01:48:39Z

パラメーターテンプレートが作成された時刻。 日時は ISO 8601 規格 (yyyy-MM-ddTHH:mm:ssZ 形式) に準拠します。 時刻は UTC で表示されます。

ForceRestart Integer 1

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

  • 0: 再起動は必要ありません。
  • 1: 再起動が必要です。
ParameterGroupId String rpg-****

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

ParameterGroupName String test1234

パラメータテンプレートの名前を設定します。

Engine String mysql

データベースエンジン。

パラムカウント Integer 2

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

EngineVersion String 5.7

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

ParameterGroupType Integer 1

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

  • 0: デフォルトのパラメータテンプレート。
  • 1: カスタムパラメーターテンプレート。
  • 2: 自動バックアップパラメータテンプレート。 このタイプのテンプレートを適用すると、元のパラメーター設定が自動的にバックアップされ、バックアップがテンプレートとして保存されます。

例

リクエストの例

http(s):// rds.aliyuncs.com/?Action=DescribeParameterGroups
&RegionId=cn-hangzhou
&共通リクエストパラメータ

正常に処理された場合のレスポンス例

XML 形式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeParameterGroupsResponse>
    <SignalForOptimizeParams>false</SignalForOptimizeParams>
    <RequestId>D4A23265-C5B6-42E1-98A0-EFA1EB42E723</RequestId>
    <ParameterGroups>
        <UpdateTime>2019-11-21T02:21:35Z</UpdateTime>
        <ParameterGroupDesc>1</ParameterGroupDesc>
        <CreateTime>2019-11-21T01:48:39Z</CreateTime>
        <ForceRestart>1</ForceRestart>
        <ParameterGroupId>rpg-****</ParameterGroupId>
        <ParameterGroupName>test1234</ParameterGroupName>
        <Engine>mysql</Engine>
        <ParamCounts>2</ParamCounts>
        <EngineVersion>5.7</EngineVersion>
        <ParameterGroupType>1</ParameterGroupType>
    </ParameterGroups>
</DescribeParameterGroupsResponse>

JSON 形式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "SignalForOptimizeParams" : false、
  "RequestId" : "D4A23265-C5B6-42E1-98A0-EFA1EB42E723" 、
  "ParameterGroups" : [ {
    "UpdateTime" : "2019-11-21T02:21:35Z" 、
    "ParameterGroupDesc" : "1" 、
    "CreateTime" : "2019-11-21T01:48:39Z" 、
    "ForceRestart" : 1、
    "ParameterGroupId" : "rpg-****" 、
    "ParameterGroupName" : "test1234" 、
    "エンジン" : "mysql" 、
    "ParamCounts" : 2、
    "EngineVersion" : "5.7" 、
    "ParameterGroupType" : 1
  } ]
}

エラーコード

エラーコードリストについては、「API エラーセンター」をご参照ください。