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

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

DescribeDBClusterSnapshots

返回有关集群快照的信息。API 操作支持分页。

请求参数

有关所有操作的通用参数的信息,请参阅通用参数

DBClusterIdentifier

要为其检索集群快照列表的集群 ID。此参数不能与 DBClusterSnapshotIdentifier 参数一起使用。此参数不区分大小写。

约束:

  • 如果提供,必须与现有 DBCluster 的标识符匹配。

类型:字符串

必需:否

DBClusterSnapshotIdentifier

要描述的特定集群快照标识符。此参数不能与 DBClusterIdentifier 参数一起使用。此值以一个小写字符串存储。

约束:

  • 如果提供,必须与现有 DBClusterSnapshot 的标识符匹配。

  • 如果此标识符用于自动快照,则还必须指定 SnapshotType 参数。

类型:字符串

必需:否

Filters.Filter.N

当前不支持此参数。

类型:Filter 对象数组

必需:否

IncludePublic

设置为 true 以包括可由所有 Amazon Web Services 账户 复制或还原的公有手动集群快照,否则为 false。默认值为 false

类型:布尔值

必需:否

IncludeShared

设置为 true 以包括来自其他 Amazon Web Services 账户 且此 Amazon Web Services 账户 已授权复制或还原的共享手动集群快照,否则为 false。默认值为 false

类型:布尔值

必需:否

Marker

由之前的请求提供的可选分页标记。如果指定此参数,则响应仅包含标记之外的记录,最大数量为 MaxRecords 指定的值。

类型:字符串

必需:否

MaxRecords

包括在响应中的最大记录数。如果存在的记录数超过了指定的MaxRecords 值,则在响应中包含分页记号(标记),以便检索剩余的结果。

默认值:100

约束:最低为 20,最高为 100。

类型:整数

必需:否

SnapshotType

要返回的集群快照的类型。可以指定以下值之一:

  • automated - 返回 Amazon DocumentDB 自动为您的 Amazon Web Services 账户 创建的所有集群快照。

  • manual - 返回您为 Amazon Web Services 账户 手动创建的所有集群快照。

  • shared - 返回与您的 Amazon Web Services 账户 共享的所有手动集群快照。

  • public – 返回已标记为公有的所有集群快照。

如果您未指定 SnapshotType 值,则返回自动和手动集群快照。您可以通过将 IncludeShared 参数设置为 true,在这些结果中包括共享集群快照。您可以通过将 IncludePublic 参数设置为 true,在这些结果中包括公有集群快照。

IncludeSharedIncludePublic 参数不适用于 SnapshotType 的值 manualautomatedSnapshotType 设置为 shared 时,IncludePublic 参数不适用。SnapshotType 设置为 public 时,IncludeShared 参数不适用。

类型:字符串

必需:否

响应元素

服务返回以下元素。

DB ClusterSnapshots .DB .N ClusterSnapshot

提供集群快照列表。

类型:DBClusterSnapshot 对象数组

Marker

由之前的请求提供的可选分页标记。如果指定此参数,则响应仅包含标记之外的记录,最大数量为 MaxRecords 指定的值。

类型:字符串

错误

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

DBClusterSnapshotNotFoundFault

DBClusterSnapshotIdentifier 并不引用现有集群快照。

HTTP 状态代码:404

另请参阅

有关在特定语言的 Amazon SDK 中使用此 API 的更多信息,请参阅以下内容: