DescribeSnapshots - Amazon 内存 DB
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 Amazon Web Services 服务入门

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

DescribeSnapshots

返回有关集群快照的信息。默认情况下, DescribeSnapshots 列出您的所有快照;它可以选择描述单个快照,也可以仅描述与特定集群关联的快照。

请求语法

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

请求参数

有关适用于所有操作的常用参数的信息,请参阅Commmmon Parameters (常用参数)。

请求接受采用 JSON 格式的以下数据。

ClusterName

用户提供的集群标识符。如果指定了此参数,则仅描述与该特定集群关联的快照。

类型:字符串

必需:否

MaxResults

包括在响应中的最大记录数。如果存在的记录多于指定 MaxResults 值,则响应中会包含一个标记,以便检索其余结果。

类型:整数

必需:否

NextToken

一个可选参数,用于在记录总数超过的值时传递 MaxResults。如果返回 nextToken,则还有更多结果可用。NextToken 的值是每个页面的唯一分页标记。使用返回的令牌再次调用以检索下一页。保持所有其他参数不变。

类型:字符串

必需:否

ShowDetail

一个布尔值,如果为 true,则分片配置包含在快照描述中。

类型:布尔值

必需:否

SnapshotName

快照的用户提供名称。如果指定了此参数,则仅描述了此命名快照。

类型:字符串

必需:否

Source

如果设置为系统,输出将显示由 MemoryDB 自动创建的快照。如果设置为 user,则输出将显示手动创建的快照。如果省略,输出将显示自动和手动创建的快照。

类型:字符串

必需:否

响应语法

{ "NextToken": "string", "Snapshots": [ { "ARN": "string", "ClusterConfiguration": { "Description": "string", "EngineVersion": "string", "MaintenanceWindow": "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 格式返回的以下数据。

NextToken

一个可选参数,用于在记录总数超过的值时传递 MaxResults。如果返回 nextToken,则还有更多结果可用。NextToken 的值是每个页面的唯一分页标记。使用返回的令牌再次调用以检索下一页。保持所有其他参数不变。

类型:字符串

Snapshots

快照列表。列表中的每个项目都包含有关一个快照的详细信息。

类型:Snapshot 对象数组

错误

有关所有操作常见错误的信息,请参阅常见错误

InvalidParameterCombinationException

HTTP 状态代码:400

InvalidParameterValueException

HTTP 状态代码:400

ServiceLinkedRoleNotFoundFault

HTTP 状态代码:400

SnapshotNotFoundFault

HTTP 状态代码:400

另请参阅

有关在特定语言的 Amazon 软件开发工具包中使用此 API 的更多信息,请参阅以下内容: