DescribeDBClusters - Amazon DocumentDB

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

DescribeDBClusters

傳回已佈建的 Amazon DocumentDB 叢集的相關資訊。此 API 操作支持分頁。對於某些管理功能,例如叢集和執行個體生命週期管理,Amazon DocumentDB 會運用與 Amazon RDS 和 Amazon Neptune 共用的操作技術。使用filterName=engine,Values=docdb篩選器參數僅傳回 Amazon DocumentDB 叢集。

請求參數

如需所有動作的一般參數資訊,請參閱《Common Parameters》。

DBClusterIdentifier

使用者提供的叢集識別碼。如果指定此參數,則只會傳回來自特定叢集的資訊。此參數不區分大小寫。

約束:

  • 如果提供,則必須與現有的相符DBClusterIdentifier

類型:字串

必要:否

篩選器. N

指定要描述之一或多個叢集的篩選器。

支援的篩選條件:

  • db-cluster-id-接受叢集識別碼和叢集 Amazon 資源名稱 (ARN)。結果清單僅包含這些 ARN 所識別之叢集的相關資訊。

類型:Filter 物件陣列

必要:否

Marker

前一個請求提供的選用分頁字符。若指定此參數,則回應只會包含超過標記的記錄,直到 MaxRecords 指定的值為止。

類型:字串

必要:否

MaxRecords

要在回應中包含的記錄數量上限。如果存在的記錄多於指定MaxRecords值,則響應中包含分頁令牌(標記),以便可以檢索剩餘的結果。

預設:100

限制條件:最小 20,最大 100。

類型:整數

必要:否

回應元素

服務會傳回下列元素。

資料庫叢集器 .n

叢集的清單。

類型:DBCluster 物件陣列

Marker

前一個請求提供的選用分頁字符。若指定此參數,則回應只會包含超過標記的記錄,直到 MaxRecords 指定的值為止。

類型:字串

錯誤

如需所有動作常見錯誤的資訊,請參閱常見錯誤

DBClusterNotFoundFault

DBClusterIdentifier不參照現有的叢集。

HTTP 狀態碼:404

另請參閱

如需在其中一個特定語言 AWS SDK 中使用此 API 的詳細資訊,請參閱下列內容: