All Products
Search

This Product

    AnalyticDB:ModifySecurityIps

    Document Center

    AnalyticDB:ModifySecurityIps

    Last Updated:Aug 28, 2026

    Modifies the IP address whitelist of an AnalyticDB for PostgreSQL instance.

    Operation description

    By default, AnalyticDB for PostgreSQL denies access from all external IP addresses. Before you use an instance, you must add your client IP address or CIDR block to the IP address whitelist of the instance.

    Limits

    You can call this operation up to 1,000 times per second per account. Exceeding this limit triggers throttling, which may affect your business.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    gpdb:ModifySecurityIps

    update

    *DBInstance

    acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    ResourceGroupId

    string

    No

    The ID of the resource group to which the instance belongs. For more information about how to obtain the ID of a resource group, see View basic information of a resource group.

    null
    ModifyMode

    string

    No

    The modification method. Valid values:

    • Cover: overwrites the IP address whitelist.

    • Append: appends IP addresses to the whitelist.

    • Delete: deletes the whitelist.

    0
    DBInstanceId

    string

    Yes

    The ID of the instance.

    Note

    You can call the DescribeDBInstances operation to query the instance IDs of all AnalyticDB for PostgreSQL instances in a specific region.

    gp-bp12ga6v69h86****
    SecurityIPList

    string

    Yes

    The IP addresses in the whitelist, separated by commas (,). You can add up to 1,000 IP addresses. Each address must use one of the following formats:

    • 0.0.0.0/0

    • 10.23.12.24, a standard IP address.

    • 10.23.12.24/24, a CIDR block. The value /24 indicates a 24-bit prefix length. You can replace 24 with a value in the range of 1 to 32.

    10.10.**.**
    DBInstanceIPArrayName

    string

    No

    The name of the whitelist. If not specified, IP addresses are added to the default whitelist.

    Note

    You can create up to 50 whitelists for an instance.

    default
    DBInstanceIPArrayAttribute

    string

    No

    The attribute of the IP address whitelist. By default, this parameter is empty. A whitelist with the hidden attribute is not displayed in the console.

    hidden

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The ID of the request.

    871C698F-B43D-4D1D-ACD6-DF56B0F89978

    Examples

    Success response

    JSON format

    {
  "RequestId": "871C698F-B43D-4D1D-ACD6-DF56B0F89978"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.