Call QueryDatasetDetailInfo to get dataset details - Quick BI - Alibaba Cloud - Quick BI

Operation description

Returns the data source, directory, and dataset model, which includes dimensions, measures, physical fields, custom SQL text, and relationships.

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:QueryDatasetDetailInfo

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DatasetId	string	Yes	The dataset ID.	5820f58c-c734-4d8a-baf1-7979af4f****

Response elements

Element	Type	Description	Example
	object	The response body.
RequestId	string	The request ID.	DC4E1E63-B337-44F8-8C22-6F00DF67E2C3
Result	string	Dataset details in JSON format: { "cube": { "dimensions": [ { "caption": "Customer Name", "dataType": "string", "dimensionType": "standard_dimension", "factColumn": "customer_name", "uid": "N5820f5_customer_name" }, { "caption": "Order ID", "dataType": "string", "dimensionType": "standard_dimension", "factColumn": "order_id", "uid": "N5820f5_order_id" }, ], "measures": [ { "caption": "Order Amount", "dataType": "number", "factColumn": "order_amt", "measureType": "standard_measure", "uid": "N5820f5_order_amt" } ], "table": { "customsql": false, "dsId": "261b252d-c3c3-498a-a0a7-5d1ec6cd**", "tableName": "company_sales_record_copy" } }, "datasetId": "5820f58c-c734-4d8a-baf1-7979af4f", "datasetName": "company_sales_record_copy12", "datasource": { "dsId": "261b252d-c3c3-498a-a0a7-5d1ec6cd", "dsName": "User's Private DB", "dsType": "mysql" }, "directory": { "id": "schemaad8aad00-9c55-4984-a767-b4e0ec60", "name": "My Datasets", "pathId": "schemaad8aad00-9c55-4984-a767-b4e0ec60", "pathName": "My Datasets" }, "ownerId": "13651626232", "ownerName": "Zhang San", "rowLevel": false, "workspaceId": "95296e95-ca89-4c7d-8af9-dedf0ad0**", "workspaceName": "Test Workspace" }	返回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": "DC4E1E63-B337-44F8-8C22-6F00DF67E2C3",
  "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	Not.WorkspaceCube.Error	You can only use the %s dataset of the current workspace.	You can only use the dataset of the current workspace.
400	DatasourceId.IsNull.Error	You must select a data source before selecting the table.	You must select a data source before selecting the table.
400	Datasource.UserPermission.Error	You do not have datasource authorization.	You do not have datasource authorization.
400	CubeDimension.NotExist.Error	The dimension does not exist in the dataset. The dimension ID is %s.	The dimension does not exist in the dataset. The dimension ID:%s.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.