DescribeEngineDefaultParameters
処理概要
指定したDBエンジンのデフォルトパラメーターの情報を取得します。
指定するパラメーター
パラメーター | 型 | 説明 | 必須 |
---|---|---|---|
DBParameterGroupFamily | string |
DBパラメーターグループファミリー名 |
○ |
Marker | string |
マーカー
|
|
MaxRecords | integer |
レスポンスに含まれるレコードの最大値 Default: 100 使用可能文字: 20〜100 |
応答フィールド
フィールド (項目) | 型 | 説明 |
---|---|---|
DescribeEngineDefaultParametersResponse | structure |
ルート |
␣DescribeEngineDefaultParametersResult | structure |
結果 |
␣␣EngineDefaults | structure |
エンジンデフォルトリスト |
␣␣␣Marker | string |
前のリクエストで提供されるページを表す文字列(ページング用)
|
␣␣␣DBParameterGroupFamily | string |
DBパラメーターグループファミリー |
␣␣␣Parameters | list |
パラメーターリスト |
␣␣␣␣Parameter | structure |
パラメーター |
␣␣␣␣␣AllowedValues | string |
パラメータ値の有効範囲 |
␣␣␣␣␣ApplyMethod | string |
パラメーターの適用方法
|
␣␣␣␣␣ApplyType | string |
パラメーターの適用タイプ
|
␣␣␣␣␣DataType | string |
パラメーターのデータ型 |
␣␣␣␣␣Description | string |
パラメーターの説明 |
␣␣␣␣␣IsModifiable | boolean |
修正できるかどうか |
␣␣␣␣␣MinimumEngineVersion | string |
パラメーターが適用できる一番古いエンジンバージョン |
␣␣␣␣␣ParameterName | string |
パラメーター名 |
␣␣␣␣␣ParameterValue | string |
パラメーター値 |
␣␣␣␣␣Source | string |
パラメーターを誰が定義したか
|
␣ResponseMetadata | structure |
共通メタ情報 |
␣␣RequestId | string |
リクエスト識別子 |
エラー
コード | メッセージ | タイプ | HTTPステータスコード | 説明 |
---|---|---|---|---|
Client.InvalidParameterIllegalInput.DBParameterGroupFamily | ParameterGroupFamily aaa is not a valid parameter group family |
Sender | 400 | 存在しないDBParameterGroupFamilyを指定した場合 |
Client.InvalidParameterIllegalInput.MaxRecords | Sender | 400 | MaxRecordsに数値でない値を指定した場合 | |
Client.InvalidParameterOutOfRange.MaxRecords | Invalid value for max records. Must be between 20 and 100 |
Sender | 400 | MaxRecordsに20-100でない値を指定した場合 |
Client.InvalidParameterRequired.DBParameterGroupFamily | The parameter ParameterGroupFamily must be provided and must not be empty. |
Sender | 400 | 必須のDBParameterGroupFamilyを指定しなかった場合 |
リクエストサンプル
https://jp-east-1.rdb.api.nifcloud.com/
?Action=DescribeEngineDefaultParameters
&DBParameterGroupFamily=mysql5.6
&MaxRecords=20
&SignatureVersion=2
&SignatureMethod=HmacSHA256
&Timestamp=2013-12-09T00:00:00.000Z
&AWSAccessKeyId=<NIFCLOUD Access Key ID>
&Signature=<Signature>
応答サンプル
<DescribeEngineDefaultParametersResponse>
<DescribeEngineDefaultParametersResult>
<EngineDefaults>
<DBParameterGroupFamily>mysql5.6</DBParameterGroupFamily>
<Marker>MDAwMDAwMDAyMA==</Marker>
<Parameters>
<Parameter>
<AllowedValues>0,1</AllowedValues>
<ApplyType>static</ApplyType>
<DataType>boolean</DataType>
<Description>Controls whether user-defined functions that have only an xxx symbol for the main function can be loaded</Description>
<IsModifiable>false</IsModifiable>
<ParameterName>allow-suspicious-udfs</ParameterName>
<Source>engine-default</Source>
</Parameter>
<Parameter>
<AllowedValues>0,1</AllowedValues>
<ApplyType>dynamic</ApplyType>
<DataType>boolean</DataType>
<Description>Sets the autocommit mode</Description>
<IsModifiable>true</IsModifiable>
<ParameterName>autocommit</ParameterName>
<Source>engine-default</Source>
</Parameter>
<Parameter>
<AllowedValues>0,1</AllowedValues>
<ApplyType>dynamic</ApplyType>
<DataType>boolean</DataType>
<Description>When this variable has a value of 1 (the default), the server automatically grants the EXECUTE and ALTER ROUTINE privileges to the creator of a stored routine, if the user cannot already execute and alter or drop the routine.</Description>
<IsModifiable>true</IsModifiable>
<ParameterName>automatic_sp_privileges</ParameterName>
<Source>engine-default</Source>
</Parameter>
<Parameter>
<AllowedValues>1-65535</AllowedValues>
<ApplyType>dynamic</ApplyType>
<DataType>integer</DataType>
<Description>Intended for use with master-to-master replication, and can be used to control the operation of AUTO_INCREMENT columns</Description>
<IsModifiable>true</IsModifiable>
<ParameterName>auto_increment_increment</ParameterName>
<Source>engine-default</Source>
</Parameter>
<Parameter>
<AllowedValues>1-65535</AllowedValues>
<ApplyType>dynamic</ApplyType>
<DataType>integer</DataType>
<Description>Determines the starting point for the AUTO_INCREMENT column value</Description>
<IsModifiable>true</IsModifiable>
<ParameterName>auto_increment_offset</ParameterName>
<Source>engine-default</Source>
</Parameter>
<Parameter>
<AllowedValues>1-65535</AllowedValues>
<ApplyType>static</ApplyType>
<DataType>integer</DataType>
<Description>The number of outstanding connection requests MySQL can have</Description>
<IsModifiable>true</IsModifiable>
<ParameterName>back_log</ParameterName>
<Source>engine-default</Source>
</Parameter>
<Parameter>
<ApplyType>static</ApplyType>
<DataType>string</DataType>
<Description>The MySQL installation base directory.</Description>
<IsModifiable>false</IsModifiable>
<ParameterName>basedir</ParameterName>
<ParameterValue>/rdbdbbin/mysql</ParameterValue>
<Source>system</Source>
</Parameter>
<Parameter>
<AllowedValues>4096-9223372036854775807</AllowedValues>
<ApplyType>dynamic</ApplyType>
<DataType>integer</DataType>
<Description>The size of the cache to hold the SQL statements for the binary log during a transaction.</Description>
<IsModifiable>true</IsModifiable>
<ParameterName>binlog_cache_size</ParameterName>
<ParameterValue>32768</ParameterValue>
<Source>system</Source>
</Parameter>
<Parameter>
<AllowedValues>NONE,CRC32</AllowedValues>
<ApplyType>dynamic</ApplyType>
<DataType>string</DataType>
<Description>When enabled, this variable causes the master to write a checksum for each event in the binary log.</Description>
<IsModifiable>true</IsModifiable>
<ParameterName>binlog_checksum</ParameterName>
<Source>engine-default</Source>
</Parameter>
<Parameter>
<AllowedValues>ROW,STATEMENT,MIXED</AllowedValues>
<ApplyType>dynamic</ApplyType>
<DataType>string</DataType>
<Description>Row / Statement or Mixed replication</Description>
<IsModifiable>false</IsModifiable>
<ParameterName>binlog_format</ParameterName>
<ParameterValue>MIXED</ParameterValue>
<Source>system</Source>
</Parameter>
<Parameter>
<AllowedValues>0-100000</AllowedValues>
<ApplyType>dynamic</ApplyType>
<DataType>integer</DataType>
<Description>How long in microseconds to keep reading transactions from the flush queue before proceeding with the group commit (and syncing the log to disk, if sync_binlog is greater than 0). If the value is 0 (the default), there is no timeout and the server keeps reading new transactions until the queue is empty.</Description>
<IsModifiable>true</IsModifiable>
<ParameterName>binlog_max_flush_queue_time</ParameterName>
<Source>engine-default</Source>
</Parameter>
<Parameter>
<AllowedValues>0,1</AllowedValues>
<ApplyType>dynamic</ApplyType>
<DataType>boolean</DataType>
<Description>If this variable is enabled (the default), transactions are committed in the same order they are written to the binary log. If disabled, transactions may be committed in parallel.</Description>
<IsModifiable>true</IsModifiable>
<ParameterName>binlog_order_commits</ParameterName>
<Source>engine-default</Source>
</Parameter>
<Parameter>
<AllowedValues>0,1</AllowedValues>
<ApplyType>dynamic</ApplyType>
<DataType>boolean</DataType>
<Description>When enabled, it causes a MySQL 5.6.2 or later server to write informational log events such as row query log events into its binary log.</Description>
<IsModifiable>false</IsModifiable>
<ParameterName>binlog_rows_query_log_events</ParameterName>
<Source>engine-default</Source>
</Parameter>
<Parameter>
<AllowedValues>full,minimal,noblob</AllowedValues>
<ApplyType>dynamic</ApplyType>
<DataType>string</DataType>
<Description>Whether the server logs full or minmal rows with row-based replication.</Description>
<IsModifiable>false</IsModifiable>
<ParameterName>binlog_row_image</ParameterName>
<Source>engine-default</Source>
</Parameter>
<Parameter>
<AllowedValues>4096-18446744073709547520</AllowedValues>
<ApplyType>dynamic</ApplyType>
<DataType>integer</DataType>
<Description>This variable determines the size of the cache for the binary log to hold nontransactional statements issued during a transaction.</Description>
<IsModifiable>true</IsModifiable>
<ParameterName>binlog_stmt_cache_size</ParameterName>
<Source>engine-default</Source>
</Parameter>
<Parameter>
<AllowedValues>0-9223372036854775807</AllowedValues>
<ApplyType>dynamic</ApplyType>
<DataType>integer</DataType>
<Description>Limits the size of the MyISAM cache tree in bytes per thread.</Description>
<IsModifiable>true</IsModifiable>
<ParameterName>bulk_insert_buffer_size</ParameterName>
<Source>engine-default</Source>
</Parameter>
<Parameter>
<AllowedValues>0,1</AllowedValues>
<ApplyType>static</ApplyType>
<DataType>boolean</DataType>
<Description>Don't ignore character set information sent by the client.</Description>
<IsModifiable>true</IsModifiable>
<ParameterName>character-set-client-handshake</ParameterName>
<Source>engine-default</Source>
</Parameter>
<Parameter>
<AllowedValues>big5,dec8,cp850,hp8,koi8r,latin1,latin2,swe7,ascii,ujis,sjis,hebrew,tis620,euckr,koi8u,gb2312,greek,cp1250,gbk,latin5,armscii8,utf8,ucs2,cp866,keybcs2,macce,macroman,cp852,latin7,utf8mb4,cp1251,utf16,cp1256,cp1257,utf32,binary,geostd8,cp932,eucjpms</AllowedValues>
<ApplyType>dynamic</ApplyType>
<DataType>string</DataType>
<Description>The character set for statements that arrive from the client.</Description>
<IsModifiable>true</IsModifiable>
<ParameterName>character_set_client</ParameterName>
<ParameterValue>utf8</ParameterValue>
<Source>system</Source>
</Parameter>
<Parameter>
<AllowedValues>big5,dec8,cp850,hp8,koi8r,latin1,latin2,swe7,ascii,ujis,sjis,hebrew,tis620,euckr,koi8u,gb2312,greek,cp1250,gbk,latin5,armscii8,utf8,ucs2,cp866,keybcs2,macce,macroman,cp852,latin7,utf8mb4,cp1251,utf16,cp1256,cp1257,utf32,binary,geostd8,cp932,eucjpms</AllowedValues>
<ApplyType>dynamic</ApplyType>
<DataType>string</DataType>
<Description>The character set used for literals that do not have a character set introducer and for number-to-string conversion.</Description>
<IsModifiable>true</IsModifiable>
<ParameterName>character_set_connection</ParameterName>
<ParameterValue>utf8</ParameterValue>
<Source>system</Source>
</Parameter>
<Parameter>
<AllowedValues>big5,dec8,cp850,hp8,koi8r,latin1,latin2,swe7,ascii,ujis,sjis,hebrew,tis620,euckr,koi8u,gb2312,greek,cp1250,gbk,latin5,armscii8,utf8,ucs2,cp866,keybcs2,macce,macroman,cp852,latin7,utf8mb4,cp1251,utf16,cp1256,cp1257,utf32,binary,geostd8,cp932,eucjpms</AllowedValues>
<ApplyType>dynamic</ApplyType>
<DataType>string</DataType>
<Description>The character set used by the default database.</Description>
<IsModifiable>true</IsModifiable>
<ParameterName>character_set_database</ParameterName>
<ParameterValue>utf8</ParameterValue>
<Source>system</Source>
</Parameter>
</Parameters>
</EngineDefaults>
</DescribeEngineDefaultParametersResult>
<ResponseMetadata>
<RequestId>d1a71208-2658-46b8-83a8-8c1042ce96d5</RequestId>
</ResponseMetadata>
</DescribeEngineDefaultParametersResponse>