DescribeDBClusterSnapshots
クラスタースナップショットに関する情報を返します。この API 操作はページ分割に対応しています。
リクエストパラメータ
すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。
- DBClusterIdentifier
-
クラスタースナップショットのリストを取得する DB クラスターの ID。このパラメータは、
DBClusterSnapshotIdentifierパラメータと併用できません。このパラメータは大文字と小文字が区別されません。制約:
-
指定した場合、既存の
DBClusterの識別子と一致する必要があります。
タイプ: 文字列
必須: いいえ
-
- DBClusterSnapshotIdentifier
-
記述する特定のクラスタースナップショット識別子。このパラメータは、
DBClusterIdentifierパラメータと併用できません。この値は小文字で保存されます。制約:
-
指定した場合、既存の
DBClusterSnapshotの識別子と一致する必要があります。 -
この識別子が自動スナップショット用の場合、
SnapshotTypeパラメータも指定する必要があります。
タイプ: 文字列
必須: いいえ
-
- Filters.Filter.N
-
このパラメータは、現在サポートされていません。
型: Filter オブジェクトの配列
必須: いいえ
- IncludePublic
-
公開され、任意の
trueによってコピーまたは復元できる手動クラスタースナップショットを含める場合は AWS アカウント に、それ以外の場合はfalseに設定します。デフォルトはfalseです。型: ブール値
必須: いいえ
- IncludeShared
-
この
trueがコピーまたは復元する許可を与えられている他の AWS アカウント からの共有手動クラスタースナップショットを含める場合は AWS アカウント に、それ以外の場合はfalseに設定します。デフォルトはfalseです。型: ブール値
必須: いいえ
- Marker
-
以前のリクエストによって提供されたオプションのページ割りトークン。このパラメータを指定した場合、レスポンスには
MaxRecordsで指定された値まで、マーカーを超えるレコードのみが含まれます。タイプ: 文字列
必須: いいえ
- MaxRecords
-
レスポンスに含めるレコードの最大数。指定された
MaxRecordsの値よりも多くのレコードが存在する場合、ページ割りトークン (マーカー) がレスポンスに含まれるため、残りの結果を取得できます。デフォルト: 100
制約: 最小 20、最大 100。
タイプ: 整数
必須: いいえ
- SnapshotType
-
返されるクラスタースナップショットのタイプ。次のいずれかの値を指定できます。
-
automated- Amazon DocumentDB が に対して自動作成したクラスタースナップショットをすべて返します。AWS アカウント -
manual- のために手動作成したクラスタースナップショットをすべて返します。AWS アカウント -
shared- に共有される手動クラスタースナップショットをすべて返します。AWS アカウント -
public- 公開とマークされたクラスタースナップショットをすべて返します。
SnapshotTypeの値を指定しない場合、自動と手動の両方のクラスタースナップショットを返します。IncludeSharedパラメータをtrueに設定すると、これらの結果に公開クラスタースナップショットを含めることができます。IncludePublicパラメータをtrueに設定すると、これらの結果に公開クラスタースナップショットを含めることができます。IncludeSharedおよびIncludePublicパラメータは、SnapshotTypeまたはmanualのautomated値には適用されません。IncludePublicがSnapshotTypeに設定されている場合、sharedパラメータは適用されません。IncludeSharedがSnapshotTypeに設定されている場合、publicパラメータは適用されません。タイプ: 文字列
必須: いいえ
-
レスポンス要素
以下の要素がサービスによって返されます。
- DBClusterSnapshots.DBClusterSnapshot.N
-
ユーザーのクラスタースナップショットのリストを提供します。
型: DBClusterSnapshot オブジェクトの配列
- Marker
-
以前のリクエストによって提供されたオプションのページ割りトークン。このパラメータを指定した場合、レスポンスには
MaxRecordsで指定された値まで、マーカーを超えるレコードのみが含まれます。タイプ: 文字列
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- DBClusterSnapshotNotFoundFault
-
DBClusterSnapshotIdentifierは既存のクラスタースナップショットを参照していません。HTTP ステータスコード: 404
以下の資料も参照してください。
言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
