All Products
Document Center

ApsaraDB for MongoDB:ModifySecurityIps

Last Updated:Nov 06, 2023

You can call this operation to modify the IP address whitelist of an ApsaraDB for MongoDB instance.


You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.


Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
  • dbinstance

Request parameters


The ID of an instance.


The IP addresses in an IP address whitelist. Separate multiple IP addresses with commas (,). You can add a maximum of 1,000 different IP addresses to a whitelist. You can add IP addresses in one of the following two formats:

  • IP addresses. Example:
  • Classless Inter-Domain Routing (CIDR) blocks, such as, where 24 indicates that the prefix of the CIDR block is 24-bit long. You can replace 24 with a value within the range of 1 to 32.,

The method of modification. Valid values:

  • Cover: overwrites the whitelist.
  • Append: appends data to the whitelist.
  • Delete: deletes the whitelist.

The default value is Cover.


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


The attributes of an IP address whitelist. It can contain a maximum of 120 characters in length and can contain uppercase letters, lowercase letters, and digits.

This parameter is empty by default.


Response parameters


The ID of the request.



Sample success responses


  "RequestId": "61B05CCF-EBAB-4BF3-BA67-D77256A721E2"

Error codes

HTTP status codeError codeError message
400InvalidSecurityIps.MalFormedThe specified parameter "SecurityIps" is not valid.
400InvalidSecurityIPListLength.MalformedThe Security IP address is not in the available range or occupied.
400InvalidInstanceIp.DuplicateThe quota of security ip exceeds.
400InvalidGroupName.FormatSepecified group name is not valid.
404InvalidSecurityIPs.NotFoundThe Specified same security IP does not exist or at least one security IP need.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history