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

# DescribeSnapshots
<a name="API_DescribeSnapshots"></a>

傳回叢集快照的相關資訊。根據預設，DescribeSnapshots 會列出所有快照；它可以選擇性地描述單一快照，或僅描述與特定叢集相關聯的快照。

## 請求語法
<a name="API_DescribeSnapshots_RequestSyntax"></a>

```
{
   "ClusterName": "string",
   "MaxResults": number,
   "NextToken": "string",
   "ShowDetail": boolean,
   "SnapshotName": "string",
   "Source": "string"
}
```

## 請求參數
<a name="API_DescribeSnapshots_RequestParameters"></a>

如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

請求接受採用 JSON 格式的下列資料。

 ** [ClusterName](#API_DescribeSnapshots_RequestSyntax) **   <a name="MemoryDB-DescribeSnapshots-request-ClusterName"></a>
使用者提供的叢集識別符。如果指定此參數，則只會描述與該特定叢集相關聯的快照。  
類型：字串  
必要：否

 ** [MaxResults](#API_DescribeSnapshots_RequestSyntax) **   <a name="MemoryDB-DescribeSnapshots-request-MaxResults"></a>
要在回應中包含的記錄數量上限。如果存在的記錄超過指定的 MaxResults 值，則會在回應中包含權杖，以便擷取剩餘的結果。  
類型：整數  
必要：否

 ** [NextToken](#API_DescribeSnapshots_RequestSyntax) **   <a name="MemoryDB-DescribeSnapshots-request-NextToken"></a>
如果記錄總數超過 MaxResults 的值，要傳遞的選用引數。如果傳回 nextToken，則會有更多結果可用。nextToken 的值是每個頁面的唯一分頁字符。使用傳回的字符再次進行呼叫，以擷取下一頁。讓所有其他引數保持不變。  
類型：字串  
必要：否

 ** [ShowDetail](#API_DescribeSnapshots_RequestSyntax) **   <a name="MemoryDB-DescribeSnapshots-request-ShowDetail"></a>
布林值，如果為 true，碎片組態會包含在快照描述中。  
類型：布林值  
必要：否

 ** [SnapshotName](#API_DescribeSnapshots_RequestSyntax) **   <a name="MemoryDB-DescribeSnapshots-request-SnapshotName"></a>
使用者提供的快照名稱。如果指定此參數，則只會描述此具名快照。  
類型：字串  
必要：否

 ** [Source](#API_DescribeSnapshots_RequestSyntax) **   <a name="MemoryDB-DescribeSnapshots-request-Source"></a>
如果設定為系統，輸出會顯示由 MemoryDB 自動建立的快照。如果設定為使用者，輸出會顯示手動建立的快照。如果省略，輸出會顯示自動和手動建立的快照。  
類型：字串  
必要：否

## 回應語法
<a name="API_DescribeSnapshots_ResponseSyntax"></a>

```
{
   "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"
      }
   ]
}
```

## 回應元素
<a name="API_DescribeSnapshots_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [NextToken](#API_DescribeSnapshots_ResponseSyntax) **   <a name="MemoryDB-DescribeSnapshots-response-NextToken"></a>
如果記錄總數超過 MaxResults 的值，要傳遞的選用引數。如果傳回 nextToken，則會有更多結果可用。nextToken 的值是每個頁面的唯一分頁字符。使用傳回的字符再次進行呼叫，以擷取下一頁。讓所有其他引數保持不變。  
類型：字串

 ** [Snapshots](#API_DescribeSnapshots_ResponseSyntax) **   <a name="MemoryDB-DescribeSnapshots-response-Snapshots"></a>
快照清單。清單中的每個項目都包含一個快照的詳細資訊。  
類型：[Snapshot](API_Snapshot.md) 物件陣列

## 錯誤
<a name="API_DescribeSnapshots_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** InvalidParameterCombinationException **   
  
HTTP 狀態碼：400

 ** InvalidParameterValueException **   
  
HTTP 狀態碼：400

 ** ServiceLinkedRoleNotFoundFault **   
  
HTTP 狀態碼：400

 ** SnapshotNotFoundFault **   
  
HTTP 狀態碼：400

## 另請參閱
<a name="API_DescribeSnapshots_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/memorydb-2021-01-01/DescribeSnapshots) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/memorydb-2021-01-01/DescribeSnapshots) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/memorydb-2021-01-01/DescribeSnapshots) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/memorydb-2021-01-01/DescribeSnapshots) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/memorydb-2021-01-01/DescribeSnapshots) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/memorydb-2021-01-01/DescribeSnapshots) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/memorydb-2021-01-01/DescribeSnapshots) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/memorydb-2021-01-01/DescribeSnapshots) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/memorydb-2021-01-01/DescribeSnapshots) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/memorydb-2021-01-01/DescribeSnapshots)