本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

# 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>

有关所有操作的通用参数的信息，请参阅[常用参数](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>
如果设置为 system，则输出将显示由 MemoryDB 自动创建的快照。如果设置为 user，则输出将显示手动创建的快照。如果省略，则输出将同时显示自动和手动创建的快照。  
类型：字符串  
必需：否

## 响应语法
<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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/memorydb-2021-01-01/DescribeSnapshots) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/memorydb-2021-01-01/DescribeSnapshots) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/memorydb-2021-01-01/DescribeSnapshots) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/memorydb-2021-01-01/DescribeSnapshots) 
+  [AWS Python 软件开发工具包](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)