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

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

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 KMS 加密密钥的同一 Amazon Web Services 账户 还原集群,则可以使用 Amazon KMS 密钥别名而不是 Amazon KMS 加密密钥的 ARN。

您可以还原到新集群,并使用与加密源集群所用 Amazon KMS 密钥不同的 Amazon KMS 密钥,加密新集群。新数据库集群使用由 KmsKeyId 参数确定的 Amazon KMS 密钥加密。

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

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

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

如果 DBClusterIdentifier 引用未加密的集群,则将拒绝还原请求。

类型:字符串

必需:否

Port

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

约束:必须是介于 115065535 的值。

默认:引擎的默认端口。

类型:整数

必需:否

RestoreToTime

要将集群还原到的日期和时间。

有效值:通用协调时间(UTC)格式的时间。

约束:

  • 必须在实例的最新可还原时间之前。

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

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

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

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

类型:时间戳

必需:否

RestoreType

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

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

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

约束:如果源数据库群集的引擎版本早于 1.11,则不能指定 copy-on-write

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

类型:字符串

必需:否

StorageType

与数据库集群关联的存储类型。

有关亚马逊 DocumentDB 集群存储类型的信息,请参阅亚马逊 Document DB 开发者指南中的集群存储配置。

存储类型的有效值-standard | iopt1

默认值为 standard

类型:字符串

必需:否

Tags.Tag.N

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

类型:Tag 对象数组

必需:否

UseLatestRestorableTime

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

默认值:false

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

类型:布尔值

必需:否

VpcSecurityGroupIds。 VpcSecurityGroupId.N

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

类型:字符串数组

必需:否

响应元素

服务返回以下元素。

DBCluster

有关集群的详细信息。

类型:DBCluster 对象

错误

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

DBClusterAlreadyExistsFault

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

HTTP 状态代码:400

DBClusterNotFoundFault

DBClusterIdentifier 并不引用现有集群。

HTTP 状态代码:404

DBClusterQuotaExceededFault

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

HTTP 状态代码:403

DBClusterSnapshotNotFoundFault

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

HTTP 状态代码:404

DBSubnetGroupNotFoundFault

DBSubnetGroupName 并不引用现有子网组。

HTTP 状态代码:404

InsufficientDBClusterCapacityFault

集群没有足够的容量用于当前操作。

HTTP 状态代码:403

InsufficientStorageClusterCapacity

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

HTTP 状态代码:400

InvalidDBClusterSnapshotStateFault

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

HTTP 状态代码:400

InvalidDBClusterStateFault

集群未处于有效状态。

HTTP 状态代码:400

InvalidDBSnapshotState

快照的状态不允许执行删除。

HTTP 状态代码:400

InvalidRestoreFault

您无法从虚拟私有云(VPC)备份恢复到非虚拟私有云(VPC)实例。

HTTP 状态代码:400

InvalidSubnet

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

HTTP 状态代码:400

InvalidVPCNetworkStateFault

由于所做的更改,子网组在创建后并不会覆盖所有可用区。

HTTP 状态代码:400

KMSKeyNotAccessibleFault

访问 Amazon KMS 密钥时发生错误。

HTTP 状态代码:400

StorageQuotaExceeded

该请求会导致您超出跨所有实例可提供的已允许存储量。

HTTP 状态代码:400

另请参阅

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