本文へジャンプします。

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

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

RDB:DescribeOrderableDBInstanceOptions

処理概要

特定のエンジンに紐づくDBサーバーオプションの情報を取得します。

リクエストパラメーター

要素名 説明 必須 最大値 デフォルト値 備考
DBInstanceClass DBサーバータイプ
値 : db. mini | db. e-small | db. small | db. e-small2 | db. small2 | db. e-small4 | db. small4 | db. e-small8 | db. small8 | db. e-medium | db. medium | db. e-medium4 | db. medium4 | db. e-medium8 | db. medium8 | db. e-medium16 | db. medium16 | db. e-large | db. large | db. e-large8 | db. large8 | db. e-large16 | db. large16 | db. e-large24 | db. large24 | db. e-large32 | db. large32 | db. e-extra-large16 | db. extra-large16 | db. e-extra-large24 | db. extra-large24 | db. e-extra-large32 | db. extra-large32 | db. e-double-large32 | db. double-large32 | db. e-double-large48 | db. double-large48 | db. e-double-large64 | db. double-large64
  文字列  
Engine

DBサーバーのエンジン名

  • ※大文字・小文字の区別はありません

値:MySQL | postgres

  文字列  
EngineVersion DBサーバーのエンジンバージョン
値(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
  文字列  
LicenseModel DBサーバーのライセンスモデル
値(MySQL):general-public-license
値(PostgreSQL):postgresql-license
値(MariaDB):general-public-license
  文字列  
Marker

マーカー

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

レスポンス

XML

status

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

result
要素名 説明 備考
DescribeOrderableDBInstanceOptionsResponse ルート  
DescribeOrderableDBInstanceOptionsResult 結果  
Marker マーカー 文字列  
OrderableDBInstanceOptions DBサーバーオプションリスト リスト  
OrderableDBInstanceOption DBサーバーオプション情報  
AvailabilityZones ゾーンリスト リスト  
AvailabilityZone ゾーン  
Name ゾーンの名前 文字列  
ProvisionedIopsCapable ゾーンがプロビジョンドIOPSを選択できるかどうか 真偽値 固定でfalseを返却
NiftyStorageTypes AvailabilityZoneで使用可能なストレージタイプのリスト リスト ニフティクラウド独自仕様
NiftyStorageType ストレージタイプ 数値 ニフティクラウド独自仕様
DBInstanceClass DBサーバータイプ 文字列  
Engine DBサーバーのエンジン 文字列  
EngineVersion DBサーバーのエンジンバージョン 文字列  
LicenseModel DBサーバーのライセンスモデル 文字列  
MultiAZCapable DBサーバーは multi-Azが有効かどうか 真偽値  
ReadReplicaCapable DBサーバーはリードレプリカがあるかどうか 真偽値  
Vpc DBサーバーはVPCが有効かどうか 真偽値 固定でfalseを返却
ResponseMetadata 共通メタ情報  

エラー

コード メッセージ タイプ HTTP
ステータスコード
説明
InvalidParameterValue Invalid DB engine: null Sender 400 必須パラメーターEngineを指定しなかった場合
Invalid DB engine: aa Sender 400 Engineに無効な値を指定した場合
Invalid marker: aaa. Please use the marker returned from the prior request or omit the marker parameter. Sender 400 不正なMarkerを指定した場合
Invalid value for max records. Must be between 20 and 100 Sender 400 MaxRecordsに20-100でない値を指定した場合
InvalidParameterCombination Cannot find version 5.5.32 for mysql
Cannot find version 9.x.x for postgresql
Cannot find version 10.1.10 for mariadb
Sender 400 対応していないEngineVersionを指定した場合
Invalid license model 'aaa' for engine 'mysql'. Valid license models are: general-public-license
Invalid license model 'aaa' for engine 'postgresql'. Valid license models are: postgres-public-license
Invalid license model 'aaa' for engine 'mariadb'. Valid license models are: general-public-license
Sender 400 エンジンに対応したLicenseModelを指定しなかった場合

サンプル

リクエストサンプル
https://rdb.jp-east-1.api.cloud.nifty.com/
    ?Action=DescribeOrderableDBInstanceOptions
    &Engine=mysql
    &DBInstanceClass=db.small
    &EngineVersion=5.6.12
    &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"?>
<DescribeOrderableDBInstanceOptionsResponse>
    <DescribeOrderableDBInstanceOptionsResult>
      <OrderableDBInstanceOptions>
        <OrderableDBInstanceOption>
            <AvailabilityZones>
                <AvailabilityZone>
                    <Name>east-12</Name>
                    <ProvisionedIopsCapable>false</ProvisionedIopsCapable>
                    <NiftyStorageTypes>
                        <NiftyStorageType>0</NiftyStorageType>
                    </NiftyStorageTypes>
                </AvailabilityZone>
                <AvailabilityZone>
                    <Name>east-13</Name>
                    <ProvisionedIopsCapable>false</ProvisionedIopsCapable>
                    <NiftyStorageTypes>
                        <NiftyStorageType>0</NiftyStorageType>
                        <NiftyStorageType>1</NiftyStorageType>
                    </NiftyStorageTypes>
                </AvailabilityZone>
                <AvailabilityZone>
                    <Name>east-14</Name>
                    <ProvisionedIopsCapable>false</ProvisionedIopsCapable>
                    <NiftyStorageTypes>
                        <NiftyStorageType>0</NiftyStorageType>
                        <NiftyStorageType>1</NiftyStorageType>
                    </NiftyStorageTypes>
                </AvailabilityZone>
            </AvailabilityZones>
            <DBInstanceClass>db.small</DBInstanceClass>
            <Engine>mysql</Engine>
            <EngineVersion>5.6.12</EngineVersion>
            <LicenseModel>general-public-license</LicenseModel>
            <MultiAZCapable>true</MultiAZCapable>
            <ReadReplicaCapable>true</ReadReplicaCapable>
            <Vpc>false</Vpc>
        </OrderableDBInstanceOption>
    </OrderableDBInstanceOptions>
  </DescribeOrderableDBInstanceOptionsResult>
  <ResponseMetadata>
    <RequestId>92ea6a4b-8be6-4079-99f8-98e5988fae33</RequestId>
  </ResponseMetadata>
</DescribeOrderableDBInstanceOptionsResponse>

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