文档

ListDataLevelPermissionWhiteList - 获取数据集行列权限白名单列表

更新时间:

根据行列权限种类,获取数据集行列权限的白名单列表。

接口说明

说明 :当前接口仅支持 Quick BI 新版行列权限模型。若您仍在使用老的行列权限,请先一键迁移至新的行列权限模型后再调用该接口。一键迁移至新的行列权限模型的操作步骤:在组织管理-->安全配置-->行列权限升级新版中,单击一键升级,升级至新版行级权限。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
CubeIdstring

数据集 ID。

3d5db23c-e4f2-49dd-a883-92285b48e14a
RuleTypestring

白名单所属的行列权限类型:

  • ROW_LEVEL:行级权限
  • COLUMN_LEVEL:列级权限
ROW_LEVEL

返回参数

名称类型描述示例值
object
Successboolean

是否请求成功。取值范围:

  • true:请求成功
  • false:请求失败
true
RequestIdstring

请求 ID。

D8749D65-E80A-433C-AF1B-CE9C180FF3B4
Resultobject

指定行级权限类型的白名单列表。

CubeIdstring

数据集 ID。

7c7223ae-****-3c744528014b
RuleTypestring

数据集行列权限类型。取值范围:

  • ROW_LEVEL:行级权限
  • COLUMN_LEVEL:列级权限
ROW_LEVEL
UsersModelobject

白名单信息。

UserGroupsarray
string

用户组 ID。

0d5fb19b-***-1248fc27ca51
Usersarray
string

Quick BI 用户的 UserID。

4334***358

示例

正常返回示例

JSON格式

{
  "Success": true,
  "RequestId": "D8749D65-E80A-433C-AF1B-CE9C180FF3B4",
  "Result": {
    "CubeId": "7c7223ae-****-3c744528014b",
    "RuleType": "ROW_LEVEL",
    "UsersModel": {
      "UserGroups": [
        "0d5fb19b-***-1248fc27ca51"
      ],
      "Users": [
        "4334***358"
      ]
    }
  }
}

错误码

HTTP status code错误码错误信息描述
400Cube.Not.ExistThe Cube does not exist.数据集不存在。
400CubePermission.Columnlevel.VersionErrorYou are not allowed to use the new dataLevelPermission API.没有权限使用新版行列权限。
400RowLevelPermission.SwitchClose.ErrorThe row level permission switch must be on.对应的行级权限开关必须打开。
400RowLevelPermission.Rule.NotExsistThe row level permission rule does not exist: %s.行级权限规则不存在:%s。
400RowLevelPermission.Rule.NotBelongToCubeThe row level permission rule does not belong to the current cube.行级权限规则不属于当前数据集。
400Cube.NotBelongTo.CurrentOrganizationThe cube does not belong to the current organization %s.数据集模型不属于当前组织。
400Instance.ExpiredYour instance has expired.您的购买实例已经过期。
400Instance.Not.ExistThe specified instance does not exist.暂未匹配到您的购买实例。
400Invalid.OrganizationThe specified organizational unit does not exist.该组织不存在。
400User.Not.In.OrganizationThe specified user is not in the organizational unit.该用户不在组织中。
400Invalid.ParameterAn error occurred while verifying parameters.参数验证失败。
400Invalid.Parameter.ErrorThe parameter is invalid:%s.无效参数%s。
400Invalid.Param.ErrorThe parameter is invalid.无效参数。
400Invalid.User.AdminYou are not an administrator of this organization.没有权限,您不是组织管理员。
400System.Param.EmptyYou must specify the %s parameter.参数%s不能为空。
400Access.ForbiddenYour instance version or access key is not allowed to call the API operation, only professional version supports calling.您的实例版本或者 AccessKey不允许调用该 API,仅专业版支持调用。
400UserInfo.ErrorThe personal information is invalid.个人信息不合法。
400ApiUser.Not.ExistsThe specified user does not exist.用户不存在。
400User.Not.WorkspaceAdminOnly administrators of the group workspace can perform this operation.没有权限,您不是该群空间的管理员。
400Application.Object.NotExistThe object you are operating does not exist or has been deleted.操作组件不存在或已被删除。
400Not.ApiCall.AuthUserYou are not an administrator or API call auth user of this organization.非组织管理员或API调用授权用户。

访问错误中心查看更多错误码。

  • 本页导读 (0)
文档反馈