本文へジャンプします。

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

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

RDB:RebootDBInstance

処理概要

DBサーバーを再起動します。

このAPIアクションはDBサーバーに適用されているDBパラメーターグループの中で、ApplyStatus(適用状況)がpending-reboot(再起動待ち)となっているパラメーターを更新します。

DBサーバーを再起動すると少しの間DBサーバーは機能停止し、その間ステータスはrebooting(再起動中)となります。

DBサーバーの冗長化機能が有効の場合には、強制的にフェイルオーバーさせることができます。

リクエストパラメーター

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

冗長化機能のフェイルオーバーを通して再起動するかどうか

  • ※DBサーバーの冗長化機能が無効の場合、trueを指定することはできません
  真偽値  
NiftyRebootType 再起動タイプ
再起動のタイプを指定
値:0(DB通常) | 1(DB強制) | 2(OS通常) | 3(OS強制)
  文字列 0  

レスポンス

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 404 存在しないDBInstanceIdentifierを指定した場合
InvalidDBInstanceState Can only reboot db instances with state in: available, incompatible-parameters. Instance ssltest-t03 has state: storage-full. Sender 400 DBサーバーのステータスが下記以外のときにForceFailover=trueを指定した場合
  • available
  • incompatible-parameters
Can only reboot db instances with state in: available, incompatible-parameters when NiftyRebootType is 0. Instance ssltest-t03 has state: rebooting. Sender 400 DBサーバーのステータスが下記以外のときにNiftyRebootType=0を指定した場合
  • available
  • incompatible-parameters
Can only reboot db instances with state in: available, incompatible-parameters, storage-full, failed when NiftyRebootType is 1. Instance ssltest-t03 has state: rebooting. Sender 400 DBサーバーのステータスが下記以外のときにNiftyRebootType=1,2,3を指定した場合
  • available
  • incompatible-parameters
  • storage-full
  • failed
A read replica that replicates the specified DB instance is not in the available state. Sender 400 冗長構成タイプが1のマスタDBを再起動する時、全てのリードレプリカのステータスが有効でない場合
The master DB instance relevant to specified readreplica DB instance is not the available. Sender 400 冗長構成タイプが1のリードレプリカを再起動する時、マスタDBのステータスが有効でない場合
Cannot reboot DB Instance that failed to create. Sender 400 作成に失敗したDBサーバーを指定した場合
InvalidParameterValue ForceFailover cannot be specified since the instance is not configured for MultiAZ Sender 400 冗長化機能が有効でないDBサーバーでForceFailover=trueを指定した場合
The parameter DBInstanceIdentifer must be provided and must not be blank. Sender 400 必須のDBInstanceIdentifierを指定しなかった場合
The parameter DBInstanceIdentifer 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に数字から始まる値を指定した場合
  • DBInstanceIdentifierに@を使用した値を指定した場合など
The parameter DBInstanceIdentifer is not a valid identifier because it is longer than 63 characters. Sender 400 DBInstanceIdentifierに63文字以上指定した場合
Invalid Reboot Type: 4 Sender 400 NiftyRebootTypeに 0,1,2,3以外を指定した場合

サンプル

リクエストサンプル
https://rdb.jp-east-1.api.cloud.nifty.com/
    ?Action=RebootDBInstance
    &DBInstanceIdentifier=mydbinstance
    &ForceFailover=true
    &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"?>
<RebootDBInstanceResponse>
    <RebootDBInstanceResult>
      <DBInstance>
        <AllocatedStorage>50</AllocatedStorage>
        <AutoMinorVersionUpgrade>false</AutoMinorVersionUpgrade>
        <AvailabilityZone>east-13</AvailabilityZone>
        <BackupRetentionPeriod>1</BackupRetentionPeriod>
        <DBInstanceClass>db.small</DBInstanceClass>
        <DBInstanceIdentifier>mydbinstance</DBInstanceIdentifier>
        <DBInstanceStatus>rebooting</DBInstanceStatus>
        <DBName>mydb</DBName>
        <DBParameterGroups>
            <DBParameterGroup>
                <DBParameterGroupName>default.mysql5.6</DBParameterGroupName>
                <ParameterApplyStatus>in-sync</ParameterApplyStatus>
            </DBParameterGroup>
        </DBParameterGroups>
        <DBSecurityGroups>
            <DBSecurityGroup>
                <DBSecurityGroupName>mydbsecuritygroup</DBSecurityGroupName>
                <Status>available</Status>
            </DBSecurityGroup>
        </DBSecurityGroups>
        <EndPoint>
            <Port>3306</Port>
            <Address>XXX.XXX.XXX.XXX</Address>
            <NiftyPrivateAddress>YYY.YYY.YYY.YYY</NiftyPrivateAddress>
        </EndPoint>
        <Engine>mysql</Engine>
        <EngineVersion>5.6.12</EngineVersion>
        <InstanceCreateTime>2013-11-30T09:55:59.000Z</InstanceCreateTime>
        <LatestRestorableTime>2013-11-30T10:55:00.000Z</LatestRestorableTime>
        <LicenseModel>general-public-license</LicenseModel>
        <MasterUsername>mydbuser</MasterUsername>
        <MultiAZ>true</MultiAZ>
        <OptionGroupMemberships>
            <OptionGroupMembership>
                <OptionGroupName>default:mysql-5-6</OptionGroupName>
                <Status>in-sync</Status>
            </OptionGroupMembership>
        </OptionGroupMemberships>
        <PendingModifiedValues/>
        <PreferredBackupWindow>05:30-06:00</PreferredBackupWindow>
        <PreferredMaintenanceWindow>mon:06:01-mon:07:31</PreferredMaintenanceWindow>
        <PubliclyAccessible>true</PubliclyAccessible>
        <SecondaryAvailabilityZone>east-13</SecondaryAvailabilityZone>
        <VpcSecurityGroups/>
        <NiftyStorageType>0</NiftyStorageType>
    </DBInstance>
  </RebootDBInstanceResult>
    <ResponseMetadata>
      <RequestId>2b25a595-5744-482d-ba8f-28cd45a1a9b6</RequestId>
  </ResponseMetadata>
</RebootDBInstanceResponse>

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