All Products
Search

This Product

    ApsaraDB RDS:MigrateSecurityIPMode

    Document Center

    ApsaraDB RDS:MigrateSecurityIPMode

    Last Updated:Aug 28, 2026

    Changes the whitelist mode of an instance from the standard whitelist mode to the enhanced whitelist mode.

    Operation description

    Supported database engines

    • MySQL
    • PostgreSQL

    References

    Note Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.

    Debugging

    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:
      • For mandatory resource types, indicate with a prefix of * .
      • 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.
    Operation Access level Resource type Condition key Associated operation
    rds:MigrateSecurityIPMode update
    *DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    • rds:ResourceTag
    		 none

    Request parameters

    Parameter Type Required Description Example
    DBInstanceId string Yes

    The instance ID. You can call the DescribeDBInstances operation to query the instance ID.

    		 rm-uf6wjk5****

    Response parameters

    Parameter Type Description Example
    object

    The response parameters.
    SecurityIPMode string

    The whitelist mode after the change, which is the enhanced whitelist mode.

    Valid values:

    • safety

      :

      enhanced whitelist mode

    		 safety
    DBInstanceId string

    The ID of the instance.

    		 rm-uf6wjk5****
    RequestId string

    The ID of the request.

    		 EF1E53AB-5625-49C7-ADF1-FBD0B6640D19

    Examples

    Sample success responses

    JSONformat

    {
  "SecurityIPMode": "safety",
  "DBInstanceId": "rm-uf6wjk5****",
  "RequestId": "EF1E53AB-5625-49C7-ADF1-FBD0B6640D19"
}

    Error codes

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

    Change history

    Change time Summary of changes Operation
    2022-06-23 API Description Update View Change Details