All Products
Search
Document Center

Quick BI:QueryDatasetSwitchInfo

Last Updated:Oct 26, 2026

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

Operation description

Note

: This operation supports only the new row- and column-level permission model of Quick BI. If you are still using the legacy row- and column-level permissions, migrate to the new row- and column-level permission model before you call this operation. To migrate to the new model, go to Organization management > Security settings > Upgrade row- and column-level permissions to new version, and click One-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:QueryDatasetSwitchInfo

get

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

CubeId

string

Yes

The dataset ID.

7c7223ae-****-3c744528014b

Response elements

Element

Type

Description

Example

object

Success

boolean

Indicates whether the request is successful. Valid values:

  • true: The request is successful.

  • false: The request fails.

true

RequestId

string

The request ID.

FAECEFA8-09BB-58AB-BC58-C8ACEFE4D232

Result

object

The details of the row- and column-level permission switches for the dataset.

CubeId

string

The dataset ID.

7c7223ae-****-3c744528014b

IsOpenColumnLevelPermission

integer

The status of the column-level field permission switch. Valid values:

  • 1: Enabled.

  • 0: Disabled.

1

IsOpenRowLevelPermission

integer

The status of the row-level permission switch. Valid values:

  • 1: Enabled.

  • 0: Disabled.

1

Examples

Success response

JSON format

{
  "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.