本文へジャンプします。

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

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

RDB:DescribeDBSnapshots

処理概要

DBスナップショットの情報を取得します。

このAPIアクションはページネートをサポートしています。

リクエストパラメーター

要素名 説明 必須 最大値 デフォルト値 備考
DBInstanceIdentifier DBサーバー名   文字列 DBSnapshotIdentifierと同時に指定するとエラーになります
DBSnapshotIdentifier

DBスナップショット名

  • ※指定されたDBスナップショットのタイプがautomatedの場合、SnapshotTypeを指定する必要があります
  文字列 Markerと同時に指定するとエラーなります
Filters.member.N
  • ※指定不可
  リスト  
Filter
  • ※指定不可
   
FilterName
  • ※指定不可
  文字列  
FilterValue
  • ※指定不可
  文字配列  
Marker

マーカー

  • ※ページネート用にDBスナップショット一覧の取得位置を表す文字列です
  • ※前回のDescribeDBSnapshotsリクエストで返却された値を指定します
  • ※この値が指定された場合、取得位置より後のDBスナップショットが返却されます
  文字列  
MaxRecords レスポンスに含まれるレコードの最大値   数値 20-100 指定しない場合、該当するレコード全件が返却されます。
SnapshotType

スナップショットタイプ

  • ※指定しない場合、すべてのタイプのDBスナップショットが返却されます
値:automated(自動) | manual(手動)
○(DBSnapshotIdentifierに指定されたDBスナップショットのタイプがautomatedの場合) 文字列  

レスポンス

XML

status

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

result
要素名 説明 備考
DescribeDBSnapshotsResponse ルート  
DescribeDBSnapshotsResult 結果  
DBSnapshots DBスナップショットリスト リスト  
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(作成失敗)
文字列  
Marker マーカー 文字列  
ResponseMetadata 共通メタ情報  

エラー

コード メッセージ タイプ HTTP
ステータスコード
説明
DBSnapshotNotFound DBSnapshot not found: aaaa Sender 404 DBSnapshotIdentifierに存在しないDBスナップショット名を指定した場合
InvalidParameterCombination DBSnapshotIdentifier and Marker cannot both be provided. Sender 400 DBSnapshotIdentifierとMarkerを同時に指定した場合
Cannot specify both an instance identifier and a snapshot identifier. Sender 400 DBInstanceIdentifierとDBSnapshotIdentifierを同時に指定した場合
InvalidParameterValue 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に無効な値(ハイフンで始まるなど)を指定した場合
The parameter DBSnapshotIdentifier 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 DBSnapshotIdentifierに無効な値(ハイフンで始まるなど)を指定した場合
InvalidParameterValue The parameter DBInstanceIdentifier is not a valid identifier because it is longer than 63 characters. Sender 400 DBInstanceIdentifierに63文字以上指定した場合
The parameter DBSnapshotIdentifier is not a valid identifier because it is longer than 255 characters. Sender 400 DBSnapshotIdentifierに255文字以上指定した場合
Invalid value for max records. Must be between 20 and 100 Sender 400 MaxRecordsに20-100でない値を指定した場合
Invalid snapshot type 'automated111'. Must be blank or one of: manual, automated. Sender 400 SnapshotTypeに無効な値(manual、automated以外)や空文字列を指定した場合
MalformedInput Sender 400 MaxRecordsに数値以外を指定した場合

サンプル

リクエストサンプル
https://rdb.jp-east-1.api.cloud.nifty.com/
    ?Action=DescribeDBSnapshots
    &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"?>
<DescribeDBSnapshotsResponse>
    <DescribeDBSnapshotsResult>
      <DBSnapshots>
        <DBSnapshot>
            <AllocatedStorage>50</AllocatedStorage>
            <AvailabilityZone>east-13</AvailabilityZone>
            <DBInstanceIdentifier>mydbinstance</DBInstanceIdentifier>
            <DBSnapshotIdentifier>rdb: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>automated</SnapshotType>
            <Status>available</Status>
        </DBSnapshot>
        <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>
      </DBSnapshots>
    </DescribeDBSnapshotsResult>
    <ResponseMetadata>
      <RequestId>52e601c6-5c4f-4113-8209-aeacd9ff72d3</RequestId>
    </ResponseMetadata>
</DescribeDBSnapshotsResponse>

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