本文へジャンプします。

ニフティクラウド APIリファレンス

クラウド トップ>API>RDB>DescribeDBParameters

RDB:DescribeDBParameters

処理概要

DBパラメーターグループからパラメーターの情報を取得します。

リクエストパラメーター

要素名 説明 必須 最大値 デフォルト値 備考
DBParameterGroupName DBパラメーターグループ名 文字列  
Marker

マーカー

  • ※ページネート用にパラメーター一覧の取得位置を表す文字列です
  • ※前回のDescribeDBParametersリクエストで返却された値を指定します
  • ※この値が指定された場合、取得位置より後のパラメーターが返却されます
  文字列    
MaxRecords レスポンスに含まれるレコードの最大値
値:20〜100
  数値 20-100 100  
Source

パラメーターを誰が定義したか

  • ※何も指定しない場合、すべてのタイプのパラメーターが返却されます
値:user(ユーザー定義) | system(ニフティクラウドRDBが定義) | engine-default(DBエンジンのデフォルト値)
  文字列 すべてのパラメーター  

レスポンス

XML

status

statusは共通の応答メッセージを返却します。

result
要素名 説明 備考
DescribeDBParametersResponse ルート  
DescribeDBParametersResult 結果  
Marker マーカー 文字列  
Parameters パラメーターリスト リスト  
Parameter パラメーター  
AllowedValues パラメータ値の有効範囲 文字列  
ApplyMethod パラメーターの適用方法
値:immediate(今すぐ) | pending-reboot(再起動待ち)
文字列  
ApplyType パラメーターの適用タイプ
値:dynamic | static
文字列  
DataType パラメーターのデータ型 文字列  
Description パラメーターの説明 文字列  
IsModifiable 修正できるかどうか 真偽値  
MinimumEngineVersion パラメーターが適応できる一番古いエンジンバージョン 文字列  
ParameterName パラメーター名 文字列  
ParameterValue パラメーター値 文字列  
Source パラメーターを誰が定義したか
値:user(ユーザー定義) | system(ニフティクラウドRDBが定義) | engine-default(DBエンジンのデフォルト値)
文字列  
ResponseMetadata 共通メタ情報  

エラー

コード メッセージ タイプ HTTP
ステータスコード
説明
DBParameterGroupNotFound DBParameterGroup not found: aaaa Sender 404 DBParameterGroupNameに存在しないDBパラメーターグループ名を指定した場合
InvalidParameterValue DBParameterGroupName is required Sender 400 必須のDBParameterGroupNameを指定しなかった場合
The parameter DBParameterGroupName is not a valid identifier.
Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.
Sender 400 DBParameterGroupNameに無効な(数字から始まるなど)値を指定した場合
The parameter DBParameterGroupName is not a valid identifier because it is longer than 255 characters. Sender 400 DBParameterGroupNameに255文字以上指定した場合
Invalid value for max records. Must be between 20 and 100 Sender 400 MaxRecordsに20-100でない値を指定した場合
Invalid Source: aaa. Allowed values are: engine-default, system, user Sender 400 Sourceに無効な値を指定した場合

サンプル

リクエストサンプル
https://rdb.jp-east-1.api.cloud.nifty.com/
    ?Action=DescribeDBParameters
    &DBParameterGroupName=mydbparametergroup
    &MaxRecords=20
    &SignatureVersion=2
    &SignatureMethod=HmacSHA256
    &Timestamp=2013-12-09T00%3A00%3A00.000Z
    &AWSAccessKeyId=<Nifty Cloud Access Key ID>
    &Signature=<Signature>
レスポンスサンプル
<DescribeDBParametersResponse>
  <DescribeDBParametersResult>
  <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>
</DescribeDBParametersResult>
  <ResponseMetadata>
  <RequestId>494683bd-73df-4d30-b39a-3943c17e530d</RequestId>
</ResponseMetadata>
</DescribeDBParametersResponse>

推奨画面サイズ 1024×768 以上