This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.
Retrieve the whitelist for dataset row and column permissions based on the type of permission.
Operation description
Note
This API only supports the new row and column permission model of Quick BI. If you are still using the old row and column permissions, please migrate to the new row and column permission model before calling this interface. To migrate to the new row and column permission model, follow these steps: In Organization Management -> Security Configuration -> Upgrade Row and Column Permissions, click One-Click Upgrade to upgrade to the new row-level permissions.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| quickbi-public:ListDataLevelPermissionWhiteList | list | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| CubeId | string | Yes | Dataset ID. | 3d5db23c-e4f2-49dd-a883-92285b48e14a |
| RuleType | string | Yes | Type of row and column permission that the whitelist belongs to:
| ROW_LEVEL |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "D8749D65-E80A-433C-AF1B-CE9C180FF3B4",
"Result": {
"CubeId": "7c7223ae-****-3c744528014b",
"RuleType": "ROW_LEVEL",
"UsersModel": {
"UserGroups": [
"0d5fb19b-***-1248fc27ca51"
],
"Users": [
"4334***358"
]
}
},
"Success": true
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | Cube.Not.Exist | The Cube does not exist. | The Cube does not exist. |
| 400 | CubePermission.Columnlevel.VersionError | You are not allowed to use the new dataLevelPermission API. | You are not allowed to use new dataLevelPermission api. |
| 400 | RowLevelPermission.SwitchClose.Error | The row level permission switch must be on. | Row lever permission switch must be open. |
| 400 | RowLevelPermission.Rule.NotExsist | The row level permission rule does not exist: %s. | 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. | 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. | Cube do not belong to current organization:%s. |
For a list of error codes, visit the Service error codes.