QueryDatasetSwitchInfo - Quick BI - Alibaba Cloud Documentation Center

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Get the row-level permission switch status for a specified dataset.

Operation description

Note This interface only supports the new row and column permission model of Quick BI. If you are still using the old row and column permissions, please migrate to the new row and column permission model before calling this interface. To migrate to the new row and column permission model, follow these steps: In Organization Management -> Security Configuration -> Upgrade Row and Column Permissions, click One-Click Upgrade to upgrade to the new row-level permissions.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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 Resources is 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:QueryDatasetSwitchInfo	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
CubeId	string	Yes	Dataset ID.	7c7223ae-****-3c744528014b

Response parameters

Parameter	Type	Description	Example
	object
Success	boolean	Indicates whether the request was successful. Possible values: true: The request was successful. false: The request failed.	true
RequestId	string	Request ID.	FAECEFA8-09BB-58AB-BC58-C8ACEFE4D232
Result	object	Details of the dataset's row and column permission switches.
CubeId	string	Dataset ID.	7c7223ae-****-3c744528014b
IsOpenColumnLevelPermission	integer	Status of the column-level field permission switch. Possible values: 1: Enabled 0: Disabled	1
IsOpenRowLevelPermission	integer	Status of the row-level permission switch. 1: Enabled 0: Disabled	1

Examples

Sample success responses

JSONformat

{
  "Success": true,
  "RequestId": "FAECEFA8-09BB-58AB-BC58-C8ACEFE4D232",
  "Result": {
    "CubeId": "7c7223ae-****-3c744528014b",
    "IsOpenColumnLevelPermission": 1,
    "IsOpenRowLevelPermission": 1
  }
}

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	Cube.NotBelongTo.CurrentOrganization	The cube does not belong to the current organization %s.	Cube do not belong to current organization:%s.

For a list of error codes, visit the Service error codes.