本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
DescribeDBClusterSnapshots
傳回叢集快照的相關資訊。此 API 操作支援分頁。
請求參數
如需所有動作的一般參數資訊,請參閱《Common Parameters》。
- DBClusterIdentifier
-
要擷取叢集快照清單的叢集 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。當SnapshotType設為shared時,不適用IncludePublic參數。當SnapshotType設為public時,不適用IncludeShared參數。類型:字串
必要:否
-
回應元素
服務會傳回下列元素。
- DBClusterSnapshots.DBClusterSnapshot.N
-
提供叢集快照的清單。
類型:DBClusterSnapshot 物件陣列
- Marker
-
前一個請求提供的選用分頁字符。若指定此參數,則回應只會包含超過標記的記錄,直到
MaxRecords指定的值為止。類型:字串
錯誤
如需所有動作常見錯誤的資訊,請參閱常見錯誤。
- DBClusterSnapshotNotFoundFault
-
DBClusterSnapshotIdentifier不會參考現有的叢集快照。HTTP 狀態碼:404
另請參閱
如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊,請參閱下列內容: