设置指定行级权限的白名单列表。
接口说明
:当前接口仅支持 Quick BI 新版行列权限模型。若您仍在使用老的行列权限,请先一键迁移至新的行列权限模型后再调用该接口。一键迁移至新的行列权限模型的操作步骤:在组织管理-->安全配置-->行列权限升级新版中,单击一键升级,升级至新版行级权限。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
quickbi-public:SetDataLevelPermissionWhiteList |
update |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| WhiteListModel |
string |
是 |
{ "ruleType": "ROW_LEVEL", // 行级权限类型 "usersModel": { "userGroups": [ "0d5fb19b--1248fc27ca51", // 用户组 ID "3d2c23d4--f6390f325c2d" ], "users": [ "4334358", // Quick BI 用户的 UserID "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"} |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求 ID。 |
D8749D65-E80A-433C-AF1B-CE9C180FF3B4 |
| Result |
boolean |
接口执行结果。取值范围:
|
true |
| Success |
boolean |
是否请求成功。取值范围:
|
true |
示例
正常返回示例
JSON格式
{
"RequestId": "D8749D65-E80A-433C-AF1B-CE9C180FF3B4",
"Result": true,
"Success": true
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 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. | 行级权限规则不存在:%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. | 数据集模型不属于当前组织。 |
| 400 | Usergroup.NotBelongTo.CurrentOrganization | The usergroup %s does not belong to the current organization. | 用户组%s不属于当前组织。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。