创建或修改集群的白名单（包括IP白名单和安全组）。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| DBClusterId |
string |
是 |
集群 ID。 |
pc-************* |
| SecurityIps |
string |
否 |
IP 白名单分组中的 IP 地址或地址段。所有 IP 白名单分组累积支持 1000 个 IP 地址或地址段，多个 IP 间用英文逗号（,）隔开，支持如下两种格式：
说明
当 WhiteListType 取值为 IP 时该参数才支持配置。 |
10.23.12.24 |
| DBClusterIPArrayName |
string |
否 |
IP 白名单分组的名称。分组名称长度需为 2~120 个字符；由小写字母和数字组成；以字母开头，以字母或数字结尾。
说明
|
default |
| DBClusterIPArrayAttribute |
string |
否 |
IP 白名单分组属性。设置为 hidden 后控制台不可见。 说明
|
hidden |
| WhiteListType |
string |
否 |
白名单类型。取值范围如下：
默认值为 IP。 |
IP |
| SecurityGroupIds |
string |
否 |
安全组 ID，多个安全组间用英文逗号（,）隔开。 说明
|
sg-********* |
| ModifyMode |
string |
否 |
IP 白名单的修改方式，取值范围如下：
说明
当 WhiteListType 取值为 IP 时该参数才支持配置。 |
Cover |
| PfsInstanceId |
string |
否 |
pfs-xxx |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求 ID。 |
D0CEC6AC-7760-409A-A0D5-E6CD86****** |
示例
正常返回示例
JSON格式
{
"RequestId": "D0CEC6AC-7760-409A-A0D5-E6CD86******"
}异常返回示例
JSON格式
{
"RequestId": "D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC"
}错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | NumberExceed.securityGroupIds | The number of SecurityGroupIds exceeds 10. | 操作失败，已超过安全组数量（上限：10个）。请修改后重试。 |
| 400 | InvalidSecurityIPList.Duplicate | Specified security IP list is not valid: Duplicate IP address in the list | 指定的安全IP列表无效：列表中有重复的IP地址 |
| 400 | InvalidSecurityIPList.Format | Specified security IP list format is not valid. | 指定的白名单IP地址格式错误。 |
| 400 | LockTimeout | The request processing has failed due to lock timeout. | 由于锁定超时，请求处理失败 |
| 403 | SecurityIPList.Duplicate | Specified same security IP already exists. | 指定的相同安全IP已存在 |
| 403 | OperationDenied.LockMode | The operation is not permitted when the instance is locked. | 操作失败，状态为锁定的实例不支持该操作。 |
| 404 | InvalidDBCluster.NotFound | The DBClusterId provided does not exist in our records. | 当前的记录中不存在提供的DBClusterId。 |
| 404 | InvalidDBClusterId.NotFound | The DBInstanceId provided does not exist in our records. | 当前的记录中不存在提供的DBClusterId。 |
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。