Call ListCubeDataLevelPermissionConfig to obtain data level permissions for a dataset - Quick BI - Alibaba Cloud - Quick BI

Operation description

Note

This operation supports only the new row-column permission model. If you are still using the old row-column permission model, migrate to the new model before you call this operation. To migrate, choose Organizations> Security Configurations> Upgrade Row-Level Permissions, and then click Upgrade.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

quickbi-public:ListCubeDataLevelPermissionConfig

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
CubeId	string	Yes	The dataset ID.	7c7223ae-****-3c744528014b
RuleType	string	Yes	The type of dataset permission to query. Valid values: ROW_LEVEL: row-level permissions COLUMN_LEVEL: column-level permissions	ROW_LEVEL

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	D8749D65-E80A-433C-AF1B-CE9C180FF3B4
Result	string	{ "isOpen": 1, "extraConfigModel": { // Additional configuration information "ruleType": "ROW_LEVEL", // The row-level permission type. "missHitPolicy": "NONE", // The hit rule policy: NONE has no permissions, and ALL has permissions. "cubeId": "7c7223 ae-31d1-4d2f-b11f-3c744528014b" // The ID of the dataset. }, "ruleType": "ROW_LEVEL", // Row-column permission type "ruleModels": [ { "ruleUsersModel": { // The target population. "userGroups": [ "0d5fb19b- -1248 fc27ca51", // The ID of the user group. "4aa3f089--85f0-0e8ac7c2dee9" ], "users": [ "HuangJia 2e3fa822", // The ID of the user. "433484358" ] }, "ruleContentModel": { "ruleContentType": "ROW_FIELD", // The row-column permission type. "ruleContentJson": "{"conditionNode":{"caption": " Period ","isMeasure":false,"pathId":"7d3b073bc6","relationOperator":"not-null","name":"7d3b073bc6","value":{"value":[""}UM]," ENueType "} // The JSON string of the row-column permission rule. "ruleOriginConfigJson": "{"operator":"and","operands":[{"labelName": " Period ","isValid":true,"uniqueId":"5","fieldId":"7d3b073bc6","error":false,"fieldType":"string",": default "" value":{"conditionOp":"not-null","conditionValue":""},"valueType":"ENUM"}}],"isRelation":true}" }, // The fixed-format JSON string required by the frontend "isOpen": 1, // The status of the row-column permission configuration. 1. On. 0. Off. "hitTakeEffect": 1, // Specifies whether the rule takes effect after a column-level permission is hit. 1 takes effect and 0 takes effect. "ruleName": "Test row-level permission_Do not delete", // The name of the row-column permission rule. "ruleLevelType": "ROW_LEVEL", // The row-column permission type. "ruleId": "a5bb24 da-772f-45e8-a43c-a891683e14da", // The ID of the row-column permission rule. "cubeId": "7c7223 ae-31d1-4d2f-b11f-3c744528014b", // The ID of the dataset. "ruleTargetScope": "OTHERS" rule takes effect: ALL owner and OTHERS designated owner. } ], "cubeId": "7c7223 ae-31d1-4d2f-b11f-3c744528014b" // The ID of the dataset. }	行列权限列表的JSON串，详情见描述。
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true

Examples

Success response

JSON format

{
  "RequestId": "D8749D65-E80A-433C-AF1B-CE9C180FF3B4",
  "Result": "行列权限列表的JSON串，详情见描述。",
  "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.