本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
DescribeSnapshots
傳回叢集快照的相關資訊。根據預設,DescribeSnapshots 會列出所有快照;它可以選擇性地描述單一快照,或僅描述與特定叢集相關聯的快照。
請求語法
{
"ClusterName": "string
",
"MaxResults": number
,
"NextToken": "string
",
"ShowDetail": boolean
,
"SnapshotName": "string
",
"Source": "string
"
}
請求參數
如需所有動作的一般參數資訊,請參閱《Common Parameters》。
請求接受採用 JSON 格式的下列資料。
- ClusterName
-
使用者提供的叢集識別符。如果指定此參數,則只會描述與該特定叢集相關聯的快照。
類型:字串
必要:否
- MaxResults
-
要在回應中包含的記錄數量上限。如果存在的記錄超過指定的 MaxResults 值,則會在回應中包含權杖,以便擷取剩餘的結果。
類型:整數
必要:否
- NextToken
-
如果記錄總數超過 MaxResults 的值,要傳遞的選用引數。如果傳回 nextToken,則會有更多結果可用。nextToken 的值是每個頁面的唯一分頁字符。使用傳回的字符再次進行呼叫,以擷取下一頁。讓所有其他引數保持不變。
類型:字串
必要:否
- ShowDetail
-
布林值,如果為 true,碎片組態會包含在快照描述中。
類型:布林值
必要:否
- SnapshotName
-
使用者提供的快照名稱。如果指定此參數,則只會描述此具名快照。
類型:字串
必要:否
- Source
-
如果設定為系統,輸出會顯示由 MemoryDB 自動建立的快照。如果設定為使用者,輸出會顯示手動建立的快照。如果省略,輸出會顯示自動和手動建立的快照。
類型:字串
必要:否
回應語法
{
"NextToken": "string",
"Snapshots": [
{
"ARN": "string",
"ClusterConfiguration": {
"Description": "string",
"Engine": "string",
"EngineVersion": "string",
"MaintenanceWindow": "string",
"MultiRegionClusterName": "string",
"MultiRegionParameterGroupName": "string",
"Name": "string",
"NodeType": "string",
"NumShards": number,
"ParameterGroupName": "string",
"Port": number,
"Shards": [
{
"Configuration": {
"ReplicaCount": number,
"Slots": "string"
},
"Name": "string",
"Size": "string",
"SnapshotCreationTime": number
}
],
"SnapshotRetentionLimit": number,
"SnapshotWindow": "string",
"SubnetGroupName": "string",
"TopicArn": "string",
"VpcId": "string"
},
"DataTiering": "string",
"KmsKeyId": "string",
"Name": "string",
"Source": "string",
"Status": "string"
}
]
}
回應元素
如果動作成功,則服務傳回 HTTP 200 回應。
服務會傳回下列 JSON 格式的資料。
錯誤
如需所有動作常見錯誤的資訊,請參閱常見錯誤。
- InvalidParameterCombinationException
-
HTTP 狀態碼:400
- InvalidParameterValueException
-
HTTP 狀態碼:400
- ServiceLinkedRoleNotFoundFault
-
HTTP 狀態碼:400
- SnapshotNotFoundFault
-
HTTP 狀態碼:400
另請參閱
如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊,請參閱下列內容: