You can call this operation to modify a whitelist.

When you call this operation, the instance must be in the running state.


You can use OpenAPI Explorer to perform debugging. OpenAPI Explorer allows you to perform various operations to simplify API usage. For example, you can retrieve APIs, call APIs, and dynamically generate SDK example code.

Request parameters

Parameter Type Required? Example Description
Action String Yes ModifySecurityIps

The operation that you want to perform. Set this parameter to ModifySecurityIps.

DBInstanceId String Yes rm-uf6wjk5xxxxxxx

The ID of the instance.

SecurityIps String Yes

The IP address whitelist of the instance. Multiple IP addresses must be separated with commas (,), and cannot be the same. Up to 1,000 IP addresses can be entered in a single request. Two formats are supported:

  • IP address. For example,
  • CIDR block. For example, /24 indicates the prefix length of the address is 24 bits. The prefix length varies from 1 to 32 bits.
Note Each instance can contain up to 1,000 IP addresses or CIDR blocks. If you want to add more than 1,000 IP addresses, we recommend that you combine the addresses into CIDR blocks such as
DBInstanceIPArrayName String No test

The name of the IP address whitelist to be modified. Default value: default.

Note You can create up to 200 whitelist groups for an instance.
DBInstanceIPArrayAttribute String No hidden

The attribute of the whitelist group. It is empty by default.

Note The groups with hidden attribute are not displayed in the console. The groups with hidden attribute are used to access DTS and DRDS.
Modifymode String No Cover

The modification method. Valid values:

  • Cover: to overwrite the original IP address whitelist.
  • Append: to add IP addresses to the whitelist.
  • Delete: to delete IP addresses from the whitelist.

Default value: Cover

WhitelistNetworkType String No Classic

The network type of the whitelist. Valid values:

  • Classic: classic networks in safe mode.
  • VPC: VPCs in safe mode.
  • Mix: In standard mode, the IP addresses are added to the normal group. In safe mode, the IP addresses are added to both classic network and VPC groups.

Default value: Mix.

SecurityGroupId String No rg-acfmyxxxxx

The ID of the security group.

SecurityIPType String No IPv4

The type of the IP address.

Response parameters

Parameter Type Example Description
RequestId String 1AD222E9-E606-4A42-BF6D-8A4442913CEF

The ID of the request.

TaskId String 115855279

The ID of the task.


Sample requests

http(s):// &Action= ModifySecurityIps
&<Common request parameters>

Successful response examples

XML format

	  <RequestId> 1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>

JSON format

	"RequestId":" 1AD222E9-E606-4A42-BF6D-8A4442913CEF",

Error codes

For a list of error codes, visit the API Error Center.