UpdateCluster - Amazon DocumentDB

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

UpdateCluster

修改一个弹性集群。这包括更新管理员用户名/密码、升级 API 版本,以及设置备份时段和维护时段

请求语法

PUT /cluster/clusterArn HTTP/1.1 Content-type: application/json { "adminUserPassword": "string", "authType": "string", "backupRetentionPeriod": number, "clientToken": "string", "preferredBackupWindow": "string", "preferredMaintenanceWindow": "string", "shardCapacity": number, "shardCount": number, "shardInstanceCount": number, "subnetIds": [ "string" ], "vpcSecurityGroupIds": [ "string" ] }

URI 请求参数

请求使用以下 URI 参数。

clusterArn

弹性集群的 ARN 标识符。

必需:是

请求体

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

adminUserPassword

与弹性集群管理员关联的密码。此密码可以包含除正斜杠 (/)、双引号 (") 或 @ 符号之外的任何可打印的 ASCII 字符。

约束:必须包含 8 到 100 个字符。

类型:字符串

必需:否

authType

用于确定从何处获取用于访问弹性集群的密码的身份验证类型。有效的类型为 PLAIN_TEXTSECRET_ARN

类型:字符串

有效值:PLAIN_TEXT | SECRET_ARN

必需:否

backupRetentionPeriod

保留自动快照的天数。

类型:整数

必需:否

clientToken

弹性集群的客户端令牌。

类型:字符串

必需:否

preferredBackupWindow

如果启用了自动备份,则创建自动备份的每日时间范围,由确定backupRetentionPeriod

类型:字符串

必需:否

preferredMaintenanceWindow

可进行系统维护的每周时间范围(采用通用协调时间(UTC))。

Format: ddd:hh24:mi-ddd:hh24:mi

默认:从每个 8 小时的时间段中随机选择一个 30 分钟的窗口 AWS 区域,发生在一周中的随机某一天。

有效日:Mon、Tue、Wed、Thu、Fri、Sat、Sun

约束:至少为 30 分钟的时段。

类型:字符串

必需:否

shardCapacity

分配给每个弹性集群分片的 vCPU 数目。最大值为 64。允许值为 2、4、8、16、32、64。

类型:整数

必需:否

shardCount

分配给弹性集群的分片数目。最大值为 32。

类型:整数

必需:否

shardInstanceCount

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

类型:整数

必需:否

subnetIds

弹性集群的 Amazon EC2 子网 ID。

类型:字符串数组

必需:否

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

ThrottlingException

ThrottlingException 当由于请求限制而导致请求被拒绝时,将抛出。

HTTP 状态代码:429

ValidationException

定义验证异常的结构。

HTTP 状态代码:400

另请参阅

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