Sets the whitelist for the specified row-level permissions.
Operation description
Note
: You can only Quick BI the new row-column permission model. If you are still using the old row-column permission model, migrate to the new row-column permission model before you call this operation. To migrate row-level permissions to the new row-level permission model, perform the following steps: Choose Organizations> Security Configurations> Upgrade Row-Level Permissions. On the Upgrade Row-Level Permissions page, click Upgrade.
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:SetDataLevelPermissionWhiteList | update | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| WhiteListModel | string | Yes | { "ruleType": "ROW_LEVEL", // The row-level permission type. "usersModel": { "userGroups": [ "0d5fb19b- -1248 fc27ca51", // The ID of the user group. "3d2c23d4--f6390f325c2d" ], "users": [ "4334 358", // Quick BI the UserID of the user. "Huang3fa822" ] }, "cubeId": "7c7223ae-31d1-4d2f-b11f-3c744528014b" } | {"ruleType":"ROW_LEVEL","usersModel":{"userGroups":["26edcb76-****-bdbab78267cb","187e6dd5-1611-4cf7-a034-1a93bd5fecf9"],"users":["4334***358","Huang***3fa822"]},"cubeId":"7c7223ae-****44528014b"} |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "D8749D65-E80A-433C-AF1B-CE9C180FF3B4",
"Result": true,
"Success": true
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | Instance.Expired | Your instance has expired. | Your instance has expired. |
| 400 | Instance.Not.Exist | The specified instance does not exist. | The specified instance does not exist. |
| 400 | Access.Forbidden | Access forbidden. Your instance version or access key is not allowed to call the API operation. | - |
| 400 | Invalid.Organization | The specified organizational unit does not exist. | The specified organizational unit does not exist. |
| 400 | User.Not.In.Organization | The specified user is not in the organizational unit. | The specified user is not in the organizational unit. |
| 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 | Invalid.Parameter.Error | The parameter is invalid:%s. | invalid parameter: ${0}. |
| 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. |
| 400 | Invalid.Parameter | An error occurred while verifying parameters. | An error occurred while verifying parameters. |
| 400 | Invalid.Param.Error | The parameter is invalid. | The parameter is invalid. |
| 400 | Invalid.User.Admin | You are not an administrator of this organization. | Only organization administrators can perform this operation. |
| 400 | System.Param.Empty | You must specify the %s parameter. | You must specify the %s parameter. |
| 400 | UserInfo.Error | The personal information is invalid. | The personal information is invalid. |
| 400 | ApiUser.Not.Exists | The specified user does not exist. | The specified user does not exist. |
For a list of error codes, visit the Service error codes.