All Products
Search

This Product

    ApsaraDB RDS:ModifyInstanceIpWhitelist

    Document Center

    ApsaraDB RDS:ModifyInstanceIpWhitelist

    Last Updated:Mar 05, 2026

    Modifies the IP address whitelist of an RDS Supabase instance.

    Operation description

    Supported database engine

    RDS PostgreSQL

    References

    RDS Supabase

    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.
    OperationAccess levelResource typeCondition keyAssociated operation
    rdsai:ModifyInstanceIpWhitelistupdate
    *All Resources
    *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringNo

    The operation that you want to perform. Set the value to ModifyInstanceIpWhitelist.

    		cn-beijing
    InstanceNamestringNo

    The region ID.

    		ra-supabase-8moov5lxba****
    IpWhiteliststringNo

    The ID of the RDS Supabase instance.

    		10.23.XXX.XXX
    ModifyModestringNo

    The IP address whitelist. Before you modify the IP address whitelist, call the DescribeInstanceIpWhitelist operation to query the existing IP address whitelist of the instance.

    Configuration rules

    • You can configure IP addresses (such as 10.23.XXX.XXX) or CIDR blocks (such as 10.23.XXX.XXX/24).
    • Separate multiple IP addresses or CIDR blocks with commas (,) and do not add spaces preceding or following the commas.
    • You can configure up to 1,000 IP addresses and CIDR blocks in total for each instance. If you want to add a large number of IP addresses, we recommend that you merge the IP addresses into CIDR blocks, such as 10.23.XXX.XXX/24.
    		Cover
    ClientTokenstringNo

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

    • Cover (default): Uses the IP addresses and CIDR blocks that are specified in the IpWhitelist parameter to overwrite the existing ones in the current whitelist.
    • Append: Appends the IP addresses and CIDR blocks that are specified in the IpWhitelist parameter to the current whitelist.
    • Delete: Deletes the IP addresses and CIDR blocks that are specified in the IpWhitelist parameter from the current whitelist. You must retain at least one IP address or CIDR block.
    		ETnLKlblzczshOTUbOCz****
    GroupNamestringNo

    The idempotency token. The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests.

    		default

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    RequestIdstring

    The request ID.

    		87249A6F-xxx-804C-E1E0AD1FAD90
    InstanceNamestring

    The ID of the RDS Supabase instance.

    		ra-supabase-8moov5lxba****

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "87249A6F-xxx-804C-E1E0AD1FAD90",
  "InstanceName": "ra-supabase-8moov5lxba****\n"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400IncorrectInstanceStateCurrent instance status does not support this operation.The operation is not supported in the current instance state.
    400InvalidGroupNameSpecified group name is not valid.Invalid group name
    400InvalidParameterThe provided parameter is invalid.Invalid parameter.
    400MasterInstanceNotExistMaster instance does not exist.The primary instance does not exist.
    403InsufficientResourceCapacityThere is not enough host resource inventory.Insufficient resources

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