CopyDBClusterSnapshot - Amazon DocumentDB
请求参数响应元素错误另请参阅

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

CopyDBClusterSnapshot

复制集群的快照。

要从共享的手动集群快照复制集群快照，SourceDBClusterSnapshotIdentifier 必须为共享的集群快照的 Amazon 资源名称（ARN）。无论加密与否，都只能在相同 AWS 区域中复制共享的数据库集群快照。

要在正在进行复制时取消操作，请在集群快照处于正在复制状态时删除由 TargetDBClusterSnapshotIdentifier 标识的目标集群快照。

请求参数

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

SourceDBClusterSnapshotIdentifier

要复制的集群快照的标识符。此参数不区分大小写。

约束：

  • 必须指定处于可用状态的有效集群快照。

  • 如果源集群快照与副本 AWS 区域 相同，请指定有效的快照标识符。

  • 如果源集群快照在其他账户中 AWS 区域 或由其他 AWS 账户拥有，请指定快照 ARN。

示例：my-cluster-snapshot1

类型：字符串

必需：是

TargetDBClusterSnapshotIdentifier

要从源集群快照创建的新集群快照标识符​。此参数不区分大小写。

约束：

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

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

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

示例：my-cluster-snapshot2

类型：字符串

必需：是

CopyTags

设置为 true，则将源集群快照的所有标签复制到目标集群快照；否则为 false。默认值为 false。

类型：布尔值

必需：否

KmsKeyId

加密集群快照的密 AWS KMS 钥 ID。 AWS KMS 密钥 ID 是 AWS KMS 加密密钥的 Amazon 资源名称 (ARN)、 AWS KMS 密钥标识符或 AWS KMS 密钥别名。

如果您从中复制加密的集群快照 AWS 账户，则可以为指定一个值，KmsKeyId以便使用新的加密密钥对副本进行 AWS KMS 加密。如果您没有为指定值KmsKeyId，则集群快照的副本将使用与源集群快照相同的 AWS KMS 密钥进行加密。

如果您复制与另一个群集共享的加密群集快照 AWS 账户，则必须为指定一个值KmsKeyId。

要将加密的集群快照复制到另一个 AWS 区域集群快照，请将其设置KmsKeyId为要用于加密目标区域中集群快照副本的密 AWS KMS 钥 ID。 AWS KMS 加密密钥特定于它们创建时 AWS 区域 使用的密钥，您不能使用彼此 AWS 区域 的加密密钥 AWS 区域。

如果您复制未加密的集群快照并为 KmsKeyId 参数指定值，则会返回错误。

类型：字符串

必需：否

PreSignedUrl

包含签名版本 4 签名的 CopyDBClusterSnapshot API 操作请求的 URL AWS 区域 ，其中包含要复制的源集群快照。从另一个 AWS 区域复制集群快照时，必须使用 PreSignedUrl 参数。

如果您使用的是 S AWS DK 工具或 AWS CLI，则可以指定SourceRegion（或 --source-region AWS CLI），而不是PreSignedUrl手动指定。指定 SourceRegion 会自动生成一个预签名 URL，它是可在源 AWS 区域中执行的操作的有效请求。

预签名 URL 必须是对 CopyDBClusterSnapshot API 操作的有效请求，该操作可以在 AWS 区域 包含要复制的集群快照的源中执行。预签名 URL 请求必须包含以下参数值：

  • SourceRegion - 包含要复制的快照的区域的 ID。

  • SourceDBClusterSnapshotIdentifier - 要复制的加密集群快照的标识符。对于源 AWS 区域，此标识符必须采用 Amazon 资源名称（ARN）格式。例如，如果您从 us-east-1 AWS 区域复制加密集群快照，则 SourceDBClusterSnapshotIdentifier 应类似于下文：arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot。

  • TargetDBClusterSnapshotIdentifier - 要复制的新集群快照的标识符。该参数不区分大小写。

类型：字符串

必需：否

Tags.Tag.N

要分配给集群快照的标签。

类型：Tag 对象数组

必需：否

响应元素

服务返回以下元素。

DBClusterSnapshot

有关集群快照的详细信息。

类型：DBClusterSnapshot 对象

错误

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

DBClusterSnapshotAlreadyExistsFault

您已经有一个带有给定标识符的集群快照。

HTTP 状态代码：400

DBClusterSnapshotNotFoundFault

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

HTTP 状态代码：404

InvalidDBClusterSnapshotStateFault

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

HTTP 状态代码：400

InvalidDBClusterStateFault

集群未处于有效状态。

HTTP 状态代码：400

KMSKeyNotAccessibleFault

访问 AWS KMS 密钥时出错。

HTTP 状态代码：400

SnapshotQuotaExceeded

该请求会导致您超过允许的快照数目。

HTTP 状态代码：400

另请参阅

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：