ListCubeDataLevelPermissionConfig接口用于获取指定数据集的行列权限配置列表。

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 ListCubeDataLevelPermissionConfig

要执行的操作。取值：ListCubeDataLevelPermissionConfig。

CubeId String 是 7c7223ae-****-3c744528014b

数据集ID。
RuleType String 是 ROW_LEVEL

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

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

返回数据

名称 类型 示例值 描述
RequestId String D8749D65-E80A-433C-AF1B-CE9C180FF3B4

请求ID。
Result String 行列权限列表的JSON串，详情见描述。

{

"isOpen": 1,

"extraConfigModel": { // 额外配置信息

"ruleType": "ROW_LEVEL", //行级权限类型

"missHitPolicy": "NONE", //命中规则策略：NONE无权限，ALL有权限

"cubeId": "7c7223ae-31d1-4d2f-b11f-3c744528014b" //数据集ID

},

"ruleType": "ROW_LEVEL", //行列权限类型

"ruleModels": { "ruleUsersModel": { // 针对的人群 "userGroups": [ "0d5fb19b-****-1248fc27ca51", // 用户组ID "4aa3f089-****-85f0-0e8ac7c2dee9" ,

"users": "HuangJia***2e3fa822", // 用户的UserID "4334***84358"

},

"ruleContentModel": {

"ruleContentType": "ROW_FIELD", //行列权限类型

"ruleContentJson": "{\"conditionNode\":{\"caption\":\"周期\",\"isMeasure\":false,\"pathId\":\"7d3b073bc6\",\"relationOperator\":\"not-null\",\"name\":\"7d3b073bc6\",\"value\":{\"value\":\"\",\"valueType\":\"ENUM\"}}}", //行列权限规则的JSON串

"ruleOriginConfigJson": "{\"operator\":\"and\",\"operands\":{\"labelName\":\"周期\",\"isValid\":true,\"uniqueId\":\"5\",\"fieldId\":\"7d3b073bc6\",\"error\":false,\"fieldType\":\"string\",\"defaultValue\":{\"selectType\":\"condition\",\"value\":{\"conditionOp\":\"not-null\",\"conditionValue\":\"\"},\"valueType\":\"ENUM\"}},\"isRelation\":true}"

}, //前端需求的固定格式JSON串

"isOpen": 1, // 行列权限配置的开关状态 1.开启 0.关闭

"hitTakeEffect": 1, // 针对列级权限，命中后规则是否生效 1生效、0不生效。

"ruleName": "测试行级权限_勿删", // 行列权限规则的名称

"ruleLevelType": "ROW_LEVEL", //行列权限类型

"ruleId": "a5bb24da-772f-45e8-a43c-a891683e14da", // 行列权限规则的ID

"cubeId": "7c7223ae-31d1-4d2f-b11f-3c744528014b", // 数据集ID

"ruleTargetScope": "OTHERS" 规则生效范围：ALL所有人、OTHERS指定人

}

],

"cubeId": "7c7223ae-31d1-4d2f-b11f-3c744528014b" // 数据集ID

}
Success Boolean true

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

  • true：请求成功
  • false：请求失败

示例

请求示例

http(s)://quickbi-public.aliyuncs.com/?Action=ListCubeDataLevelPermissionConfig
&CubeId=7c7223ae-****-3c744528014b
&RuleType=ROW_LEVEL
&公共请求参数

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<ListCubeDataLevelPermissionConfigResponse>
    <RequestId>D8749D65-E80A-433C-AF1B-CE9C180FF3B4</RequestId>
    <Result>行列权限列表的JSON串，详情见描述。</Result>
    <Success>true</Success>
</ListCubeDataLevelPermissionConfigResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "D8749D65-E80A-433C-AF1B-CE9C180FF3B4",
  "Result" : "行列权限列表的JSON串，详情见描述。",
  "Success" : true
}

错误码

HttpCode 错误码 错误信息 描述
500 Instance.Expired Your instance has expired. 您的购买实例已经过期。
500 Instance.Not.Exist The specified instance does not exist. 暂未匹配到您的购买实例。
500 Access.Forbidden Access forbidden. Your instance version or access key is not allowed to call the API operation. 访问被禁止，您的实例版本或者 AccessKey不允许调用该 API。
500 Invalid.Organization The specified organizational unit does not exist. 该组织不存在。
500 User.Not.In.Organization The specified user is not in the organizational unit. 该用户不在组织中。
500 Invalid.Parameter.Error The parameter is invalid:%s. 无效参数%s。
500 Cube.Not.Exist The Cube does not exist. 数据集不存在。
500 CubePermission.Columnlevel.VersionError You are not allowed to use the new dataLevelPermission API. 没有权限使用新版行列权限。
500 RowLevelPermission.SwitchClose.Error The row level permission switch must be on. 对应的行级权限开关必须打开。
500 RowLevelPermission.Rule.NotExsist The row level permission rule does not exist: %s. 行级权限规则不存在：%s。
500 RowLevelPermission.Rule.NotBelongToCube The row level permission rule does not belong to the current cube. 行级权限规则不属于当前数据集。

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