本文へジャンプします。

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

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

RDB:CopyDBSnapshot

処理概要

DBスナップショットをコピーします。

コピー元のDBスナップショットはステータスが"available"でなければなりません。

自動バックアップ機能で作成されたDBスナップショットのみコピーすることができます。

リクエストパラメーター

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

コピー元のDBスナップショット名

  • ※ステータスが"available"のDBスナップショットのみ指定できます
  • ※自動バックアップ機能で作成されたDBスナップショットのみ指定できます
文字列  
TargetDBSnapshotIdentifier

コピー先のDBスナップショット名

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

レスポンス

XML

status

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

result
要素名 説明 備考
CopyDBSnapshotResponse ルート  
CopyDBSnapshotResult 結果  
DBSnapshot DBスナップショット  
AllocatedStorage ディスク容量 (GB) 数値  
AvailabilityZone DBスナップショットのゾーン 文字列  
DBInstanceIdentifier DBスナップショットの元になったDBサーバー名 文字列  
DBSnapshotIdentifier DBスナップショット名 文字列  
Engine DBスナップショットのデータベースエンジン 文字列  
EngineVersion DBスナップショットのデータベースエンジンバージョン 文字列  
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
ステータスコード
説明
Client.InvalidParameterCannotSpecify.CopySourceDBSnapshotIdentifier Only automated snapshots can be copied. Sender 400 SourceDBSnapshotIdentifierに手動作成したDBスナップショットを指定した場合
Client.InvalidParameterDuplicate.DBSnapshotIdentifier Cannot create the snapshot because a snapshot with the identifier sample-snapshot already exists. Sender 400 TargetDBSnapshotIdentifierにすでに存在するDBSnapshotIdentifierを指定した場合
Client.InvalidParameterFormat.CopySourceDBSnapshotIdentifier The parameter SourceDBSnapshotIdentifier 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 SourceDBSnapshotIdentifierに無効な値(ハイフンから始まる 等)を指定した場合
Client.InvalidParameterFormat.DBSnapshotIdentifier The parameter TargetDBSnapshotIdentifier 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 TargetDBSnapshotIdentifierに無効な値(ハイフンから始まる 等)を指定した場合
Client.InvalidParameterNotFound.CopySourceDBSnapshot DBSnapshot not found: rdb:sample-snapshot-2017-05-20-19-14 Sender 404 SourceDBSnapshotIdentifierに存在しない自動作成されたDBSnapshotIdentifierを指定した場合
Client.InvalidParameterRequired.CopySourceDBSnapshotIdentifier The parameter SourceDBSnapshotIdentifier must be provided and must not be blank. Sender 400 必須のSourceDBSnapshotIdentifierを指定しなかった場合
Client.InvalidParameterRequired.DBSnapshotIdentifier The parameter TargetDBSnapshotIdentifier must be provided and must not be blank. Sender 400 必須のTargetDBSnapshotIdentifierを指定しなかった場合
Client.InvalidParameterTooLong.CopySourceDBSnapshotIdentifier The parameter SourceDBSnapshotIdentifier is not a valid identifier because it is longer than 255 characters. Sender 400 SourceDBSnapshotIdentifierに255文字を超える値を指定した場合
Client.InvalidParameterTooLong.DBSnapshotIdentifier The parameter TargetDBSnapshotIdentifier is not a valid identifier because it is longer than 255 characters. Sender 400 TargetDBSnapshotIdentifierに255文字を超える値を指定した場合
Client.LimitExceeded.NumberOfDBSnapshot Request would result in user exceeding the allowed number of DB Snapshots. Sender 400 作成可能なDBスナップショットの上限に達している場合
Client.ResourceIncorrectState.CopySourceDBSnapshot.Unavailable The state of the DB Snapshot does not allow deletion. Sender 400 DBスナップショットのステータスが有効でない場合

サンプル

リクエストサンプル
https://rdb.jp-east-1.api.cloud.nifty.com/
    ?Action=CopyDBSnapshot
    &SourceDBSnapshotIdentifier=rdb%3Amydbinstance-2013-11-30-06-28
    &TargetDBSnapshotIdentifier=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"?>
<CopyDBSnapshotResponse>
  <CopyDBSnapshotResult>
    <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>available</Status>
    </DBSnapshot>
  </CopyDBSnapshotResult>
  <ResponseMetadata>
    <RequestId>1ed1b7c2-55ab-4188-ac46-2e5c6250a10c</RequestId>
  </ResponseMetadata>
</CopyDBSnapshotResponse>

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