本文へジャンプします。

【重要なお知らせ】サービス統合に基づくサービス名称の読み替えのお願い（2024年4月1日）

2024年4月1日をもって、「ニフクラ」は、「FJcloud-V」に統合し、名称を変更しました。
当サイトのアドレス（ドメイン名）に含まれる「nifcloud.com」は現時点では変更はございませんが、
各ページに記載の「ニフクラ」「NIFCLOUD」「nifcloud」は、「FJcloud-V」に読み替えていただきますようお願いいたします。

ニフクラ ユーザーガイド

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

DescribeDBSnapshots

処理概要

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

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

指定するパラメーター

パラメーター 型 説明 必須
DBInstanceIdentifier string DBサーバー名
備考: DBSnapshotIdentifierと同時に指定するとエラーになります
DBSnapshotIdentifier string

DBスナップショット名

  • ※指定されたDBスナップショットのタイプがautomatedの場合、SnapshotTypeを指定する必要があります

備考: Markerと同時に指定するとエラーなります
Filters.member.N string ※指定不可
Filter string ※指定不可
FilterName string ※指定不可
FilterValue string ※指定不可
Marker string

マーカー

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

スナップショットタイプ

  • ※指定しない場合、すべてのタイプのDBスナップショットが返却されます

値:
  • automated (自動)
  • manual (手動)
 ○ (DBSnapshotIdentifierに指定されたDBスナップショットのタイプがautomatedの場合)

応答フィールド

フィールド (項目) 型 説明
DescribeDBSnapshotsResponse structure ルート
␣DescribeDBSnapshotsResult structure 結果
␣␣DBSnapshots list DBスナップショットリスト
␣␣␣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(作成失敗)
␣␣Marker string

前のリクエストで提供されるページを表す文字列（ページング用）

  • この値が指定された場合、レスポンスでマーカーを超えたレコードが最大MaxRecord個返される
␣ResponseMetadata structure 共通メタ情報
␣␣RequestId string リクエスト識別子

エラー

コード メッセージ タイプ HTTPステータスコード 説明
Client.InvalidParameterCombination.DBInstanceIdentifier.and.DBSnapshotIdentifier

Cannot specify both an instance identifier and a snapshot identifier.

 Sender 400 DBInstanceIdentifierとDBSnapshotIdentifierを同時に指定した場合
Client.InvalidParameterCombination.DBSnapshotIdentifier.and.Marker

DBSnapshotIdentifier and Marker cannot both be provided.

 Sender 400 DBSnapshotIdentifierとMarkerを同時に指定した場合
Client.InvalidParameterFormat.DBInstanceIdentifier

The parameter DBInstanceIdentifier 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 DBInstanceIdentifierに無効な値（ハイフンで始まる 等）を指定した場合
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.InvalidParameterIllegalInput.MaxRecords
Sender 400 MaxRecordsに数値でない値を指定した場合
Client.InvalidParameterIllegalInput.SnapshotType

Invalid snapshot type ‘aaa’. Must be blank or one of: manual, automated.

 Sender 400 SnapshotTypeに無効な値を指定した場合
Client.InvalidParameterNotFound.DBSnapshot

DBSnapshot not found: aaa

 Sender 404 存在しないDBSnapshotIdentifierを指定した場合
Client.InvalidParameterOutOfRange.MaxRecords

Invalid value for max records. Must be between 20 and 100

 Sender 400 MaxRecordsに20-100でない値を指定した場合
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 DBSnapshotIdentifier is not a valid identifier because it is longer than 255 characters.

 Sender 400 DBSnapshotIdentifierに255文字を超える値を指定した場合

リクエストサンプル

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

応答サンプル

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

ニフクラ サイト内検索

APIメニュー

  • ツイッターでフォローしてください
  • ニフクラ公式フェイスブックページ
  • ※本ページ記載の金額は、すべて税抜表示です。
  • ※本ページ記載の他社製品名および会社名などは、各社の商標または登録商標です。
  • ※本ページの内容は、2024年11月18日時点の情報です。

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

ページの先頭へ