パラメータの有効な値とデフォルト値の照会 - - Alibaba Cloud ドキュメントセンター

この操作を呼び出す前に、インスタンスが次のデータベースエンジンのいずれかを実行していることを確認してください。

MySQL 5.5、MySQL 5.6、MySQL 5.7、またはMySQL 8.0
SQL Server 2008 R2
PostgreSQL 10、PostgreSQL 11、PostgreSQL 12、PostgreSQL 13、PostgreSQL 14、またはPostgreSQL 15
MariaDB 10.3

デバッグ

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

リクエストパラメーター


項目	データ型	必須／任意	例:	説明
操作	String	必須	DescribeParameterTemplates	実行する操作です。値をDescribeParameterTemplatesに設定します。
ClientToken	String	任意	ETnLKlblzczshOTUbOCz ****	リクエストのべき等性を保証するために使用されるクライアントトークン。クライアントを使用して値を生成できますが、生成されたトークンが異なるリクエスト間で一意であることを確認する必要があります。トークンには ASCII 文字のみを含めることができ、長さは 64 文字を超えることはできません。
Engine	String	必須	mysql	インスタンスのデータベースエンジン。有効な値： mysql: MySQL mssql: SQL Server PostgreSQL: PostgreSQL MariaDB: MariaDB TX
EngineVersion	String	必須	8.0	インスタンスのデータベースエンジンバージョンです。 Engineパラメーターをmysqlに設定したときの有効な値: 5.5、5.6、5.7、および8.0。 Engineパラメーターをmssqlに設定したときの有効な値: 2008r 2。 EngineパラメーターをPostgreSQLに設定したときに有効な値: 10.0、11.0、12.0、13.0、14.0、および15.0。 EngineパラメーターをMariaDBに設定したときの有効な値: 10.3。
カテゴリー	String	任意	基本	インスタンスのRDSエディション。有効な値：基本: RDSベーシックエディション高可用性: RDS高可用性エディションファイナンス: RDS エンタープライズエディション
RegionId	String	任意	cn-hangzhou	インスタンスのリージョン ID です。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。
DBInstanceId	String	必須	rm-bp1imnm ****	インスタンスの ID です。

レスポンスパラメーター


項目	データ型	例:	説明
RequestId	String	0F9B7410-EC73-510C-B385-8339455C12C6	リクエストの ID です。
Engine	String	mysql	インスタンスのデータベースエンジン。
ParameterCount	String	2	パラメータの数。
EngineVersion	String	8.0	インスタンスのデータベースエンジンバージョンです。
パラメーター	TemplateRecordの配列		パラメーターに関する詳細で構成される配列。
TemplateRecord
CheckingCode	String	[0-1024]	パラメーターの有効な値。
ParameterName	String	loose_multi_blocks_ddl_count	パラメータの名前。
ParameterValue	String	0	パラメータのデフォルト値。
ForceModify	String	真実	パラメーターを再設定できるかどうかを示します。有効な値： true: パラメーターを再設定できます。 false: パラメーターを再設定できません。
ForceRestart	String	偽	変更を有効にするためにインスタンスを再起動する必要があるかどうかを示します。有効な値： true: 変更を有効にするには、インスタンスを再起動する必要があります。 false: 変更を有効にするためにインスタンスを再起動する必要はありません。
ParameterDescription	String	ddlクエリで1回読み取るマルチブロックのページ番号。	パラメーターの説明。

例

リクエストの例

http(s):// rds.aliyuncs.com/?Action=DescribeParameterTemplates
&ClientToken=ETnLKlblzczshOTUbOCz ****
&エンジン=mysql
&EngineVersion=8.0
&カテゴリ=基本
&RegionId=cn-hangzhou
&DBInstanceId=rm-bp1imnm ****
&共通リクエストパラメータ

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

XML 形式

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

<DescribeParameterTemplateesResponse>
    <ParameterCount>2</ParameterCount>
    <EngineVersion>8.0</EngineVersion>
    <Parameters>
        <TemplateRecord>
            <ForceModify>true</ForceModify>
            <CheckingCode>[オフ | オン]</CheckingCode>
            <ParameterValue>OFF</ParameterValue>
            <ForceRestart>false</ForceRestart>
            <ParameterName>loose_recycle_scheduler</ParameterName>
            <ParameterDescription> パージスレッドの切り替え。</ParameterDescription>
        </TemplateRecord>
        <TemplateRecord>
            <ForceModify>true</ForceModify>
            <CheckingCode>[0-1024]</CheckingCode>
            <ParameterValue>0</ParameterValue>
            <ForceRestart>false</ForceRestart>
            <ParameterName>loose_multi_blocks_ddl_count</ParameterName>
            <ParameterDescription> あるddlクエリで1回読み取るマルチブロックのページ番号。</ParameterDescription>
        </TemplateRecord>
    </Parameters>
    <RequestId>0F9B7410-EC73-510C-B385-8339455C12C6</RequestId>
    <Engine>mysql</Engine>
</DescribeParameterTemplesResponse>

JSON 形式

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

{
  "ParameterCount" : 2、
  "EngineVersion" : "8.0" 、
  "Parameters" : {
    "TemplateRecord" : [ {
      "ForceModify" : "true" 、
      "CheckingCode" : "[OFF | ON]" 、
      "ParameterValue" : "OFF" 、
      "ForceRestart" : "false" 、
      "ParameterName" : "loose_recycle_scheduler" 、
      "ParameterDescription" : "パージスレッドの切り替え" 。
    }, {
      "ForceModify" : "true" 、
      "CheckingCode" : "[0-1024]" 、
      "ParameterValue" : "0" 、
      "ForceRestart" : "false" 、
      "ParameterName" : "loose_multi_blocks_ddl_count" 、
      "ParameterDescription" : "あるddlクエリで一度読み取るマルチブロックのページ番号。
    } ]
  },
  "RequestId" : "0F9B7410-EC73-510C-B385-8339455C12C6" 、
  "エンジン" : "mysql"
}

エラーコード


HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	無効な. ParamGroupDBCategory	無効なパラメーターグループカテゴリ	パラメータグループのカテゴリが無効な場合に返されるエラーメッセージ。

エラーコードの一覧については、「サービスエラーコード」をご参照ください。