本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
ListClusterSnapshots
傳回指定彈性叢集之快照的相關資訊。
請求語法
GET /cluster-snapshots?clusterArn=clusterArn
&maxResults=maxResults
&nextToken=nextToken
&snapshotType=snapshotType
HTTP/1.1
URI 請求參數
請求會使用下列 URI 參數。
- clusterArn
-
彈性叢集的 ARN 識別碼。
- maxResults
-
要在回應中接收的彈性叢集快照結果數目上限。
有效範圍:最小值 20。最大值為 100。
- nextToken
-
先前請求提供的分頁令牌。如果指定了這個參數,則回應只會包含超出此 Token 的記錄,直到由指定的值為止
max-results
。如果回應中沒有其他資料,將不
nextToken
會傳回。 - snapshotType
-
要傳回的叢集快照類型。您可以指定下列其中一個值:
-
automated
-傳回 Amazon DocumentDB 為您 AWS 的帳戶自動建立的所有叢集快照。 -
manual
-傳回您為 AWS 帳戶手動建立的所有叢集快照。
-
請求主體
請求沒有請求主體。
回應語法
HTTP/1.1 200
Content-type: application/json
{
"nextToken": "string",
"snapshots": [
{
"clusterArn": "string",
"snapshotArn": "string",
"snapshotCreationTime": "string",
"snapshotName": "string",
"status": "string"
}
]
}
回應元素
如果動作成功,則服務傳回 HTTP 200 回應。
服務會傳回下列 JSON 格式的資料。
- nextToken
-
先前請求提供的分頁令牌。如果指定了這個參數,則回應只會包含超出此 Token 的記錄,直到由指定的值為止
max-results
。如果回應中沒有其他資料,將不
nextToken
會傳回。類型:字串
- snapshots
-
指定彈性叢集的快照清單。
類型:ClusterSnapshotInList 物件陣列
錯誤
如需所有動作常見錯誤的資訊,請參閱常見錯誤。
- AccessDeniedException
-
當沒有足夠的權限執行動作時,就會發生例外狀況。
HTTP 狀態碼:403
- InternalServerException
-
發生內部伺服器錯誤。
HTTP 狀態碼:500
- ThrottlingException
-
ThrottlingException 當請求被拒絕時,由於請求限制將被拋出。
HTTP 狀態碼:429
- ValidationException
-
定義驗證例外狀況的結構。
HTTP 狀態碼:400
另請參閱
如需在其中一個特定語言 AWS SDK 中使用此 API 的詳細資訊,請參閱下列內容: