All Products
Search

This Product

    Cloud Firewall:ModifyUserIPSWhitelist

    Document Center

    Cloud Firewall:ModifyUserIPSWhitelist

    Last Updated:Nov 12, 2025

    Modifies the intrusion prevention system (IPS) whitelist for the Internet Border.

    Operation description

    QPS limit

    This API is limited to 10 queries per second (QPS) for each user. If you exceed this limit, API calls are throttled. This can affect your business. We recommend that you call the API at a reasonable rate.

    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

    No authorization for this operation. If you encounter issues with this operation, contact technical support.

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    SourceIp

    string

    No

    The source IP address of the visitor.

    47.100.XX.XX
    Lang

    string

    No

    The language.

    Valid values:

    • en :

      English

    • zh :

      Chinese (default)

    zh
    Lang

    string

    No

    The language.

    Valid values:

    • en :

      English

    • zh :

      Chinese (default)

    zh
    Direction

    integer

    No

    The traffic direction for the Internet Border.

    Valid values:

    • 1 :

      inbound

    • 2 :

      outbound

    1
    WhiteType

    integer

    No

    The type of source or destination for which the Internet Border whitelist takes effect.

    Valid values:

    • 1 :

      Destination IP address whitelist

    • 2 :

      Source IP address whitelist

    2
    ListType

    integer

    No

    The type of address in the Internet Border whitelist.

    Valid values:

    • 0 :

      Not configured

    • 1 :

      Custom

    • 2 :

      Address book

    2
    ListValue

    string

    No

    The value of the Internet Border whitelist.

    • If ListType is set to Custom: the name of the address book.

    • If ListType is set to Address book: the IPv4 address.

    115.236.36.114/32
    IpVersion

    string

    No

    The IP version.

    Valid values:

    • ipv4 :

      IPv4

    • ipv6 :

      IPv6

    ipv4

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    36E89955-1E5D-5810-970C-74646F378085

    Examples

    Success response

    JSON format

    {
  "RequestId": "36E89955-1E5D-5810-970C-74646F378085"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 ErrorParametersUid invalid aliUid. Invalid Aliuid.
    400 ErrorParameters Parameters error. Parameter error.
    400 ErrorDBSelect An error occurred while querying database. An error occurred while querying database.
    400 ErrorAddressCountExceed The maximum number of addresses is exceeded. The maximum number of address is exceeded.
    400 ErrorDBDelete Internal error: sql delete. Internal error: SQL delete operation
    400 ErrorDBInsert An error occurred while performing an insert operation in the database. An error occurred while performing an insert operation in the database.
    400 ErrorParametersWhitelistIP Invalid whitelistIp. The IP address is invalid.
    400 ErrorRecordLog update operation log error.
    400 ErrorMarshalJSON internal error: marshal json. An error occurred. Try again later.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.