本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
ModifyGlobalCluster
修改 Amazon DocumentDB 全局集群的设置。您可以通过在请求中指定这些参数和新值来更改一个或多个配置参数(例如:删除保护)或全局群集标识符。
注意
此操作仅适用于 Amazon DocumentDB 集群。
请求参数
有关所有操作的通用参数的信息,请参阅通用参数。
- GlobalClusterIdentifier
-
要修改的集群的数据库集群标识符。该参数不区分大小写。
约束:
-
必须匹配现有全局集群的标识符。
类型:字符串
长度限制:长度下限为 1。最大长度为 255。
模式:
[A-Za-z][0-9A-Za-z-:._]*
必需:是
-
- DeletionProtection
-
指示全局集群是否启用了删除保护。在启用删除保护时,无法删除全局集群。
类型:布尔值
必需:否
- NewGlobalClusterIdentifier
-
您修改全局群集时全局群集的新标识符。此值以一个小写字符串存储。
-
必须包含 1 到 63 个字母、数字或连字符
第一个字符必须是字母
不能以连字符结尾,也不能包含两个连续连字符
例如:
my-cluster2
类型:字符串
长度限制:长度下限为 1。最大长度为 255。
模式:
[A-Za-z][0-9A-Za-z-:._]*
必需:否
-
响应元素
服务返回以下元素。
- GlobalCluster
-
一种表示 Amazon DocumentDB 全球集群的数据类型。
类型:GlobalCluster 对象
错误
有关所有操作的常见错误的信息,请参阅常见错误。
- GlobalClusterNotFoundFault
-
GlobalClusterIdentifier
并不引用现有全局集群。HTTP 状态代码:404
- InvalidGlobalClusterStateFault
-
当集群处于这种状态时,无法执行请求的操作。
HTTP 状态代码:400
另请参阅
有关在特定语言的 Amazon SDK 中使用此 API 的更多信息,请参阅以下内容: