本文へジャンプします。

ニフクラ APIリファレンス

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

RDB:DeleteDBInstance

処理概要

DBサーバーを削除します。

成功したレスポンスはリクエストが正しく受け取られたことを表します。

DBサーバーを削除すると、自動バックアップ機能で作成されたバックアップも削除され復元することができなくなります。

手動で作成したDBスナップショットは削除されません。

削除前に最後のDBスナップショットを作成することを指定した場合、DBスナップショットが作成されるまでDBサーバーのステータスはdeleting(削除中)になります。

この操作の進捗状況を確認するにはDescribeDBInstanceアクションを利用してください。

このアクションは一度送信するとキャンセル・取り消しを行うことはできません。

リクエストパラメーター

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

削除時にDBスナップショットを作成する場合のDBスナップショット名

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

(SkipFinalSnapshotがfalseの場合)
文字列  
SkipFinalSnapshot DBサーバーが削除される前にDBスナップショットを作成するかどうか   真偽値 false  

レスポンス

XML

status

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

result
要素名 説明 備考
DeleteDBInstanceResponse ルート -  
DeleteDBInstanceResult 結果 -  
DBInstance DBサーバー -  
AllocatedStorage ディスク容量 (GB) 数値  
AutoMinorVersionUpgrade マイナーバージョンの自動アップデートするかどうか 真偽値 固定値 false を返却
AvailabilityZone DBサーバーのゾーン 文字列  
BackupRetentionPeriod バックアップ保持期間 数値  
CACertificateIdentifier DBサーバーのサーバー証明書と紐付くCA証明書 文字列  
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アドレス
  • ※PubliclyAccessibleがオフの場合、このタグは返却されません
文字列  
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エンジンがPostgreSQL9.6系の場合、default:postgres-9-6
  • DBエンジンがMariaDB10.1系の場合、default:mariadb-10-1
文字列  
Status オプショングループのステータス 文字列 固定値 in-sync を返却
PendingModifiedValues 保留の修正情報 -  
PreferredBackupWindow バックアップ時間 文字列  
PreferredMaintenanceWindow メンテナンス時間 文字列  
PubliclyAccessible グローバルIPアドレスを有効にするかどうか 真偽値  
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
ステータスコード
説明
Client.InvalidParameterDuplicate.DBSnapshotIdentifier Cannot create the snapshot because a snapshot with the identifier sample-snapshot already exists. Sender 400 すでに存在するDBSnapshotIdentifierを指定した場合
Client.InvalidParameterFormat.DBInstanceIdentifier 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に無効な値(ハイフンから始まる 等)を指定した場合
Client.InvalidParameterFormat.DBSnapshotIdentifier The parameter FinalDBSnapshotIdentifier 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 FinalDBSnapshotIdentifierに無効な値(ハイフンから始まる 等)を指定した場合
Client.InvalidParameterIllegalInput.SkipFinalSnapshot - Sender 400 SkipFinalSnapshotにBoolean型以外の値を指定した場合
Client.InvalidParameterMissing.DBSnapshotIdentifier FinalDBSnapshotIdentifier is required unless SkipFinalSnapshot is specified. Sender 400 SkipFinalSnapshot=falseの時、FinalDBSnapshotIdentifierを指定しなかった場合
Client.InvalidParameterNotFound.DBInstance DBInstance not found: aaa Sender 404 存在しないDBInstanceIdentifierを指定した場合
Client.InvalidParameterRequired.DBInstanceIdentifier The parameter DBInstanceIdentifier must be provided and must not be blank. Sender 400 必須のDBInstanceIdentifierを指定しなかった場合
Client.InvalidParameterTooLong.DBInstanceIdentifier The parameter DBInstanceIdentifier is not a valid identifier because it is longer than 63 characters. Sender 400 DBInstanceIdentifierに63文字を超える値を指定した場合
Client.InvalidParameterTooLong.DBSnapshotIdentifier The parameter FinalDBSnapshotIdentifier is not a valid identifier because it is longer than 255 characters. Sender 400 FinalDBSnapshotIdentifierに255字を超える値を指定した場合
Client.LimitExceeded.NumberOfDBSnapshot Request would result in user exceeding the allowed number of DB Snapshots. Sender 400 作成可能なDBスナップショットの上限に達している場合
Client.ResourceInapplicable.DBSnapshotIdentifier Cannot create a snapshot because the database instance sample-dbinstance is not currently in the available state. Sender 400 ステータスが「available」以外のDBサーバーに対し、FinalDBSnapshotIdentifierを指定した場合
Only one of SkipFinalSnapshot and FinalDBSnapshotIdentifier can be specified Sender 400 SkipFinalSnapshot=trueの時、FinalDBSnapshotIdentifierを指定した場合
FinalDBSnapshotIdentifier can not be specified when deleting a replica instance Sender 400 リードレプリカを削除しようとした時、FinalDBSnapshotIdentifierを指定した場合
Client.ResourceInapplicable.RestoringDBInstance DBInstance sample-dbinstance cannot be deleted. because it is being restored. Sender 400 リストア中のDBサーバーを指定した場合
Client.ResourceIncorrectState.DBInstance.CannotDelete The specified DB Instance is not in the available state. Sender 400 指定したDBサーバーのステータスが以下でない場合
available
failed
storage-full
incompatible-option-group
incompatible-parameters
incompatible-restore
incompatible-network
DBInstance sample-dbinstance cannot be deleted. because read replica exists. Sender 400 リードレプリカを持つDBサーバーを削除しようとした場合
Client.ResourceIncorrectState.OtherReadReplicas.CannotDelete A read replica that replicates the specified DB instance is not in the available state. Sender 400 冗長構成タイプが1のリードレプリカを削除する時、削除対象以外のリードレプリカのステータスが有効でない場合
Client.ResourceIncorrectState.ReadReplicaSourceDBInstance.Unavailable The master DB instance relevant to specified readreplica DB instance is not the available. Sender 400 リードレプリカを削除する時、マスターDBサーバーのステータスが有効でない場合

サンプル

リクエストサンプル
https://rdb.jp-east-1.api.cloud.nifty.com/
    ?Action=DeleteDBInstance
    &DBInstanceIdentifier=mydbinstance
    &SkipFinalSnapshot=true
    &SignatureVersion=2
    &SignatureMethod=HmacSHA256
    &Timestamp=2013-12-09T00%3A00%3A00.000Z
    &AWSAccessKeyId=<Nifty Cloud Access Key ID>
    &Signature=<Signature>
レスポンスサンプル
<DeleteDBInstanceResponse>
  <DeleteDBInstanceResult>
  <DBInstance>
    <AllocatedStorage>100</AllocatedStorage>
    <AutoMinorVersionUpgrade>false</AutoMinorVersionUpgrade>
    <AvailabilityZone>east-13</AvailabilityZone>
    <BackupRetentionPeriod>1</BackupRetentionPeriod>
    <DBInstanceClass>db.mini</DBInstanceClass>
    <DBInstanceIdentifier>mydbinstance</DBInstanceIdentifier>
    <DBInstanceStatus>failed</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-30T06:28:42.000Z</InstanceCreateTime>
    <LatestRestorableTime>2013-11-30T08:45: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>
</DeleteDBInstanceResult>
  <ResponseMetadata>
  <RequestId>96293bd4-f64f-45ef-8cfa-724974067bde</RequestId>
</ResponseMetadata>
</DeleteDBInstanceResponse>

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