All Products
Search
Document Center

ApsaraDB for MongoDB:ModifySecurityIps

Last Updated:Mar 15, 2024

Modifies the IP address whitelists of an ApsaraDB for MongoDB instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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
dds:ModifySecurityIpsWRITE
  • dbinstance
    acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceIdstringYes

The instance ID.

dds-bp*****
SecurityIpsstringYes

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

  • IP addresses, such as 127.0.0.1.
  • CIDR blocks, such as 127.0.0.1/24. In this example, 24 indicates that the prefix of each IP address in the IP address whitelist is 24 bits in length. You can replace 24 with a value within the range of 1 to 32.
127.0.0.1/24,127.0.0.1
ModifyModestringNo

The method that is used to modify the IP address whitelist. Valid values:

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

Default value: Cover.

Append
SecurityIpGroupNamestringNo

The name of the IP address whitelist that you want to modify. Default value: default.

allowserver
SecurityIpGroupAttributestringNo

The attribute of the 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.

test

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

61B05CCF-EBAB-4BF3-BA67-D77256A721E2

Examples

Sample success responses

JSONformat

{
  "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