All Products
Search

This Product

    Cloud Firewall:DescribeUserIPSWhitelist

    Document Center

    Cloud Firewall:DescribeUserIPSWhitelist

    Last Updated:Jan 07, 2026

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

    Operation description

    QPS limits

    The queries per second (QPS) limit for this API is 10 calls per second for each user. If you exceed this limit, API calls are throttled, which can impact your business. We recommend that you call this 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

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    04F788A5-6A47-5EA9-AC30-CA4DB98AD520
    Whitelists

    array<object>

    The list of IPv4 whitelists for the IPS on the Internet Border.

    object

    An IPv4 whitelist for the IPS on the Internet Border.

    Direction

    integer

    The direction of IPv4 traffic on the Internet Border.

    Valid values:

    • 1 :

      inbound

    • 2 :

      outbound

    1
    WhiteType

    integer

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

    Valid values:

    • 1 :

      destination IP address whitelist

    • 2 :

      source IP address whitelist

    1
    ListValue

    string

    The value of the IPv4 whitelist on the Internet Border.

    • If the whitelist type is custom input: the name of the address book.

    • If the whitelist type is address book reference: an IPv4 address.

    10.10.200.4/32,10.10.200.25/32
    ListType

    integer

    The type of address in the IPv4 whitelist for the Internet.

    Valid values:

    • 0 :

      not set

    • 1 :

      custom input

    • 2 :

      address book reference

    1
    WhiteListValue

    array

    The list of IPv4 whitelists for the Internet.

    string

    An IPv4 whitelist for the Internet.

    • If the whitelist type is custom input: the name of the address book.

    • If the whitelist type is address book reference: an IPv4 address.

    10.10.200.4/32
    Ipv6Whitelists

    array<object>

    The list of IPv6 whitelists for the IPS on the Internet Border.

    object

    An IPv6 whitelist for the IPS on the Internet Border.

    Direction

    integer

    The direction of IPv6 traffic on the Internet Border.

    Valid values:

    • 1 :

      inbound

    • 2 :

      outbound

    1
    WhiteType

    integer

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

    Valid values:

    • 1 :

      destination IP address whitelist

    • 2 :

      source IP address whitelist

    2
    ListValue

    string

    The value of the IPv6 whitelist on the Internet Border.

    • If the whitelist type is custom input: the name of the address book.

    • If the whitelist type is address book reference: an IPv6 address.

    2408:400a:81a:7900:a77d:ea36:fcbf:de40/128
    ListType

    integer

    The type of address in the IPv6 whitelist for the Internet.

    Valid values:

    • 0 :

      not set

    • 1 :

      custom input

    • 2 :

      address book reference

    0
    WhiteListValue

    array

    The list of IPv6 whitelists for the Internet.

    string

    An IPv6 whitelist for the Internet.

    • If the whitelist type is custom input: the name of the address book.

    • If the whitelist type is address book reference: an IPv6 address.

    2408:400a:81a:7900:a77d:ea36:fcbf:de40/128

    Examples

    Success response

    JSON format

    {
  "RequestId": "04F788A5-6A47-5EA9-AC30-CA4DB98AD520",
  "Whitelists": [
    {
      "Direction": 1,
      "WhiteType": 1,
      "ListValue": "10.10.200.4/32,10.10.200.25/32",
      "ListType": 1,
      "WhiteListValue": [
        "10.10.200.4/32"
      ]
    }
  ],
  "Ipv6Whitelists": [
    {
      "Direction": 1,
      "WhiteType": 2,
      "ListValue": "2408:400a:81a:7900:a77d:ea36:fcbf:de40/128",
      "ListType": 0,
      "WhiteListValue": [
        "2408:400a:81a:7900:a77d:ea36:fcbf:de40/128\n"
      ]
    }
  ]
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 ErrorParametersUid invalid aliUid. Invalid Aliuid.
    400 ErrorDBSelect An error occurred while querying database. An error occurred while querying database.
    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.