All Products
Search
Document Center

Quick BI:IpWhiteListConfig

Last Updated:Jul 02, 2026

Configures the IP address whitelist for data security.

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 syntax

POST  HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

IpWhiteList

string

No

Required for increase and delete operations. The IP whitelist. Separate multiple IP addresses with commas.

60.205.254.120

Operation

string

Yes

The operation type. Valid values:

  • ADD: incrementally adds entries.

  • DELETE: deletes entries.

  • QUERY: queries entries.

add

Response elements

Element

Type

Description

Example

object

RequestId

string

The request ID.

D787E1A3-A93C-424A-B626-C2B05DF8D885

Result

object

The IP address whitelist.

IpWhiteList

array

The IP address whitelist array.

string

IP

*.*.*.*

Success

boolean

Indicates whether the request was successful.

true

Examples

Success response

JSON format

{
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "IpWhiteList": [
      "*.*.*.*"
    ]
  },
  "Success": true
}

Error codes

HTTP status code

Error code

Error message

Description

297 Invalid.Parameter The length of the parameter must not exceed 1000. Parameter length exceeds maximum limit
400 Internal.System.Error An internal system error occurred. An internal system error occurred.
400 Invalid.Parameter.Error The parameter is invalid:%s. invalid parameter: ${0}.
400 Parameter.Error The input parameter is invalid. input parameter error.
400 LoginIp.Format.Error Invalid IP address format: %s. Only public IPv4 addresses or CIDR format are supported. Invalid IP address format:%s, only public IPv4 addresses or CIDR format are supported
400 LoginIp.Private.Error Does not support private IP addresses: %s. Private IP address not supported:%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.