QueryDatasetInfo - Quick BI - Alibaba Cloud Documentation Center

Indicates whether the table is a custom SQL table. Valid values: \* true: custom SQL table \* false: non-custom SQL table

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

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
DatasetId	string	Yes	Queries information about a specified dataset.	a201c85c-******

Response parameters

Parameter	Type	Description	Example
	object
Success	boolean	The unique ID of the dataset.	true
RequestId	string	Whether the operation is successfully returned. Valid values: true: The call is successful. false: The call fails.	a4d1a221d-41za1-****
Result	object	The ID of the request.
GmtModify	string	The information about the dataset.	1629450382000
DsName	string	The time when the dataset was last modified.	odps
DsId	string	The name of the data source.	a201c85c-******
OwnerName	string	The unique ID of the data source.	The name of the dataset owner.
WorkspaceName	string	Big Baby	The name of the workspace in which the dataset resides.
OwnerId	string	Test Space	b8494aab26124*****
DatasetName	string	The user ID of the dataset owner in the Quick BI.	opds_40
RowLevel	boolean	The name of the training dataset.	false
WorkspaceId	string	Whether row-level permissions are enabled. Valid values: true: The VIP Netty channel is enabled. false: The VIP Netty channel is disabled.	420abef4-a79b-4289-b12****
CustimzeSql	boolean	The unique ID of the workspace to which the dataset belongs.	false
GmtCreate	string	Indicates whether to customize SQL statements. Valid values: true false	1629450382000
DsType	string	The point in time when the training dataset was created.	odps
DatasetId	string	The type of the data source. Valid values: mysql odps oracle ... Data source types supported by Quick BI such as	a201c85c-******
CubeTableList	array<object>	The unique ID of the dataset.
CubeTableList	object
TableName	string	The list of tables used by the dataset.	viewdasb8494aab2612473cb74992159fe****
DatasourceId	string	The name of the table.	dfefd7f4-fc6e-42c9-b4******
DsType	string	The ID of the data source.	maxcompute
UniqueId	string	The type of the data source. Valid values: mysql odps oracle ... and other data source types supported by Quick BI	7a62530b36
FactTable	boolean	The unique ID of the table.	true
Caption	string	Indicates whether the data source table is valid. Valid values: true: data source table false: custom table	odps_40
Customsql	boolean	The display name of the table.	false
Sql	string	Indicates whether the table is a custom SQL table. Valid values: true: custom SQL table false: non-custom SQL table	select * from ****
DimensionList	array<object>	If it is a custom SQL table, this is the specific SQL.
DimensionList	object
DataType	string	A list of all dimensions in the dataset.	string
Expression	string	Data type; value: string: character number: a number datetime: time	example_expression
FactColumn	string	Expression for a calculated dimension; valid only for calculated dimensions.	city
DimensionType	string	The actual physical field.	group_dimension
Granularity	string	The type of the dimension. Valid values: standard_dimension: General Dimension calculate_dimension: calculating dimensions group_dimension: grouping dimensions	example_granularity
RefUid	string	The granularity.	308f7****
Caption	string	The unique ID of the field that is referenced by the group measure. Non-NULL if and only if the metric is a grouping metric.	city
Uid	string	The display name of the dimension.	a69774***
TableUniqueId	string	The ARN.	7a62530***
MeasureList	array<object>	The unique ID of the table to which the table belongs, which corresponds to the UniqueId of the CubeTypeList.
MeasureList	object
DataType	string	A list of all measures for the dataset.	string
Expression	string	Data type; value: string: character number: a number datetime: time	example_expression
MeasureType	string	An expression that calculates a measure; valid only for calculated measures.	calculate_measure
FactColumn	string	The type of the measure. Valid values: standard_measure: General Metrics calculate_measure: Calculating Measures	profit_amt
Caption	string	The actual physical field.	profit_amt
TableUniqueId	string	The display name of the metric.	7a62530b36
Uid	string	The unique ID of the table to which the table belongs, which corresponds to the UniqueId of the CubeTypeList.	88b680****
Directory	object	The unique ID of the metric.
PathId	string	The information about the directory to which the dataset belongs.	88b680****
PathName	string	The path of the directory ID, for example, aa/bb/cc/dd.	The path name of the directory ID, for example, one-level directory /two-level directory.
Name	string	Test directory	The name of the directory.
Id	string	Test directory	a3eecab7-618d-4f9f-*****

Examples

Sample success responses

JSONformat

{
  "Success": true,
  "RequestId": "a4d1a221d-41za1-****",
  "Result": {
    "GmtModify": "1629450382000",
    "DsName": "odps",
    "DsId": "a201c85c-******",
    "OwnerName": "The name of the dataset owner.\n",
    "WorkspaceName": "The name of the workspace in which the dataset resides.\n",
    "OwnerId": "b8494aab26124*****",
    "DatasetName": "opds_40",
    "RowLevel": false,
    "WorkspaceId": "420abef4-a79b-4289-b12****",
    "CustimzeSql": false,
    "GmtCreate": "1629450382000",
    "DsType": "odps",
    "DatasetId": "a201c85c-******",
    "CubeTableList": [
      {
        "TableName": "viewdasb8494aab2612473cb74992159fe****",
        "DatasourceId": "dfefd7f4-fc6e-42c9-b4******",
        "DsType": "maxcompute",
        "UniqueId": "7a62530b36",
        "FactTable": true,
        "Caption": "odps_40",
        "Customsql": false,
        "Sql": "select * from ****"
      }
    ],
    "DimensionList": [
      {
        "DataType": "string",
        "Expression": "example_expression",
        "FactColumn": "city",
        "DimensionType": "group_dimension",
        "Granularity": "example_granularity",
        "RefUid": "308f7****",
        "Caption": "city",
        "Uid": "a69774***",
        "TableUniqueId": "7a62530***"
      }
    ],
    "MeasureList": [
      {
        "DataType": "string",
        "Expression": "example_expression",
        "MeasureType": "calculate_measure",
        "FactColumn": "profit_amt",
        "Caption": "profit_amt",
        "TableUniqueId": "7a62530b36",
        "Uid": "88b680****"
      }
    ],
    "Directory": {
      "PathId": "88b680****",
      "PathName": "The path name of the directory ID, for example, one-level directory /two-level directory.\n",
      "Name": "The name of the directory.\n",
      "Id": "a3eecab7-618d-4f9f-*****"
    }
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400			-
400			-
400			-
400			-
400			-
400			-
400			-
400			-
400			-
400			-
400			-
400			-
400			-
400			-
400			-
400			-
400			-
400			-
400			-
400			-
400	ApiUser.Not.Exists	The specified user does not exist.	The specified user does not exist.

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

Change history

Change time	Summary of changes	Operation
2024-05-22	The Error code has changed. The response structure of the API has changed	View Change Details