本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。
CreateCluster
创建新的 Amazon DocumentDB 弹性集群并返回其集群结构。
请求语法
POST /cluster HTTP/1.1
Content-type: application/json
{
"adminUserName": "string",
"adminUserPassword": "string",
"authType": "string",
"backupRetentionPeriod": number,
"clientToken": "string",
"clusterName": "string",
"kmsKeyId": "string",
"preferredBackupWindow": "string",
"preferredMaintenanceWindow": "string",
"shardCapacity": number,
"shardCount": number,
"shardInstanceCount": number,
"subnetIds": [ "string" ],
"tags": {
"string" : "string"
},
"vpcSecurityGroupIds": [ "string" ]
}URI 请求参数
该请求不使用任何 URI 参数。
请求体
请求接受采用 JSON 格式的以下数据。
- adminUserName
-
Amazon DocumentDB 弹性集群管理员的名称。
约束：
-
必须为 1 到 63 个字母或数字。
-
第一个字符必须是字母。
-
不能使用保留关键字。
类型：字符串
必需：是
-
- adminUserPassword
-
Amazon DocumentDB 弹性集群管理员的密码。密码可以包含任何可打印的 ASCII 字符。
约束：
-
必须包含 8 到 100 个字符。
-
不能包含正斜杠 (/)、双引号 (“) 或“在”符号 (@)。
类型：字符串
必需：是
-
- authType
-
用于确定从何处获取用于访问弹性集群的密码的身份验证类型。有效的类型为
PLAIN_TEXT或SECRET_ARN。类型：字符串
有效值：
PLAIN_TEXT | SECRET_ARN必需：是
- clusterName
-
新弹性集群的名称。该参数作为一个小写字符串存储。
约束：
-
必须包含 1 到 63 个字母、数字或连字符。
-
第一个字符必须是字母。
-
不能以连字符结束或包含两个连续连字符。
示例：
my-cluster类型：字符串
必需：是
-
- shardCapacity
-
分配给每个弹性集群分片的 vCPU 数目。最大值为 64。允许值为 2、4、8、16、32、64。
类型：整数
必需：是
- shardCount
-
分配给弹性集群的分片数目。最大值为 32。
类型：整数
必需：是
- backupRetentionPeriod
-
保留自动快照的天数。
类型：整数
必需：否
- clientToken
-
弹性集群的客户端令牌。
类型：字符串
必需：否
- kmsKeyId
-
用于加密新弹性集群的 KMS 密钥标识符。
KMS 密钥标识符是 KMS 加密密钥的 Amazon 资源名称 (ARN)。如果使用拥有此 KMS 加密密钥的同一 Amazon 账户创建集群，则可以使用 KMS 密钥别名而不是 ARN 作为 KMS 加密密钥。
如果未指定加密密钥，Amazon DocumentDB 将使用 KMS 为您的账户创建的默认加密密钥。您的账户在每个 Amazon 区域都有一个不同的默认加密密钥。
类型：字符串
必需：否
- preferredBackupWindow
-
如果启用了自动备份，则创建自动备份的每日时间范围，由确定
backupRetentionPeriod。类型：字符串
必需：否
- preferredMaintenanceWindow
-
可进行系统维护的每周时间范围（采用通用协调时间（UTC））。
Format:
ddd:hh24:mi-ddd:hh24:mi默认：从每个 8 小时的时间段中随机选择一个 30 分钟的窗口 AWS 区域，发生在一周中的随机某一天。
有效日：Mon、Tue、Wed、Thu、Fri、Sat、Sun
约束：至少为 30 分钟的时段。
类型：字符串
必需：否
- shardInstanceCount
-
应用于弹性集群中所有分片的副本实例数量。
shardInstanceCount值为 1 表示只有一个写入器实例，而任何其他实例都是可用于读取和提高可用性的副本。类型：整数
必需：否
- subnetIds
-
新弹性集群的 Amazon EC2 子网 ID。
类型：字符串数组
必需：否
-
要分配给新弹性集群的标签。
类型：字符串到字符串映射
密钥长度限制：最小长度为 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 格式返回以下数据。
错误
有关所有操作的常见错误的信息，请参阅常见错误。
- AccessDeniedException
-
没有足够权限执行某操作时出现的异常。
HTTP 状态代码：403
- ConflictException
-
存在访问冲突。
HTTP 状态代码：409
- InternalServerException
-
出现内部服务器错误。
HTTP 状态代码：500
- ServiceQuotaExceededException
-
已超过该操作的服务限额。
HTTP 状态代码：400
- ThrottlingException
-
ThrottlingException 当由于请求限制而导致请求被拒绝时，将抛出。
HTTP 状态代码：429
- ValidationException
-
定义验证异常的结构。
HTTP 状态代码：400
另请参阅
有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
