AddDataLevelPermissionWhiteList - Quick BI - Alibaba Cloud Documentation Center

Operation description

Note

This API operation supports only the new permission model for row-level and column-level permissions in Quick BI. If you are using the old permission model, you must migrate to the new one before you call this operation. To perform a one-click migration, you can go to Organization Management > Security Configuration > Upgrade to New Row-level and Column-level Permissions and click One-click Upgrade.

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:AddDataLevelPermissionWhiteList

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
CubeId	string	Yes	The ID of the dataset.	7c7223ae-***-3c744528014b
RuleType	string	No	The type of permission. Valid values: ROW_LEVEL: row-level permission COLUMN_LEVEL: column-level permission	ROW_LEVEL
OperateType	string	No	The operation to perform. Valid values: ADD: adds users or user groups to the whitelist. DELETE: removes users or user groups from the whitelist.	ADD
TargetType	string	No	The type of object to add to the whitelist. Valid values: 1: user 2: user group	1
TargetIds	string	No	The IDs of the users or user groups to add to the whitelist. If you set TargetType to 1 (user), specify the user IDs. When `TargetType=2` (user group), the value is the user group ID.	43342*435,1553a**41231

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	D8749D65-E80A-433C-AF1B-CE9C180FF3B4
Result	boolean	The execution result of the API operation. Valid values: true: The request was successful. false: The request failed.	true
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true

Examples

Success response

JSON format

{
  "RequestId": "D8749D65-E80A-433C-AF1B-CE9C180FF3B4",
  "Result": true,
  "Success": true
}

Error codes

HTTP status code	Error code	Error message
400	Cube.Not.Exist	The Cube does not exist.
400	CubePermission.Columnlevel.VersionError	You are not allowed to use the new dataLevelPermission API.
400	RowLevelPermission.SwitchClose.Error	The row level permission switch must be on.
400	RowLevelPermission.Rule.NotExsist	The row level permission rule does not exist: %s.
400	RowLevelPermission.Rule.NotBelongToCube	The row level permission rule does not belong to the current cube.
400	Cube.NotBelongTo.CurrentOrganization	The cube does not belong to the current organization %s.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.