本文へジャンプします。

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

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

RDB:DeleteDBSnapshot

処理概要

DBスナップショットを削除します。

手動作成したDBスナップショットのみ削除することができます。

さらに、DBスナップショットのステータスは"available"または"failed"でなければなりません。

リクエストパラメーター

要素名 説明 必須 最大値 デフォルト値 備考
DBSnapshotIdentifier

DBスナップショット名

  • ※手動作成かつステータスが"available"または"failed"のDBスナップショットのみ指定できます
文字列  

レスポンス

XML

status

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

result
要素名 説明 備考
DeleteDBSnapshotResponse ルート  
DeleteDBSnapshotResult 結果  
DBSnapshot DBスナップショット  
AllocatedStorage ディスク容量 (GB) 数値  
AvailabilityZone DBスナップショットのゾーン 文字列  
DBInstanceIdentifier DBスナップショットの元になったDBサーバー名 文字列  
DBSnapshotIdentifier DBスナップショット名 文字列  
Engine データベースエンジン 文字列  
EngineVersion データベースエンジンバージョン 文字列  
InstanceCreateTime DBスナップショットの元になったDBサーバーの作成日時 日時  
LicenseModel DBスナップショットのライセンスモデル 文字列  
MasterUsername DBスナップショットのマスターユーザー 文字列  
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
文字列  
Port DBスナップショットのポート 数値  
SnapshotCreateTime DBスナップショット作成時間 日時  
SnapshotType DBスナップショットのタイプ
値:automated(自動) | manual(手動)
文字列  
Status DBスナップショットのステータス
値:creating(作成中) | availabile(作成完了) | failed(作成失敗)
文字列  
ResponseMetadata 共通メタ情報  

エラー

コード メッセージ タイプ HTTP
ステータスコード
説明
DBSnapshotNotFound DBSnapshot not found: test Sender 404 DBSnapshotIdentifierに存在しないDBスナップショット名を指定した場合
InvalidDBSnapshotState Only manual snapshots may be deleted. Sender 400 自動作成されたDBスナップショットの名前を指定した場合
InvalidParameterValue The parameter DBSnapshotIdentifier must be provided and must not be blank. Sender 400 必須のDBSnapshotIdentifierを指定しなかった場合
InvalidDBSnapshotState Cannot delete the snapshot because it is not currently in the available or failed state. Sender 400 DBスナップショットのステータスが削除可能なステータスでない場合

サンプル

リクエストサンプル
https://rdb.jp-east-1.api.cloud.nifty.com/
    ?Action=DeleteDBSnapshot
    &DBSnapshotIdentifier=mydbinstance-2013-11-30-06-28
    &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"?>
<DeleteDBSnapshotResponse>
  <DeleteDBSnapshotResult>
    <DBSnapshot>
      <AllocatedStorage>50</AllocatedStorage>
      <AvailabilityZone>east-13</AvailabilityZone>
      <DBInstanceIdentifier>mydbinstance</DBInstanceIdentifier>
      <DBSnapshotIdentifier>mydbinstance-2013-11-30-06-28</DBSnapshotIdentifier>
      <Engine>mysql</Engine>
      <EngineVersion>5.6.12</EngineVersion>
      <InstanceCreateTime>2013-11-30T06:28:42.000Z</InstanceCreateTime>
      <LicenseModel>general-public-license</LicenseModel>
      <MasterUsername>mydbuser</MasterUsername>
      <OptionGroupName>default:mysql-5-6</OptionGroupName>
      <Port>3306</Port>
      <SnapshotCreateTime>2013-11-30T06:29:10.000Z</SnapshotCreateTime>
      <SnapshotType>manual</SnapshotType>
      <Status>deleted</Status>
    </DBSnapshot>
  </DeleteDBSnapshotResult>
  <ResponseMetadata>
    <RequestId>b2a9bc13-575f-47f6-b933-a38c3352d2ae</RequestId>
  </ResponseMetadata>
</DeleteDBSnapshotResponse>

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