本文へジャンプします。

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

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

RDB:RestoreDBInstanceFromDBSnapshot

処理概要

DBスナップショットから新しいDBサーバーを作成します。

元のDBサーバーとほぼ同じ設定でDBサーバーが作成されますが、DBファイアウォールグループとDBパラメーターグループだけはデフォルトが適用されます。

元のDBサーバーとは異なる設定を適用することもできます。

リクエストパラメーター

要素名 説明 必須 最大値 デフォルト値 備考
AutoMinorVersionUpgrade
  • ※指定不可
  真偽値  
AvailabilityZone 指定可能なゾーンについては、ニフティクラウド ゾーン別機能対応表をご参照ください。 ○(プライベートLANを利用している場合) 文字列 自動割り当て  
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
文字列  
DBInstanceIdentifier

DBサーバー名

  • ※1〜63字のアルファベット・数字・ハイフン('-')が使用できます
  • ※最初の文字はアルファベットである必要があります
  • ※末尾にハイフンをつけたりハイフンを2個連続させたりすることはできません
文字列  
DBName

DB名

  • ※このパラメーターはMySQL、MariaDB、PostgreSQLエンジンでは利用できません
  文字列  
NiftyDBParameterGroupName

DBパラメーターグループ名

  • ※このパラメーターを指定しない場合、デフォルトのDB パラメーターグループが使用されます
  • ※1〜255字のアルファベット・数字・ハイフンが使用できます
  • ※最初の文字はアルファベットである必要があります
  • ※末尾にハイフンをつけたりハイフンを2個連続させたりすることはできません
  文字列 DBエンジンのDefaultParameterGroupName ニフティクラウド独自仕様
NiftyDBSecurityGroups.member.N

DBファイアウォールグループのリスト

  文字列 DBエンジンのDefaultSecurityGroup

ニフティクラウド独自仕様

1つのみ指定可能です。複数指定した場合、2つ目以降は無視されます。

DBSnapshotIdentifier 元になるDBスナップショット 文字列  
DBSubnetGroupName
  • ※指定不可
  文字列  
Engine

データベースエンジン

  • ※元のDBサーバーと同じエンジンである必要があります
  文字列 元のDBサーバーの値  
Iops
  • ※指定不可
  数値  
LicenseModel

DBサーバーのライセンスモデル

  • ※元になるDBサーバーと同じである必要があります

値(MySQL):general-public-license
値(PostgreSQL):postgresql-license
値(MariaDB) : general-public-license

  文字列 元のDBサーバーの値  
MultiAZ 冗長化機能が有効かどうか   真偽値  
NiftyMultiAZType 冗長構成タイプ
使用する冗長構成のタイプを指定
値:0(データ優先) | 1(性能優先)
  数値 0 ニフティクラウド独自仕様
NiftyReadReplicaDBInstanceIdentifier

リードレプリカのDBサーバー名

  • ※1〜63字のアルファベット・数字・ハイフン('-')が使用できます。
  • ※最初の文字はアルファベットである必要があります。
  • ※末尾にハイフンをつけたりハイフンを2個連続させたりすることはできません。
  数値 0 ニフティクラウド独自仕様
OptionGroupName
  • ※指定不可
  文字列  
Port

DBが接続を受け付けるポート

  • ※元のDBサーバーと同じである必要があります
値:1150〜65535
  数値 元のDBサーバーの値  
PubliclyAccessible
  • ※指定不可
  真偽値  
NiftyStorageType ディスクタイプ
値:0(HDD) | 1(フラッシュドライブ)
  数値 0 ニフティクラウド独自仕様
NiftyNetworkId プライベートLANのネットワークユニークID   文字列 ニフティクラウド独自仕様
NiftyVirtualPrivateAddress 仮想ロードバランサー用のプライベートIPアドレス ○(プライベートLANを利用している場合) 文字列 ニフティクラウド独自仕様
NiftyMasterPrivateAddress 主系DBサーバー用のプライベートIPアドレス ○(プライベートLANを利用している場合) 文字列 ニフティクラウド独自仕様
NiftySlavePrivateAddress 待機系DBサーバー用のプライベートIPアドレス ○(プライベートLANを利用している場合、かつ、NiftyMultiAZType = 0 の場合) 文字列 ニフティクラウド独自仕様
NiftyReadReplicaPrivateAddress リードレプリカ用のプライベートIPアドレス ○(プライベートLANを利用している場合、かつ、NiftyMultiAZType = 1 の場合) 文字列 ニフティクラウド独自仕様

レスポンス

XML

status

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

result
要素名 説明 備考
RestoreDBInstanceFromDBSnapshotResponse ルート  
RestoreDBInstanceFromDBSnapshotResult 結果  
DBInstance DBサーバー  
AllocatedStorage ディスク容量 (GB) 数値  
AutoMinorVersionUpgrade マイナーバージョンの自動アップデートするかどうか 真偽値 固定値falseを返却
AvailabilityZone DBサーバーのゾーン 文字列  
BackupRetentionPeriod バックアップ保持期間 数値  
DBInstanceClass DBサーバータイプ 文字列  
DBInstanceIdentifier DBサーバー名 文字列  
DBInstanceStatus DBサーバーのステータス 文字列  
DBName DB名 文字列  
DBParameterGroups DBパラメーターグループ情報リスト リスト  
DBParameterGroup DBパラメーターグループ情報  
DBParameterGroupName DBパラメーターグループ名 文字列  
ParameterApplyStatus DBパラメーターの適用ステータス
値:applying(適用中) | pending-reboot(再起動待ち) | in-sync(適用済み)
文字列  
DBSecurityGroups DBファイアウォールグループ情報リスト リスト  
DBSecurityGroups DBファイアウォールグループ  
DBSecurityGroupName DBファイアウォールグループ名 文字列  
Status DBファイアウォールグループのステータス
値:active(有効) | adding(適用中) | removing(取り外し中) | failed(変更失敗)
文字列  
Endpoint DB接続時のエンドポイント  
Port ポート番号 数値  
Address グローバルIPアドレス 文字列  
NiftyPrivateAddress プライベートIPアドレス 文字列 ニフティクラウド独自仕様
Engine データベースエンジン 文字列  
EngineVersion データベースエンジンのバージョン 文字列  
InstanceCreateTime DBサーバーの作成日時 日時  
LatestRestorableTime ポイントインタイムリカバリー可能な最新の時刻 日時  
LicenseModel DBサーバーのライセンスモデル 文字列  
MasterUsername DBサーバーのマスターユーザー名 文字列  
MultiAZ 冗長化機能が有効かどうか 真偽値  
NiftyMultiAZType 冗長構成タイプ 文字列 ニフティクラウド独自仕様
OptionGroupMemberships オプショングループ情報リスト リスト  
OptionGroupMembership オプショングループ情報  
OptionGroupName

下記の固定値を返却

  • DBエンジンがMySQL 5.5系の場合、default:mysql-5-5
  • DBエンジンがMySQL 5.6系の場合、default:mysql-5-6
  • DBエンジンがMySQL 5.7系の場合、default:mysql-5-7
  • DBエンジンがPostgreSQL9.3系の場合、default:postgres-9-3
  • DBエンジンがMariaDB10.1系の場合、default:mariadb-10-1
文字列  
Status オプショングループのステータス 文字列 固定値in-syncを返却
PendingModifiedValues 保留の修正情報  
AllocatedStorage 保留中のディスク容量 数値  
BackupRetentionPeriod 保留中のバックアップ保持期間 数値  
DBInstanceClass 保留中のDBサーバータイプ 文字列  
DBInstanceIdentifier 保留中のDBサーバー名 文字列  
EngineVersion 保留中のデータベースエンジンのバージョン 文字列  
MasterUserPassword 保留中のDBサーバーのマスターユーザー名 文字列  
MultiAZ 保留中の「冗長化機能が有効かどうか」フラグ 真偽値  
Port 保留中のアクセス可能なポート番号 数値  
PreferredBackupWindow バックアップ時間 文字列  
PreferredMaintenanceWindow メンテナンス時間 文字列  
PubliclyAccessible グローバルIPアドレスかプライベートIPアドレスか 真偽値 固定値trueを返却
ReadReplicaDBInstanceIdentifiers リードレプリカのDBサーバー名 文字配列  
ReadReplicaSourceDBInstanceIdentifier リードレプリカのマスターとして設定されているDBサーバー名 文字列  
SecondaryAvailabilityZone

待機系DBサーバーのゾーン

  • ※冗長化機能がオフの場合、このタグは返却されません
  • ※冗長化機能がオンの場合、固定で AvailabilityZone と同じ値が返却されます
文字列  
StatusInfos

リードレプリカのステータス

  • ※DBサーバーがリードレプリカでない場合、空タグが返却されます
リスト  
DBInstanceStatusInfo DBサーバーのステータス情報のリスト  
Message

エラーメッセージ

  • ※エラーが発生していない場合は空タグが返却されます
文字列  
Normal 正常かどうか 真偽値  
Status DBサーバーのステータス
値(StatusTypeが"read replication"の場合): replicating(レプリケーション中) | error(レプリケーションエラー)
文字列  
StatusType DBサーバーのステータス種別 文字列 固定値"read replication"を返却
VpcSecurityGroups
  • ※返却値なし
リスト  
NiftyStorageType ディスクタイプ 数値 ニフティクラウド独自仕様
NiftyNetworkId プライベートLANのネットワークユニークID 文字列 ニフティクラウド独自仕様
ResponseMetadata 共通メタ情報  

エラー

コード メッセージ タイプ HTTP
ステータスコード
説明
DBInstanceAlreadyExists DB Instance already exists Sender 400 DBInstanceIdentifierにすでに存在するIDを指定した場合
DBSnapshotNotFound DBSnapshot not found: aaaa Sender 404 DBSnapshotIdentifierに存在しないIDを指定した場合
DBParameterGroupNotFound NiftyDBParameterGroup not found: 1aaa Sender 404 存在しないDBParameterGroupを指定した場合
DBSecurityGroupNotFound NiftyDBSecurityGroup not found: aaa Sender 404 存在しないDBSecurityGroupを指定した場合
InstanceQuotaExceeded Request would result in user exceeding the allowed number of DB Instances. Sender 400 作成できるDBサーバー数の上限に達している場合
InsufficientDBInstanceCapacity Specified DB Instance class is not available in the specified Availability Zone. Sender 400 作成するAZに指定できないDBサーバータイプを指定した場合
InvalidDBSnapshotState DBSnapshot must have state available but actually has creating Sender 400 DBスナップショットのステータスがavailable ではない場合
InvalidParameterCombination Invalid license model 'xxx' for engine 'mysql'. Valid license models are: general-public-license Sender 400 Engineに対し指定できないLicenseModelを指定した場合
Requested DBSnapshot and Engine are incompatible Sender 400 Engineに元になるDBと異なるエンジンを指定した場合。
The parameter NiftySlavePrivateAddress must be provided and must not be blank for Multi-AZ instances. Sender 400 プライベートLANを利用している場合、かつ、multiAZ=trueの場合で、NiftySlavePrivateAddressの指定がないとき
Multi-AZ deployment Type: 1 is not enabled for this database instance. To enable Multi-AZ deployment Type: 1, set the backup retention period to a non-zero value. Sender 400 NiftyMultiAZTypeに1を指定した場合に、BackupRetentionPeriodに0を指定した場合
The parameter NiftyReadReplicaDBInstanceIdentifier must be provided and must not be blank for ReadReplica instances. Sender 400 NiftyMultiAZTypeに1を指定した場合に、NiftyReadReplicaDBInstanceIdentifierの指定がない場合
The parameter NiftyReadReplicaPrivateAddress must be provided and must not be blank for ReadReplica instances. Sender 400 NiftyMultiAZTypeに1を指定した場合に、NiftyReadReplicaPrivateAddressの指定がない場合
can not set the same value in DBInstanceIdentifier and NiftyReadReplicaDBInstanceIdentifier. Sender 400 DBInstanceIdentifierとNiftyReadReplicaDBInstanceIdentifierに、同じ値を指定した場合
Multi-AZ deployment Type: 1 is not enabled for this database instance. To enable Multi-AZ deployment Type: 1, set the engine to a mysql. Sender 400 NiftyMultiAZTypeに1を指定した場合に、Engineにpostgresを指定した場合
Private LAN net-0ewfh3mj does not belong to availability zone east-14. Sender 400 指定されたNiftyNetworkIdが所属するゾーンと指定されたAvailabilityZoneが一致しない場合
NiftyDBSecurityGroup aaa cannot be used in east-11 zone. The availability zone of aaa is east12 Sender 400 指定されたゾーンと異なるゾーンに所属するDBファイアウォールグループを指定した場合
  • ・MySQLの場合
    The Parameter Group default.mysql5.1 with DBParameterGroupFamily mysql5.1 cannot be used for this instance. Please use a Parameter Group with DBParameterGroupFamily mysql5.5
  • ・PostgreSQLの場合
    The Parameter Group default.postgresn.n with DBParameterGroupFamily postgresn.n cannot be used for this instance. Please use a Parameter Group with DBParameterGroupFamily postgres9.3
  • ・MariaDBの場合
    The Parameter Group default.mariadbn.n with DBParameterGroupFamily mariadbn.ncannot be used for this instance. Please use a Parameter Group with DBParameterGroupFamily mariadb10.1
Sender 400 NiftyDBParameterGroupNameにDBサーバーのDBParameterGroupFamilyと異なるパラメーターグループを指定した場合
InvalidParameterValue Invalid Storage Type: 2 Sender 400 StrageTypeに 0,1以外を指定した場合
The parameter DBInstanceIdentifier 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 DBInstanceIdentifierに無効な値(ハイフンで始まるなど)を指定した場合
The parameter DBSnapshotIdentifier 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 DBSnapshotIdentifierに無効な値(ハイフンで始まるなど)を指定した場合
The parameter DBSnapshotIdentifier must be provided and must not be blank. Sender 400 必須のDBSnapshotIdentifierを指定しなかった場合
The parameter DBInstanceIdentifier must be provided and must not be blank. Sender 400 必須のDBInstanceIdentifierを指定しなかった場合
The parameter DBInstanceIdentifier is not a valid identifier because it is longer than 63 characters. Sender 400 DBInstanceIdentifierに63文字以上指定した場合
The parameter DBSnapshotIdentifier is not a valid identifier because it is longer than 255 characters. Sender 400 DBSnapshotIdentifierに255文字以上指定した場合
aaa is not a valid availability zone. Sender 400 存在しないAvailabilityZoneを指定した場合
Invalid DB instance class:aaa Sender 400 DBInstanceClassに存在しないDBサーバータイプを指定した場合
DBName must begin with a letter and contain only alphanumeric characters. Sender 400 DBNameに
数字から始まる値を指定した場合
DBName must be less than 64 characters long. Sender 400 DBNameに
64文字以上指定した場合
DBName ADD cannot be used. It is a reserved word for this engine Sender 400 DBNameに
予約語を指定した場合
Invalid endpoint port: 70000. Valid range is 1150-65535 Sender 400 Portに1150-65535でない値を指定した場合
Invalid DB engine: xxx Sender 400 Engineに存在しないEnginを指定した場合
The parameter NiftyVirtualPrivateAddress must be provided and must not be blank. Sender 400 プライベートLANを利用している場合で、NiftyVirtualPrivateAddressの指定がないとき
Invalid NiftyVirtualPrivateAddress: aaa.bbb.ccc.ddd. Sender 400 NiftyVirtualPrivateAddressにIPアドレスとして無効な値を指定したとき
NiftyVirtualPrivateAddress is not allowed in the range of [10.0.0.0/8,11.0.0.0/8]. Sender 400 NiftyVirtualPrivateAddressに許可されないIPアドレスを指定したとき
The parameter NiftyMasterPrivateAddress must be provided and must not be blank. Sender 400 プライベートLANを利用している場合で、NiftyMasterPrivateAddressの指定がないとき
Invalid NiftyMasterPrivateAddress aaa.bbb.ccc.ddd. Sender 400 NiftyMasterPrivateAddressにIPアドレスとして無効な値を指定したとき
NiftyMasterPrivateAddress is not allowed in the range of [10.0.0.0/8,11.0.0.0/8]. Sender 400 NiftyMasterPrivateAddressに許可されないIPアドレスを指定したとき
Invalid NiftySlavePrivateAddress aaa.bbb.ccc.ddd. Sender 400 NiftySlavePrivateAddressにIPアドレスとして無効な値を指定したとき
NiftySlavePrivateAddress is not allowed in the range of [10.0.0.0/8,11.0.0.0/8]. Sender 400 NiftySlavePrivateAddressに許可されないIPアドレスを指定したとき
AvailabilityZone is required. Sender 400 プライベートLANを利用している場合で、AvailabilityZoneを指定しないとき
The parameter NiftyReadReplicaDBInstanceIdentifier 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 NiftyReadReplicaDBInstanceIdentifierに数字から始まる値を指定した場合
The parameter NiftyReadReplicaDBInstanceIdentifier is not a valid identifier because it is longer than 63 characters. Sender 400 NiftyReadReplicaDBInstanceIdentifierに63文字以上指定した場合
Invalid NiftyReadReplicaPrivateAddress aaa.bbb.ccc.ddd. Sender 400 NiftyReadReplicaPrivateAddressにIPアドレスとして無効な値を指定したとき
Invalid Multi-AZ deployment Type: 2 Sender 400 NiftyMultiAZTypeに 0、1以外を指定した場合
Private addresses are not unique: 192.168.98.160 Sender 400 NiftyVirtualPrivateAddress、NiftyMasterPrivateAddress、NiftySlavePrivateAddress、NiftyReadReplicaDBPrivateAddressに重複したIPアドレスを指定したとき
Private address is already in use: 192.168.98.160 Sender 400 NiftyVirtualPrivateAddress、NiftyMasterPrivateAddress、NiftySlavePrivateAddress、NiftyReadReplicaDBPrivateAddressに既に使用済みのIPアドレスを指定したとき
Invalid parameter group name: Sender 400 NiftyDBParameterGroupNameに無効な値を指定した場合
NetworkNotFound Private LAN net-0ewfh3mj does not exist. Sender 404 指定されたNiftyNetWorkIdが存在しない場合
MalformedInput - Sender 400 portに数値以外を指定した場合
boolean must follow xsd1.1 definition Sender 400 MultiAZにtrue、false以外を指定した場合
InvalidDBSecurityGroupState DBSecurityGroup is not in available state. Sender 400 設定しようとしたDBセキュリティグループのルールに、ステータス「authorizing」または「revoking」のルールが存在する場合

サンプル

リクエストサンプル
https://rdb.jp-east-1.api.cloud.nifty.com/
    ?Action=RestoreDBInstanceFromDBSnapshot
    &DBSnapshotIdentifier=rdb%3Amydbinstance-2013-11-30-06-28
    &DBInstanceIdentifier=mydbinstancefromdbsnapshot
    &DBInstanceClass=db.small
    &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"?>
<RestoreDBInstanceFromDBSnapshotResponse>
    <RestoreDBInstanceFromDBSnapshotResult>
      <DBInstance>
        <AllocatedStorage>50</AllocatedStorage>
        <AutoMinorVersionUpgrade>false</AutoMinorVersionUpgrade>
        <AvailabilityZone>east-13</AvailabilityZone>
        <BackupRetentionPeriod>1</BackupRetentionPeriod>
        <DBInstanceClass>db.small</DBInstanceClass>
        <DBInstanceIdentifier>mydbinstancefromdbsnapshot</DBInstanceIdentifier>
        <DBInstanceStatus>creating</DBInstanceStatus>
        <DBName>mydb</DBName>
        <DBParameterGroups>
            <DBParameterGroup>
                <DBParameterGroupName>default.mysql5.6</DBParameterGroupName>
                <ParameterApplyStatus>in-sync</ParameterApplyStatus>
            </DBParameterGroup>
        </DBParameterGroups>
        <DBSecurityGroups>
            <DBSecurityGroup>
                <DBSecurityGroupName>default.east-13</DBSecurityGroupName>
                <Status>available</Status>
            </DBSecurityGroup>
        </DBSecurityGroups>
        <Engine>mysql</Engine>
        <EngineVersion>5.6.12</EngineVersion>
        <LicenseModel>general-public-license</LicenseModel>
        <MasterUsername>mydbuser</MasterUsername>
        <MultiAZ>false</MultiAZ>
        <OptionGroupMemberships>
            <OptionGroupMembership>
                <OptionGroupName>default:mysql-5-6</OptionGroupName>
                <Status>in-sync</Status>
            </OptionGroupMembership>
        </OptionGroupMemberships>
        <PendingModifiedValues/>
        <PreferredBackupWindow>05:30:00-06:00:00</PreferredBackupWindow>
        <PreferredMaintenanceWindow>mon:06:01:00-mon:07:31:00</PreferredMaintenanceWindow>
        <PubliclyAccessible>true</PubliclyAccessible>
        <ReadReplicaDBInstanceIdentifiers/>
        <ReadReplicaSourceDBInstanceIdentifier/>
        <SecondaryAvailabilityZone>east-13</SecondaryAvailabilityZone>
        <NiftyStorageType>0</NiftyStorageType>
      </DBInstance>
    </RestoreDBInstanceFromDBSnapshotResult>
    <ResponseMetadata>
      <RequestId>ceab3dab-8722-4120-8bc3-72f600b0fc1b</RequestId>
    </ResponseMetadata>
</RestoreDBInstanceFromDBSnapshotResponse>

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