ModifySecurityIps - 修改IP白名单

重要

本文中含有需要您注意的重要提示信息,忽略该信息可能对您的业务造成影响,请务必仔细阅读。

设置云数据库 Tair(兼容 Redis)实例的IP白名单。

接口说明

该 API 对应的控制台操作请参见设置 IP 白名单

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
kvstore:ModifySecurityIpsupdate
  • DBInstance
    acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

请求参数

名称类型必填描述示例值
InstanceIdstring

实例 ID。

r-bp1zxszhcgatnx****
SecurityIpsstring

IP 白名单分组下的 IP 列表,最多 1000 个。IP 之间以逗号隔开,格式如下:0.0.0.0/0,10.23.12.24,或者 10.23.12.24/24(CIDR 模式,无类域间路由,/24 表示地址中前缀的长度,范围 1-32)。

100.64.***.0/24,10.101.11.***
SecurityIpGroupNamestring

IP 白名单分组的名称。

警告 不可修改系统生成白名单分组。如果不传此字段,将默认修改 default 分组的白名单

default
SecurityIpGroupAttributestring

默认为空。用于区分不同的属性值,控制台将不显示该值为 hidden 的白名单分组。

hidden
ModifyModestring

修改方式,取值:

  • Cover(默认):覆盖原白名单。
  • Append:追加白名单。
  • Delete:删除该白名单。
Append

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

AAAF99B1-69ED-4E80-8CD5-272C09E4****

示例

正常返回示例

JSON格式

{
  "RequestId": "AAAF99B1-69ED-4E80-8CD5-272C09E4****"
}

错误码

HTTP status code错误码错误信息描述
400Forbbiden.MinorVersionThe operation is not permitted for current minor version. 当前版本该操作是不允许的。
400InvalidGroupName.FormatSepecified group name is not valid.-
400LockTimeoutThe request processing has failed due to lock timeout.当前请求与其他请求冲突,请稍后重试
404InvalidSecurityIPList.NotFoundSpecified same security IP does not exist or at least one security IP need.白名单分组中未找到与指定IP相同的IP,或未传入IP
409SecurityIPList.DuplicateSpecified same security IP already exists.指定的白名单分组中已经包含了相同的IP

访问错误中心查看更多错误码。