ニフクラAPI (RDB: DescribeOrderableDBInstanceOptions)

【重要なお知らせ】サービス統合に基づくサービス名称の読み替えのお願い（2024年4月1日）

2024年4月1日をもって、「ニフクラ」は、「FJcloud-V」に統合し、名称を変更しました。
当サイトのアドレス（ドメイン名）に含まれる「nifcloud.com」は現時点では変更はございませんが、
各ページに記載の「ニフクラ」「NIFCLOUD」「nifcloud」は、「FJcloud-V」に読み替えていただきますようお願いいたします。

ニフクラユーザーガイド

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

DescribeOrderableDBInstanceOptions

処理概要

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

指定するパラメーター

パラメーター	型	説明
DBInstanceClass	string	DBサーバータイプ値: db.e-small db.small db.e-small2 db.small2 db.e-small4 db.small4 db.e-small8 db.small8 db.e-small16 db.small16 db.e-medium db.medium db.e-medium4 db.medium4 db.e-medium8 db.medium8 db.e-medium16 db.medium16 db.e-medium24 db.medium24 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-large8 db.extra-large8 db.e-extra-large16 db.extra-large16 db.e-extra-large24 db.extra-large24 db.e-extra-large32 db.extra-large32 db.e-extra-large48 db.extra-large48 db.e-double-large16 db.double-large16 db.e-double-large24 db.double-large24 db.e-double-large32 db.double-large32 db.e-double-large48 db.double-large48 db.e-double-large64 db.double-large64 db.e-double-large96 db.double-large96 db.triple-large32 db.triple-large48 db.triple-large64 db.triple-large96 db.triple-large128 db.quad-large64 db.quad-large96 db.quad-large128 db.septa-large128
Engine	string	DBサーバーのエンジン名 ※大文字・小文字の区別はありません値: MySQL postgres
EngineVersion	string	DBサーバーのエンジンバージョン ※例（MySQL）：5.7.15 値: MySQL の場合クラウド技術仕様/制限値(RDB:MySQL)をご参照ください PostgreSQL の場合クラウド技術仕様/制限値(RDB:PostgreSQL)をご参照ください
LicenseModel	string	DBサーバーのライセンスモデル値: MySQL の場合 general-public-license PostgreSQL の場合 postgresql-license
Marker	string	マーカー ※ページネート用にDBサーバーオプション一覧の取得位置を表す文字列です ※前回のDescribeDBOrderableDBInstanceOptionsリクエストで返却された値を指定します ※この値が指定された場合、取得位置より後のDBサーバーオプションが返却されます
MaxRecords	integer	レスポンスに含まれるレコード数 Default: 100 使用可能文字: 20〜100
Vpc	boolean	※指定不可

応答フィールド

フィールド (項目)	型	説明
DescribeOrderableDBInstanceOptionsResponse	structure	ルート
␣DescribeOrderableDBInstanceOptionsResult	structure	結果
␣␣Marker	string	前のリクエストで提供されるページを表す文字列（ページング用）この値が指定された場合、レスポンスでマーカーを超えたレコードが最大MaxRecord個返される
␣␣OrderableDBInstanceOptions	list	DBサーバーオプションリスト
␣␣␣OrderableDBInstanceOption	structure	DBサーバーオプション情報
␣␣␣␣AvailabilityZones	list	ゾーンリスト
␣␣␣␣␣AvailabilityZone	structure	ゾーン
␣␣␣␣␣␣Name	string	ゾーンの名前
␣␣␣␣␣␣ProvisionedIopsCapable	boolean	ゾーンがプロビジョンドIOPSを選択できるかどうか備考: 固定でfalseを返却
␣␣␣␣␣␣NiftyStorageTypes	list	AvailabilityZoneで使用可能なストレージタイプのリスト備考: ニフクラ独自仕様
␣␣␣␣␣␣␣NiftyStorageType	integer	ストレージタイプ備考: ニフクラ独自仕様
␣␣␣␣DBInstanceClass	string	DBサーバータイプ
␣␣␣␣Engine	string	DBサーバーのエンジン
␣␣␣␣EngineVersion	string	DBサーバーのエンジンバージョン
␣␣␣␣LicenseModel	string	DBサーバーのライセンスモデル
␣␣␣␣MultiAZCapable	boolean	DBサーバーは multi-Azが有効かどうか
␣␣␣␣ReadReplicaCapable	boolean	DBサーバーはリードレプリカがあるかどうか
␣␣␣␣Vpc	boolean	DBサーバーはVPCが有効かどうか備考: 固定でfalseを返却
␣ResponseMetadata	structure	共通メタ情報
␣␣RequestId	string	リクエスト識別子

エラー

コード	メッセージ	タイプ	HTTPステータスコード	説明
Client.InvalidParameterIllegalInput.Engine	Invalid DB engine: aaa	Sender	400	Engineに無効な値を指定した場合
Client.InvalidParameterIllegalInput.EngineVersion	MySQLの場合 Cannot find version 5.7.32 for mysql PostgreSQLの場合 Cannot find version 9.x for postgres	Sender	400	対応していないEngineVersionを指定した場合
Client.InvalidParameterIllegalInput.LicenseModel	MySQLの場合 Invalid license model ‘aaa’ for engine ‘mysql’. Valid license models are: general-public-license PostgreSQLの場合 Invalid license model ‘aaa’ for engine ‘postgres’. Valid license models are: postgresql-license	Sender	400	LicenseModelに無効な値を指定した場合
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でない値を指定した場合
Client.InvalidParameterRequired.Engine	Invalid DB engine: null	Sender	400	必須のEngineを指定しなかった場合

リクエストサンプル

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

応答サンプル

    <DescribeOrderableDBInstanceOptionsResponse>
  <DescribeOrderableDBInstanceOptionsResult>
    <OrderableDBInstanceOptions>
      <OrderableDBInstanceOption>
        <AvailabilityZones>
          <AvailabilityZone>
            <Name>east-11</Name>
            <ProvisionedIopsCapable>false</ProvisionedIopsCapable>
            <NiftyStorageTypes>
              <NiftyStorageType>0</NiftyStorageType>
              <NiftyStorageType>1</NiftyStorageType>
              <NiftyStorageType>2</NiftyStorageType>
              <NiftyStorageType>3</NiftyStorageType>
            </NiftyStorageTypes>
          </AvailabilityZone>
          <AvailabilityZone>
            <Name>east-12</Name>
            <ProvisionedIopsCapable>false</ProvisionedIopsCapable>
            <NiftyStorageTypes>
              <NiftyStorageType>0</NiftyStorageType>
              <NiftyStorageType>1</NiftyStorageType>
              <NiftyStorageType>2</NiftyStorageType>
              <NiftyStorageType>3</NiftyStorageType>
            </NiftyStorageTypes>
          </AvailabilityZone>
          <AvailabilityZone>
            <Name>east-13</Name>
            <ProvisionedIopsCapable>false</ProvisionedIopsCapable>
            <NiftyStorageTypes>
              <NiftyStorageType>0</NiftyStorageType>
              <NiftyStorageType>1</NiftyStorageType>
              <NiftyStorageType>2</NiftyStorageType>
              <NiftyStorageType>3</NiftyStorageType>
            </NiftyStorageTypes>
          </AvailabilityZone>
          <AvailabilityZone>
            <Name>east-14</Name>
            <ProvisionedIopsCapable>false</ProvisionedIopsCapable>
            <NiftyStorageTypes>
              <NiftyStorageType>0</NiftyStorageType>
              <NiftyStorageType>1</NiftyStorageType>
              <NiftyStorageType>2</NiftyStorageType>
              <NiftyStorageType>3</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>