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

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

RestoreDBClusterToPointInTime

将集群还原到任意时间点。用户可以还原到 LatestRestorableTime 之前最多 BackupRetentionPeriod 天的任意时间点。目标集群是从源集群创建的,其配置与原始集群相同,唯一的不同是新集群是使用默认安全组创建的。

请求参数

有关所有操作的通用参数的信息,请参见常见参数.

DBClusterIdentifier

要创建的新集群的名称。

约束:

  • 必须包含 1 到 63 个字母、数字或连字符。

  • 第一个字符必须是字母。

  • 不能以连字符结束或包含两个连续连字符。

类型: 字符串

需 是

SourceDBClusterIdentifier

要从中还原的源集群的标识符。

约束:

  • 必须与现有标识符匹配DBCluster.

类型: 字符串

需 是

DBSubnetGroupName

用于新集群的子网组名称。

约束:如果提供,则与现有的名称匹配DBSubnetGroup.

示例:mySubnetgroup

类型: 字符串

需 否

DeletionProtection

指定是否可以删除此集群。如果DeletionProtection已删除集群,除非集群被修改并DeletionProtection已禁用。DeletionProtection防止意外删除集群。

类型: 布尔值

需 否

EnableCloudwatchLogsExports.member.n

必须启用后才能导出到 Amazon 的日志类型的列表 CloudWatch日志。

类型: 字符串数组

需 否

KmsKeyId

这些区域有:Amazon KMS从加密集群恢复加密集群时使用的密钥标识符。

Amazon KMS 密钥标识符是 Amazon KMS 加密密钥的 Amazon 资源名称(ARN)。如果您要恢复具有相同功能的集群Amazon Web Services 账户谁拥有Amazon KMS用于加密新集群的加密密钥,则可以使用Amazon KMS密钥别名而不是 ARNAmazon KMS加密密钥。

您可以恢复到新集群并使用以下命令对新集群进行加密Amazon KMS密钥的密钥Amazon KMS用于加密源集群的密钥。新的数据库集群已加密Amazon KMS密钥由标识KmsKeyId参数。

如果不为 KmsKeyId 参数指定值,则会出现以下情况:

  • 如果集群已加密,则使用对还原的集群进行加密Amazon KMS用于加密源群集的密钥。

  • 如果集群未加密,则还原的集群未加密。

如果DBClusterIdentifier指未加密的集群,则恢复请求被拒绝。

类型: 字符串

需 否

Port

新集群用于接受连接的端口号。

约束:值必须为来自于115065535.

默认值:引擎的默认端口。

类型: 整数

需 否

RestoreToTime

将集群恢复到的日期和时间。

有效值:采用通用协调时间 (UC) 格式的时间 (UC)

约束:

  • 必须早于实例的最新可恢复时间。

  • 如果未提供 UseLatestRestorableTime 参数,则必须指定。

  • 如果 UseLatestRestorableTime 参数为 true,则无法指定。

  • 如果 RestoreType 参数为 copy-on-write,则无法指定。

示例:2015-03-07T23:45:00Z

类型: 时间戳

需 否

RestoreType

要执行的还原类型。可以指定以下值之一:

  • full-copy – 新数据库集群作为源数据库集群的完整副本还原。

  • copy-on-write – 新数据库集群作为源数据库集群的克隆还原。

约束:你无法指定copy-on-write如果源数据库集群的引擎版本早于 1.11。

如果您没有指定 RestoreType 值,则新数据库集群作为源数据库集群的完整副本还原。

类型: 字符串

需 否

Tags.Tag.N

要分配给还原集群的标签。

类型: 数组Tag对象

需 否

UseLatestRestorableTime

一个设置为的值true将集群还原到最近的可还原备份时间,false否则。

默认值:false

约束:如果未提供 RestoreToTime 参数,则无法指定。

类型: 布尔值

需 否

VpcSecurityGroupIds.VpcSecurityGroupId否

新集群所属的 VPC 安全组的列表。

类型: 字符串数组

需 否

响应元素

以下元素由服务返回。

DBCluster

有关集群的详细信息。

类型:DBCluster 对象

错误

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

DBClusterAlreadyExistsFault

您已经有一个具有给定标识符的集群。

HTP 状态代码:400

DBClusterNotFoundFault

DBClusterIdentifier不引用现有集群。

HTP 状态代码:404

DBClusterQuotaExceededFault

无法创建集群,因为您已达到允许的最大集群配额。

HTP 状态代码:403

DBClusterSnapshotNotFoundFault

DBClusterSnapshotIdentifier不引用现有集群快照。

HTP 状态代码:404

DBSubnetGroupNotFoundFault

DBSubnetGroupName不引用现有子网组。

HTP 状态代码:404

InsufficientDBClusterCapacityFault

集群没有足够的容量来执行当前操作。

HTP 状态代码:403

InsufficientStorageClusterCapacity

没有足够的存储空间可供当前操作使用。您可以通过更新子网组以使用具有更多可用存储空间的不同可用区来解决此错误。

HTP 状态代码:400

InvalidDBClusterSnapshotStateFault

提供的值不是有效的集群快照状态。

HTP 状态代码:400

InvalidDBClusterStateFault

集群未处于有效状态。

HTP 状态代码:400

InvalidDBSnapshotState

快照的状态不允许删除。

HTP 状态代码:400

InvalidRestoreFault

您无法从 Virtual Private Cloud (VPC) 中还原到非 VPC

HTP 状态代码:400

InvalidSubnet

请求的子网无效,或者请求的多个子网并非全部位于公共虚拟私有云 (VPC) 中。

HTP 状态代码:400

InvalidVPCNetworkStateFault

由于进行了更改,子网组在创建后并未覆盖所有可用区。

HTP 状态代码:400

KMSKeyNotAccessibleFault

访问时出错Amazon KMS钥匙。

HTP 状态代码:400

StorageQuotaExceeded

该请求将导致您超过所有实例的允许可用存储量。

HTP 状态代码:400

另请参阅

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