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.
Indicates whether the table is a custom SQL table. Valid values: \\* true: custom SQL table \\* false: non-custom SQL table
Debugging
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 Resourcesis 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:QueryDatasetInfo | get | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| DatasetId | string | Yes | Queries information about a specified dataset. | a201c85c-****** |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "a4d1a221d-41za1-****",
"Result": {
"CubeTableList": [
{
"Caption": "odps_40",
"Customsql": false,
"DatasourceId": "dfefd7f4-fc6e-42c9-b4******",
"DsType": "maxcompute",
"FactTable": true,
"Sql": "select * from ****",
"TableName": "viewdasb8494aab2612473cb74992159fe****",
"UniqueId": "7a62530b36"
}
],
"CustimzeSql": false,
"DatasetId": "a201c85c-******",
"DatasetName": "opds_40",
"DimensionList": [
{
"Caption": "city",
"DataType": "string",
"DimensionType": "group_dimension",
"Expression": "example_expression",
"FactColumn": "city",
"FieldDescription": "hhhh",
"Granularity": "example_granularity",
"RefUid": "308f7****",
"TableUniqueId": "7a62530***",
"Uid": "a69774***",
"ExpressionV2": "example_expression"
}
],
"Directory": {
"Id": "a3eecab7-618d-4f9f-*****",
"Name": "The name of the directory.\n",
"PathId": "88b680****",
"PathName": "The path name of the directory ID, for example, one-level directory /two-level directory.\n"
},
"DsId": "a201c85c-******",
"DsName": "odps",
"DsType": "odps",
"GmtCreate": 1629450382000,
"GmtModify": 1629450382000,
"MeasureList": [
{
"Caption": "profit_amt",
"DataType": "string",
"Expression": "example_expression",
"FactColumn": "profit_amt",
"FieldDescription": "asadsda",
"MeasureType": "calculate_measure",
"TableUniqueId": "7a62530b36",
"Uid": "88b680****",
"ExpressionV2": "example_expression"
}
],
"OpenOfflineAcceleration": false,
"OwnerId": "b8494aab26124*****",
"OwnerName": "The name of the dataset owner.\n",
"RowLevel": false,
"WorkspaceId": "420abef4-a79b-4289-b12****",
"WorkspaceName": "The name of the workspace in which the dataset resides.\n"
},
"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 | Decryption.Error | An error occurred while decoding. | An error occurred while decoding. |
| 400 | Datasource.UserPermission.Error | You do not have datasource authorization. | You do not have datasource authorization. |
| 400 | CubeMeta.ToXml.Error | An error occurred while converting the data object to the XML format. | An error occurred while converting the data object to the XML format. |
| 400 | Datasource.NotFound.Error | The specified data source does not exist: %s. | The specified data source does not exist: %s. |
| 400 | Cube.ParseToXml.Error | An error occurred while parsing a dataset object to XML format. | An error occurred while parsing a dataset object to XML format. |
| 400 | DatasourceId.IsNull.Error | You must select a data source before selecting the table. | You must select a data source before selecting the table. |
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 |