本文へジャンプします。

ニフクラ ユーザーガイド

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

DescribeDBEngineVersions

処理概要

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

指定するパラメーター

パラメーター 説明 必須
DBParameterGroupFamily string

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

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

値:
  • mysql5.6
  • mysql5.7
  • postgres9.3
  • postgres9.6
  • postgres11
  • mariadb10.1
DefaultOnly boolean

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

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

Engine string データベースエンジン
値:
  • MySQL
  • postgres
  • MariaDB
EngineVersion string

データベースエンジンのバージョン

  • ※例(MySQL):5.7.15

値:
MySQL の場合
  

クラウド技術仕様(RDB:MySQL)をご参照ください


PostgreSQL の場合
  

クラウド技術仕様(RDB:PostgreSQL)をご参照ください


MariaDB の場合
  

クラウド技術仕様(RDB:MariaDB)をご参照ください


ListSupportedCharacterSets boolean ※指定不可
Marker string

マーカー

  • ※ページネート用にDBエンジンバージョン一覧の取得位置を表す文字列です
  • ※前回のDescribeDBEngineVersionsリクエストで返却された値を指定します
  • ※この値が指定された場合、取得位置より後のDBエンジンバージョンが返却されます

MaxRecords integer レスポンスに含まれるレコードの最大値
Default: 100
使用可能文字: 20〜100

応答フィールド

フィールド (項目) 説明
DescribeDBEngineVersionsResponse structure ルート
DescribeDBEngineVersionsResult structure 結果
DBEngineVersions list DBエンジンバージョンリスト
DBEngineVersion structure DBエンジンバージョン
DBEngineDescription string データベースエンジンの説明
DBEngineVersionDescription string データベースエンジンのバージョン
DBParameterGroupFamily string データベースエンジンのDBパラメーターグループファミリー名
Engine string データベースエンジン
EngineVersion string データベースエンジンのバージョン
Marker string

前のリクエストで提供されるページを表す文字列(ページング用)

  • この値が指定された場合、レスポンスでマーカーを超えたレコードが最大MaxRecord個返される

ResponseMetadata structure 共通メタ情報
RequestId string リクエスト識別子

エラー

コード メッセージ タイプ HTTPステータスコード 説明
Client.InvalidParameterCombination.DBParameterGroupFamily.and.EngineVersion

Unknown major version ‘5.7.16’ for DB Parameter Group Family ‘mysql5.6’

Sender 400 DefaultOnly=trueの時、DBParameterGroupFamilyとEngineVersionの組み合わせが正しくない場合
Client.InvalidParameterCombination.Engine.and.EngineVersion
  • MySQLの場合
    Unknown major version ‘aaa’ for DB Engine ‘mysql’
  • PostgreSQLの場合
    Unknown major version ‘aaa’ for DB Engine ‘postgres’
  • MariaDBの場合
    Unknown major version ‘aaa’ for DB Engine ‘mariadb’
Sender 400 DefaultOnly=trueの時、EngineとEngineVersionの組み合わせが正しくない場合
Client.InvalidParameterEitherOf.Engine.or.DBParameterGroupFamily

Either Engine Name or DB Parameter Group Family must be specified with defaultOnly flag.

Sender 400 DefaultOnly=trueの時、EngineまたはDBParameterGroupFamilyを指定しなかった場合
Client.InvalidParameterIllegalInput.DefaultOnly
Sender 400 DefaultOnlyに真偽値型でない値を指定した場合
Client.InvalidParameterIllegalInput.Marker

Invalid marker: aaa. Please use the marker returned from the prior request or omit the marker parameter.

Sender 400 不正なMarkerを指定した場合
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でない値を指定した場合

リクエストサンプル

    https://jp-east-1.rdb.api.nifcloud.com/
  ?Action=DescribeDBEngineVersions
  &SignatureVersion=2
  &SignatureMethod=HmacSHA256
  &Timestamp=2013-12-09T00:00:00.000Z
  &AWSAccessKeyId=<NIFCLOUD Access Key ID>
  &Signature=<Signature>

  

応答サンプル

    <DescribeDBEngineVersionsResponse>
  <DescribeDBEngineVersionsResult>
    <DBEngineVersions>
      <DBEngineVersion>
        <DBEngineDescription>MySQL Community Edition</DBEngineDescription>
        <DBEngineVersionDescription>MySQL 5.7.15</DBEngineVersionDescription>
        <DBParameterGroupFamily>mysql5.7</DBParameterGroupFamily>
        <Engine>mysql</Engine>
        <EngineVersion>5.7.15</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>

  
  • ※本ページ記載の金額は、すべて税抜表示です。
  • ※本ページ記載の他社製品名および会社名などは、各社の商標または登録商標です。
  • ※本ページの内容は、2021年9月13日時点の情報です。

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