All Products
Search

This Product

    ApsaraDB for MongoDB:ModifySecurityIps

    Document Center

    ApsaraDB for MongoDB:ModifySecurityIps

    Last Updated:Jan 17, 2023

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

    Authorization information

    The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

    • 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 keyword: refers to the condition keyword defined by the cloud product itself.
    • 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.
    Operate access level Resource type conditional keyword Association operation
    dds:ModifySecurityIps WRITE
    • MongoDB
      acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
      without
    		without

    Request parameters

    Parameter Type Required Description Example
    DBInstanceId string Yes

    The ID of an instance.

    		 dds-bp*****
    SecurityIps string Yes

    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: 10.23.12.24.
    • Classless Inter-Domain Routing (CIDR) blocks, such as 10.23.12.24/24, 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.
    		 127.0.0.1/24,127.0.0.1
    ModifyMode string No

    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.

    		 Append
    SecurityIpGroupName string No

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

    		 allowserver
    SecurityIpGroupAttribute string No

    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.

    		 test

    Response parameters

    Parameter Type Description Example
    object
    RequestId string

    The ID of the request.

    		 61B05CCF-EBAB-4BF3-BA67-D77256A721E2

    Example

    Normal return example

    JSONFormat

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

    Error codes

    Http code Error code Error message
    400 InvalidSecurityIps.MalFormed The specified parameter "SecurityIps" is not valid.
    400 InvalidSecurityIPListLength.Malformed The Security IP address is not in the available range or occupied.
    400 InvalidInstanceIp.Duplicate The quota of security ip exceeds.
    400 InvalidGroupName.Format Sepecified group name is not valid.
    404 InvalidSecurityIPs.NotFound The Specified same security IP does not exist or at least one security IP need.

    For a list of error codes, visit the API error center.