本文へジャンプします。

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

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

RDB:NiftyFailoverDBInstance

処理概要

DBサーバーのフェイルオーバーを実施します。

マスターDBサーバーの冗長構成タイプは1(性能優先)でなければなりません。

リクエストパラメーター

要素名 説明 必須 最大値 デフォルト値 備考
DBInstanceIdentifier DBサーバー名 文字列  

レスポンス

XML

status

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

result
要素名 説明 備考
RebootDBInstanceResponse ルート
RebootDBInstanceResult 結果
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 冗長化機能が有効かどうか 真偽値
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 保留の修正情報
PreferredBackupWindow バックアップ時間 文字列
PreferredMaintenanceWindow メンテナンス時間 文字列
PubliclyAccessible グローバルIPアドレスかプライベートIPアドレスか 真偽値 固定値trueを返却
ReadReplicaDBInstanceIdentifiers リードレプリカのDBサーバー名リスト
ReadReplicaDBInstanceIdentifier リードレプリカの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
ステータスコード
説明
DBInstanceNotFound DBInstance not found: aaaaaa Sender 400 存在しないDBInstanceIdentifierを指定した場合
ReadReplica DB Instance not found. Sender 400 指定したDBサーバーにリードレプリカが存在しない場合
InvalidDBInstanceState Can only failover db instances with state in: available, incompatible-parameters. Instance ssltest-t03 has state: storage-full. Sender 400 指定したDBサーバーのステータスがavailableでない場合
A read replica that replicates the specified DB instance is not in the available state. Sender 400 指定したDBサーバーに紐付くリードレプリカのステータスが正常でない場合
InvalidParameterValue Can only failover db instances with Multi-AZ deployment Type: 1. Sender 400 冗長構成タイプが1でないDBサーバーを指定した場合
The parameter DBInstanceIdentifer must be provided and must not be blank. Sender 400 必須のDBInstanceIdentifierを指定しなかった場合
The readreplica DB instance cannot carry out failover. Sender 400 指定したDBサーバーがリードレプリカの場合

サンプル

リクエストサンプル
https://rdb.jp-east-1.api.cloud.nifty.com/
    ?Action=NiftyFailoverDBInstance
    &DBInstanceIdentifier=mydbinstance
    &SignatureVersion=2
    &SignatureMethod=HmacSHA256
    &Timestamp=2013-12-09T00%3A00%3A00.000Z
    &AWSAccessKeyId=<Nifty Cloud Access Key ID>
    &Signature=<Signature>
レスポンスサンプル
<NiftyFailoverDBInstanceResult>
    <DBInstance>
      <AllocatedStorage>50</AllocatedStorage>
      <AutoMinorVersionUpgrade>false</AutoMinorVersionUpgrade>
      <AvailabilityZone>west-11</AvailabilityZone>
      <BackupRetentionPeriod>1</BackupRetentionPeriod>
      <DBInstanceClass>db.small</DBInstanceClass>
      <DBInstanceIdentifier>mydbinstance</DBInstanceIdentifier>
      <DBInstanceStatus>modifying</DBInstanceStatus>
      <DBName>testdb</DBName>
      <DBParameterGroups>
        <DBParameterGroup>
          <DBParameterGroupName>default.mysql5.6</DBParameterGroupName>
          <ParameterApplyStatus>in-sync</ParameterApplyStatus>
        </DBParameterGroup>
      </DBParameterGroups>
      <DBSecurityGroups>
        <DBSecurityGroup>
          <DBSecurityGroupName>default.west-11</DBSecurityGroupName>
          <Status>available</Status>
        </DBSecurityGroup>
      </DBSecurityGroups>
      <Endpoint>
        <Port>3306</Port>
        <Address>175.184.23.50</Address>
        <NiftyPrivateAddress>10.100.76.68</NiftyPrivateAddress>
      </Endpoint>
      <Engine>mysql</Engine>
      <EngineVersion>5.6.21</EngineVersion>
      <InstanceCreateTime>2014-12-17T05:58:42.000Z</InstanceCreateTime>
      <LatestRestorableTime>2014-12-17T06:10:00.000Z</LatestRestorableTime>
      <LicenseModel>general-public-license</LicenseModel>
      <MasterUsername>testuser</MasterUsername>
      <MultiAZ>true</MultiAZ>
      <NiftyMultiAZType>1</NiftyMultiAZType>
      <OptionGroupMemberships>
        <OptionGroupMembership>
          <OptionGroupName>default:mysql-5-6</OptionGroupName>
          <Status>in-sync</Status>
        </OptionGroupMembership>
      </OptionGroupMemberships>
      <PendingModifiedValues/>
      <PreferredBackupWindow>18:31-19:01</PreferredBackupWindow>
      <PreferredMaintenanceWindow>mon:17:02-mon:17:32</PreferredMaintenanceWindow>
      <PubliclyAccessible>true</PubliclyAccessible>
      <ReadReplicaDBInstanceIdentifiers>
        <ReadReplicaDBInstanceIdentifier>mydbinstance-replica</ReadReplicaDBInstanceIdentifier>
      </ReadReplicaDBInstanceIdentifiers>
      <SecondaryAvailabilityZone>west-11</SecondaryAvailabilityZone>
      <VpcSecurityGroups/>
      <NiftyStorageType>0</NiftyStorageType>
    </DBInstance>
  </NiftyFailoverDBInstanceResult>
  <ResponseMetadata>
    <RequestId>bed9629a-fffd-4379-9e08-3d36dca9f575</RequestId>
  </ResponseMetadata>
</NiftyFailoverDBInstanceResponse>

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