IpWhiteListConfig - Quick BI - Alibaba Cloud Documentation Center

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

quickbi-public:IpWhiteListConfig

update

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
IpWhiteList	string	No	Required for add 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 whitelist.
IpWhiteList	array	The IP 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.