本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
DescribeDBClusterSnapshots
返回有关集群快照的信息。此 API 操作支持分页。
请求参数
有关所有操作通用的参数的信息,请参阅常见参数.
- DBClusterIdentifier
-
要为其检索集群快照列表的集群的 ID。此参数不能与
DBClusterSnapshotIdentifier
参数。此参数不区分大小写。约束:
-
如果提供,则必须与现有的标识符匹配
DBCluster
.
类型: 字符串
:必需 否
-
- DBClusterSnapshotIdentifier
-
要描述的特定集群快照标识符。此参数不能与
DBClusterIdentifier
参数。此值以一个小写字符串存储。约束:
-
如果提供,则必须与现有的标识符匹配
DBClusterSnapshot
. -
如果此标识符用于自动快照,则还必须指定
SnapshotType
参数。
类型: 字符串
:必需 否
-
- 过滤器。过滤器。
-
当前不支持此参数。
类型: 数组Filter对象
:必需 否
- IncludePublic
-
设置为
true
如果为您提供,则包括可由所有人复制或还原的公有手动集群快照。Amazon Web Services 账户,否则为否则为false
. 默认为false
。类型: Boolean
:必需 否
- IncludeShared
-
设置为
true
包括来自其他人的共享手动集群快照Amazon Web Services 账户那是这个Amazon Web Services 账户已获得复制或恢复的权限,否则false
. 默认为false
。类型: Boolean
:必需 否
- 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
.IncludeShared
和IncludePublic
参数不适用于SnapshotType
的值manual
或automated
。SnapshotType
设置为shared
时,IncludePublic
参数不适用。SnapshotType
设置为public
时,IncludeShared
参数不适用。类型: 字符串
:必需 否
-
响应元素
服务返回以下元素。
- dbcluster erSnapshots.dbcluster erSnapshot.N
-
提供集群快照列表。
类型: 数组DBClusterSnapshot对象
- Marker
-
由之前的请求提供的可选分页标记。如果指定此参数,则响应仅包含标记之外的记录,最大数量为
MaxRecords
指定的值。类型: 字符串
错误
有关所有操作常见错误的信息,请参阅常见错误.
- DBClusterSnapshotNotFoundFault
-
DBClusterSnapshotIdentifier
未引用现有集群快照。HTTP 状态代码:404
另请参阅
有关在特定语言的Amazon软件开发工具包中使用此 API 的更多信息,请参阅以下内容: