パラメーターテンプレートに関する情報の照会 - - Alibaba Cloud ドキュメントセンター

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

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

デバッグ

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

リクエストパラメーター


項目	データ型	必須／任意	例:	説明
操作	String	必須	DescribeParameterGroup	実行する操作です。値をDescribeParameterGroupに設定します。
ParameterGroupId	String	必須	rpg-dp ****	パラメーターテンプレートのID。 DescribeParameterGroups操作を呼び出して、パラメーターテンプレートのIDを照会できます。
RegionId	String	必須	cn-hangzhou	パラメーターテンプレートのリージョンID。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。

レスポンスパラメーター


項目	データ型	例:	説明
RequestId	String	498AE8CA-8C81-4A01-AF37-2B902014ED30	リクエストの ID です。
ParamGroup	ParameterGroupの配列		パラメーターテンプレートに関する情報。
ParameterGroup
UpdateTime	String	2019-10-22T06:07:54Z	パラメーターテンプレートが最後に更新された時刻。日時は ISO 8601 規格 (yyyy-MM-ddTHH:mm:ssZ 形式) に準拠します。時刻は UTC で表示されます。
ParameterGroupDesc	String	testGroup1	パラメーターテンプレートの説明。
CreateTime	String	2019-10-22T06:02:53Z	パラメーターテンプレートが作成された時刻。
ForceRestart	Integer	1	パラメーターテンプレートを有効にするためにインスタンスの再起動が必要かどうかを示します。有効な値： 0: 再起動は必要ありません。 1: 再起動が必要です。
ParameterGroupId	String	rpg-dp ****	パラメーターテンプレートのID。
ParameterGroupName	String	test123456	パラメータテンプレートの名前を設定します。
Engine	String	mysql	データベースエンジン。
パラムカウント	Integer	2	パラメーターテンプレート内のパラメーターの数。
EngineVersion	String	5.6	データベースエンジンのバージョン。
ParameterGroupType	Integer	1	パラメーターテンプレートの型。有効な値： 0: デフォルトのパラメータテンプレート。 1: カスタムパラメーターテンプレート。 2: 自動バックアップパラメーターテンプレート。このタイプのテンプレートを適用すると、元のパラメーター設定が自動的にバックアップされ、バックアップがテンプレートとして保存されます。
ParamDetail	ParameterDetailの配列		パラメーターの配列。
ParameterDetail
ParamName	String	back_log	パラメータの名前。
ParamValue	String	2000	パラメータの値。
RelatedCustinsInfo	RelatedCustinsInfoの配列		パラメーターテンプレートが適用されたインスタンス。説明 RelatedCustinsInfoパラメーターは、ApsaraDB RDS for PostgreSQLインスタンスでのみ使用できます。
RelatedCustinsInfo
DBInstanceName	String	rm-bp170 ****	インスタンスの ID です。
AppliedTime	String	2022-10-17T03:19:02Z	パラメーターテンプレートが適用された時刻。

例

リクエストの例

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

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

XML 形式

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

<DescribeParameterGroupResponse>
    <RequestId>498AE8CA-8C81-4A01-AF37-2B902014ED30</RequestId>
    <ParamGroup>
        <UpdateTime>2019-10-22T06:07:54Z</UpdateTime>
        <ParameterGroupDesc>testGroup1</ParameterGroupDesc>
        <CreateTime>2019-10-22T06:02:53Z</CreateTime>
        <ForceRestart>1</ForceRestart>
        <ParameterGroupId>rpg-dp ****</ParameterGroupId>
        <ParameterGroupName>test123456</ParameterGroupName>
        <Engine>mysql</Engine>
        <ParamCounts>2</ParamCounts>
        <EngineVersion>5.6</EngineVersion>
        <ParameterGroupType>1</ParameterGroupType>
        <ParamDetail>
            <ParamName>back_log</ParamName>
            <ParamValue>2000</ParamValue>
        </ParamDetail>
    </ParamGroup>
    <RelatedCustinsInfo>
        <DBInstanceName>rm-bp170 ****</DBInstanceName>
        <AppliedTime>2022-10-17T03:19:02Z</AppliedTime>
    </RelatedCustinsInfo>
</DescribeParameterGroupResponse>

JSON 形式

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

{
  "RequestId" : "498AE8CA-8C81-4A01-AF37-2B902014ED30" 、
  "ParamGroup" : [ {
    "UpdateTime" : "2019-10-22T06:07:54Z" 、
    "ParameterGroupDesc" : "testGroup1" 、
    "CreateTime" : "2019-10-22T06:02:53Z" 、
    "ForceRestart" : 1、
    "ParameterGroupId" : "rpg-dp ****" 、
    "ParameterGroupName" : "test123456" 、
    "エンジン" : "mysql" 、
    "ParamCounts" : 2、
    "EngineVersion" : "5.6" 、
    "ParameterGroupType" : 1、
    "ParamDetail" : [ {
      "ParamName" : "back_log" 、
      "ParamValue" : "2000"
    } ]
  } ],
  "RelatedCustinsInfo" : [ {
    "DBInstanceName" : "rm-bp170 ****" 、
    "AppliedTime" : "2022-10-17T03:19:02Z"
  } ]
}

エラーコード

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