RestoreClusterFromSnapshot - Amazon DocumentDB
请求语法URI 请求参数请求体响应语法响应元素错误另请参阅

RestoreClusterFromSnapshot

从快照还原弹性集群

请求语法

POST /cluster-snapshot/snapshotArn/restore HTTP/1.1
Content-type: application/json

{
   "clusterName": "string",
   "kmsKeyId": "string",
   "shardCapacity": number,
   "shardInstanceCount": number,
   "subnetIds": [ "string" ],
   "tags": { 
      "string" : "string" 
   },
   "vpcSecurityGroupIds": [ "string" ]
}

URI 请求参数

请求使用以下 URI 参数。

snapshotArn

弹性集群快照的标识符。

必需：是

请求体

请求接受采用 JSON 格式的以下数据。

clusterName

弹性集群的名称。

类型：字符串

必需：是

kmsKeyId

用于加密新 Amazon DocumentDB 弹性集群的 KMS 密钥标识符。

KMS 密钥标识符是 KMS 加密密钥的 Amazon 资源名称 (ARN)。如果使用拥有此 KMS 加密密钥的同一 Amazon 账户创建集群，则可以使用 KMS 密钥别名而不是 ARN 作为 KMS 加密密钥。

如果此处未指定加密密钥，Amazon DocumentDB 将使用 KMS 为您的账户创建的默认加密密钥。您的账户在每个 Amazon 区域都有一个不同的默认加密密钥。

类型：字符串

必需：否

shardCapacity

新恢复的弹性集群中每个分片的容量。

类型：整数

必需：否

shardInstanceCount

适用于弹性集群中所有分片的副本实例的数量。shardInstanceCount 值为 1 表示有一个写入器实例，其他任何实例都是可用于读取和提高可用性的副本。

类型：整数

必需：否

subnetIds

弹性集群的 Amazon EC2 子网 ID。

类型：字符串数组

必需：否

tags

待分配给已恢复弹性集群的标签名称列表，处于其中键是标签名称且值为键值的键-值对数组形式。

类型：字符串到字符串映射

密钥长度限制：最小长度为 1。长度上限为 128。

键模式：^(?!aws:)[a-zA-Z+-=._:/]+$

值长度限制：最小长度为 0。最大长度为 256。

必需：否

vpcSecurityGroupIds

要与弹性集群关联的 EC2 VPC 安全组的列表。

类型：字符串数组

必需：否

响应语法

HTTP/1.1 200
Content-type: application/json

{
   "cluster": { 
      "adminUserName": "string",
      "authType": "string",
      "backupRetentionPeriod": number,
      "clusterArn": "string",
      "clusterEndpoint": "string",
      "clusterName": "string",
      "createTime": "string",
      "kmsKeyId": "string",
      "preferredBackupWindow": "string",
      "preferredMaintenanceWindow": "string",
      "shardCapacity": number,
      "shardCount": number,
      "shardInstanceCount": number,
      "shards": [ 
         { 
            "createTime": "string",
            "shardId": "string",
            "status": "string"
         }
      ],
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}

响应元素

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

cluster

返回有关已恢复弹性集群的信息。

类型：Cluster 对象

错误

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

AccessDeniedException

没有足够权限执行某操作时出现的异常。

HTTP 状态代码：403

ConflictException

存在访问冲突。

HTTP 状态代码：409

InternalServerException

出现内部服务器错误。

HTTP 状态代码：500

ResourceNotFoundException

不能定位指定的资源。

HTTP 状态代码：404

ServiceQuotaExceededException

已超过该操作的服务限额。

HTTP 状态代码：402

ThrottlingException

因请求节流拒绝请求时，将抛出 throttlingException。

HTTP 状态代码：429

ValidationException

定义验证异常的结构。

HTTP 状态代码：400

另请参阅

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