本文へジャンプします。

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

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

RDB:DescribeDBEngineVersions

処理概要

データベースエンジンのバージョン情報を取得します。

リクエストパラメーター

要素名 説明 必須 最大値 デフォルト値 備考
DBParameterGroupFamily

DBパラメーターグループファミリー名

  • ※DescribeDBParameterGroups APIで取得できる値を指定します

値:mysql5.5 | mysql5.6 | mysql5.7 | postgres9.3 | mariadb10.1

  文字列  
DefaultOnly

デフォルトバージョンのみ表示するかどうか

  • ※このパラメーターを指定する場合、Engine か DBParameterGroupFamilyを指定する必要があります
  真偽値  
Engine

データベースエンジン

値:MySQL | postgres | MariaDB

  文字列  
EngineVersion データベースエンジンのバージョン
値(MySQL):5.5.32 | 5.5.40 | 5.5.41 | 5.5.53 | 5.6.12 | 5.6.21 | 5.6.22 | 5.6.34 | 5.7.15
値(PostgreSQL):9.3.4
値(MariaDB) : 10.1.14 | 10.1.18
  文字列  
ListSupportedCharacterSets ※指定不可   真偽値  
Marker

マーカー

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

レスポンス

XML

status

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

result
要素名 説明 備考
DescribeDBEngineVersionsResponse ルート  
DescribeDBEngineVersionsResult 結果  
DBEngineVersions DBエンジンバージョンリスト リスト  
DBEngineVersion DBエンジンバージョン  
DBEngineDescription データベースエンジンの説明 文字列  
DBEngineVersionDescription データベースエンジンのバージョン 文字列  
DBParameterGroupFamily データベースエンジンのDBパラメーターグループファミリー名 文字列  
Engine データベースエンジン 文字列  
EngineVersion データベースエンジンのバージョン 文字列  
Marker マーカー 文字列  
ResponseMetadata 共通メタ情報  

エラー

コード メッセージ タイプ HTTP
ステータスコード
説明
InvalidParameterCombination Either Engine Name or DB Parameter Group Family must be specified with defaultOnly flag. Sender 400 DefaultOnly=trueにしてEngineかDB Parameter Group Familyを指定しなかった場合
InvalidParameterValue Invalid marker: i??. Please use the marker returned from the prior request or omit the marker parameter. Sender 400 不正なMarkerを指定した場合
  • MySQLの場合
    Unknown major version 'ssss' for DB Engine 'mysql'
  • PostgreSQLの場合
    Unknown major version 'ssss' for DB Engine 'postgres'
  • MariaDBの場合
    Unknown major version 'ssss' for DB Engine 'mariadb'
Sender 400 DefaultOnly=trueのとき、Engine、EngineVersionの組み合わせが正しくない場合
Unknown major version 'ddd' for DB Parameter Group Family 'tttt' Sender 400 DefaultOnly=trueのとき、DB Parameter Group、EngineVersionの組み合わせが正しくない場合
Invalid value for max records. Must be between 20 and 100 Sender 400 MaxRecordsに20-100でない値を指定した場合

サンプル

リクエストサンプル
https://rdb.jp-east-1.api.cloud.nifty.com/
    ?Action=DescribeDBEngineVersions
    &SignatureVersion=2
    &SignatureMethod=HmacSHA256
    &Timestamp=2013-12-09T00%3A00%3A00.000Z
    &AWSAccessKeyId=<Nifty Cloud Access Key ID>
    &Signature=<Signature>
レスポンスサンプル
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<DescribeDBEngineVersionsResponse>
 <DescribeDBEngineVersionsResult>
  <DBEngineVersions>
   <DBEngineVersion>
    <DBEngineDescription>MySQL Community Edition</DBEngineDescription>
    <DBEngineVersionDescription>MySQL 5.5.32</DBEngineVersionDescription>
    <DBParameterGroupFamily>mysql5.5</DBParameterGroupFamily>
    <Engine>mysql</Engine>
    <EngineVersion>5.5.32</EngineVersion>
   </DBEngineVersion>
   <DBEngineVersion>
    <DBEngineDescription>MySQL Community Edition</DBEngineDescription>
    <DBEngineVersionDescription>MySQL 5.6.12</DBEngineVersionDescription>
    <DBParameterGroupFamily>mysql5.6</DBParameterGroupFamily>
    <Engine>mysql</Engine>
    <EngineVersion>5.6.12</EngineVersion>
  </DBEngineVersion>
  <DBEngineVersion>
    <DBEngineDescription>PostgreSQL</DBEngineDescription>
    <DBEngineVersionDescription>PostgreSQL 9.3.4</DBEngineVersionDescription>
    <DBParameterGroupFamily>postgres9.3</DBParameterGroupFamily>
    <Engine>postgres</Engine>
    <EngineVersion>9.3.4</EngineVersion>
   </DBEngineVersion>
  </DBEngineVersions>
 </DescribeDBEngineVersionsResult>
 <ResponseMetadata>
  <RequestId>241ef690-48e2-49ee-b4ef-9990bf5a6bf3</RequestId>
 </ResponseMetadata>
</DescribeDBEngineVersionsResponse>

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