ニフクラAPI (RDB: DeleteDBSnapshot)

DeleteDBSnapshot

処理概要

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

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

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

指定するパラメーター

パラメーター	型	説明	必須
DBSnapshotIdentifier	string	DBスナップショット名 ※手動作成かつステータスが”available”または”failed”のDBスナップショットのみ指定できます	○

応答フィールド

フィールド (項目)	型	説明
DeleteDBSnapshotResponse	structure	ルート
␣DeleteDBSnapshotResult	structure	結果
␣␣DBSnapshot	structure	DBスナップショット 備考: DBSnapshotの子要素はDescribeDBSnapshotsで返却される要素をすべて記載しているためAPIによっては返却されない要素もあります。実際のレスポンスはレスポンスサンプルを参照してください。
␣␣␣AllocatedStorage	integer	ディスク容量 (GB)
␣␣␣AvailabilityZone	string	DBスナップショットのゾーン
␣␣␣DBInstanceIdentifier	string	DBスナップショットの元になったDBサーバー名
␣␣␣DBSnapshotIdentifier	string	DBスナップショット名
␣␣␣Engine	string	DBスナップショットのデータベースエンジン
␣␣␣EngineVersion	string	DBスナップショットのデータベースエンジンバージョン
␣␣␣InstanceCreateTime	timestamp	DBスナップショットの元になったDBサーバーの作成日時
␣␣␣LicenseModel	string	DBスナップショットの元となったDBサーバーのライセンスモデル
␣␣␣MasterUsername	string	DBスナップショットの元となったDBサーバーのマスターユーザー名
␣␣␣OptionGroupName	string	下記の固定値を返却 DBエンジンがMySQL 5.6系の場合、default:mysql-5-6 DBエンジンがMySQL 5.7系の場合、default:mysql-5-7 DBエンジンがMySQL 8.0系の場合、default:mysql-8-0 DBエンジンがPostgreSQL9.3系の場合、default:postgres-9-3 DBエンジンがPostgreSQL9.6系の場合、default:postgres-9-6 DBエンジンがPostgreSQL11系の場合、default:postgres-11 DBエンジンがPostgreSQL13系の場合、default:postgres-13
␣␣␣Port	integer	DBスナップショットの元となったDBサーバーのポート
␣␣␣SnapshotCreateTime	timestamp	DBスナップショット作成日時
␣␣␣SnapshotType	string	DBスナップショットのタイプ 値：automated(自動) | manual(手動)
␣␣␣Status	string	DBスナップショットのステータス 値：creating(作成中) | availabile(作成完了) | failed(作成失敗)
␣ResponseMetadata	structure	共通メタ情報
␣␣RequestId	string	リクエスト識別子

エラー

コード	メッセージ	タイプ	HTTPステータスコード	説明
Client.InvalidParameterCannotSpecify.DBSnapshotIdentifier	Only manual snapshots may be deleted.	Sender	400	自動作成されたDBスナップショットを指定した場合
Client.InvalidParameterFormat.DBSnapshotIdentifier	The parameter DBSnapshotIdentifier is not a valid identifier. Identifiers must begin with a letter; must contain only lowercase ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.	Sender	400	DBSnapshotIdentifierに無効な値(ハイフンから始まる 等)を指定した場合
Client.InvalidParameterNotFound.DBSnapshot	DBSnapshot not found: aaa	Sender	404	存在しないDBSnapshotIdentifierを指定した場合
Client.InvalidParameterRequired.DBSnapshotIdentifier	The parameter DBSnapshotIdentifier must be provided and must not be blank.	Sender	400	必須のDBSnapshotIdentifierを指定しなかった場合
Client.ResourceInapplicable.RestoringDBSnapshot	DBSnapshot sample-dbsnapshot cannot be deleted. because it is being restored.	Sender	400	リストア中のDBスナップショットを指定した場合
Client.ResourceIncorrectState.DBSnapshot.CannotDelete	Cannot delete the snapshot because it is not currently in the available or failed state.	Sender	400	DBスナップショットが削除可能なステータスでない場合

リクエストサンプル

    https://jp-east-1.rdb.api.nifcloud.com/
  ?Action=DeleteDBSnapshot
  &DBSnapshotIdentifier=mydbinstance-2013-11-30-06-28
  &SignatureVersion=2
  &SignatureMethod=HmacSHA256
  &Timestamp=2013-12-09T00:00:00.000Z
  &AWSAccessKeyId=<NIFCLOUD Access Key ID>
  &Signature=<Signature>

  

応答サンプル

    <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>