本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
DescribeDBClusterSnapshots
傳回叢集快照的相關資訊。此 API 操作支持分頁。
請求參數
如需所有動作的一般參數資訊,請參閱《Common Parameters》。
- DBClusterIdentifier
-
要擷取叢集快照清單的叢集識別碼。此參數無法與參
DBClusterSnapshotIdentifier
數搭配使用。此參數不區分大小寫。約束:
-
如果提供,則必須與現有的識別碼相符
DBCluster
。
類型:字串
必要:否
-
- DBClusterSnapshotIdentifier
-
要說明的特定叢集快照識別碼。此參數無法與參
DBClusterIdentifier
數搭配使用。此值會以小寫字母字串的形式儲存。約束:
-
如果提供,則必須與現有的識別碼相符
DBClusterSnapshot
。 -
如果這是用於自動快照的識別符,也必須指定
SnapshotType
參數。
類型:字串
必要:否
-
- 篩選器. 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
。當SnapshotType
設為shared
時,不適用IncludePublic
參數。當SnapshotType
設為public
時,不適用IncludeShared
參數。類型:字串
必要:否
-
回應元素
服務會傳回下列元素。
- 數據ClusterSnapshots庫 ClusterSnapshot
-
提供叢集快照清單。
類型:DBClusterSnapshot 物件陣列
- Marker
-
前一個請求提供的選用分頁字符。若指定此參數,則回應只會包含超過標記的記錄,直到
MaxRecords
指定的值為止。類型:字串
錯誤
如需所有動作常見錯誤的資訊,請參閱常見錯誤。
- DBClusterSnapshotNotFoundFault
-
DBClusterSnapshotIdentifier
不會參考現有的叢集快照。HTTP 狀態碼:404
另請參閱
如需在其中一個特定語言 AWS SDK 中使用此 API 的詳細資訊,請參閱下列內容: