调用QueryDatasetInfo查询数据集简略信息_智能商业分析 Quick BI(Quick BI)-阿里云帮助中心

查询指定数据集的信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
DatasetId	string	是	数据集唯一 ID。	a201c85c-******

返回参数

名称	类型	描述	示例值
	object
Success	boolean	接口是否成功返回，取值范围： true：成功 false：失败	true
RequestId	string	请求 ID。	a4d1a221d-41za1-****
Result	object	数据集信息。
GmtModify	string	数据集最新修改时间。	1629450382000
DsName	string	数据源名称。	odps
DsId	string	数据源唯一 ID。	a201c85c-******
OwnerName	string	数据集所有者名称。	大娃
WorkspaceName	string	数据集所处空间名称。	测试空间
OwnerId	string	数据集所有者在 Quick BI 的用户 ID。	b8494aab26124*****
DatasetName	string	数据集名称。	opds_40
RowLevel	boolean	行级权限是否开启，取值范围： true：开启 false：关闭	false
WorkspaceId	string	数据集所属工作空间唯一 ID。	420abef4-a79b-4289-b12****
CustimzeSql	boolean	是否自定义 SQL，取值范围： true：是 false：否	false
GmtCreate	string	数据集创建时间。	1629450382000
DsType	string	数据源类型，取值范围： mysql odps oracle …等 Quick BI 支持的数据源类型	odps
DatasetId	string	数据集唯一 ID。	a201c85c-******
OpenOfflineAcceleration	boolean	是否开启抽取加速，取值范围： true：开启 false：关闭	false
CubeTableList	array<object>	数据集所使用的表的列表。
CubeTableList	object
TableName	string	表名称。	viewdasb8494aab2612473cb74992159fe****
DatasourceId	string	数据源 ID。	dfefd7f4-fc6e-42c9-b4******
DsType	string	数据源类型，取值范围： mysql odps oracle ...等 Quick BI 支持的数据源类型	maxcompute
UniqueId	string	表唯一 ID。	7a62530b36
FactTable	boolean	是否是数据源表，取值范围： true：数据源表 false：自定义表	true
Caption	string	表的显示名称。	odps_40
Customsql	boolean	是否是自定义 SQL 表，取值范围： true：自定义 SQL 表 false：非自定义 SQL 表	false
Sql	string	当为自定义 SQL 表时，此为具体 SQL。	select * from ****
DimensionList	array<object>	数据集中所有维度的列表。
DimensionList	object
DataType	string	数据类型；取值范围： string：字符 number：数字 datetime：时间	string
Expression	string	计算维度的表达式；仅对计算维度有效。	example_expression
FactColumn	string	实际物理字段。	city
DimensionType	string	维度类型，取值范围： standard_dimension：普通维度 calculate_dimension：计算维度 group_dimension：分组维度	group_dimension
Granularity	string	粒度。	example_granularity
RefUid	string	分组度量，引用的字段唯一 ID。当且仅当该度量为分组度量时非 NULL。	308f7****
Caption	string	维度显示名称。	city
Uid	string	唯一 ID。	a69774***
TableUniqueId	string	所属表的唯一 ID，对应 CubeTypeList 的 UniqueId。	7a62530***
FieldDescription	string	字段描述信息。	hhhh
MeasureList	array<object>	数据集所有度量的列表。
MeasureList	object
DataType	string	数据类型；取值范围： string：字符 number：数字 datetime：时间	string
Expression	string	计算度量的表达式；仅对计算度量有效。	example_expression
MeasureType	string	度量类型，取值范围： standard_measure：普通度量 calculate_measure：计算度量	calculate_measure
FactColumn	string	实际物理字段。	profit_amt
Caption	string	度量显示名称。	profit_amt
TableUniqueId	string	所属表的唯一 ID，对应 CubeTypeList 的 UniqueId。	7a62530b36
Uid	string	度量唯一 ID。	88b680****
FieldDescription	string	字段描述信息。	asadsda
Directory	object	数据集所属目录信息。
PathId	string	目录 ID 的路径，例如：aa/bb/cc/dd。	88b680****
PathName	string	目录 ID 的路径名称，例如：一层目录/二层目录。	测试目录
Name	string	目录名称。	测试目录
Id	string	目录 ID。	a3eecab7-618d-4f9f-*****

示例

正常返回示例

JSON格式

{
  "Success": true,
  "RequestId": "a4d1a221d-41za1-****",
  "Result": {
    "GmtModify": "1629450382000",
    "DsName": "odps",
    "DsId": "a201c85c-******",
    "OwnerName": "大娃",
    "WorkspaceName": "测试空间",
    "OwnerId": "b8494aab26124*****",
    "DatasetName": "opds_40",
    "RowLevel": false,
    "WorkspaceId": "420abef4-a79b-4289-b12****",
    "CustimzeSql": false,
    "GmtCreate": "1629450382000",
    "DsType": "odps",
    "DatasetId": "a201c85c-******",
    "OpenOfflineAcceleration": false,
    "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***",
        "FieldDescription": "hhhh"
      }
    ],
    "MeasureList": [
      {
        "DataType": "string",
        "Expression": "example_expression",
        "MeasureType": "calculate_measure",
        "FactColumn": "profit_amt",
        "Caption": "profit_amt",
        "TableUniqueId": "7a62530b36",
        "Uid": "88b680****",
        "FieldDescription": "asadsda"
      }
    ],
    "Directory": {
      "PathId": "88b680****",
      "PathName": "测试目录",
      "Name": "测试目录",
      "Id": "a3eecab7-618d-4f9f-*****"
    }
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	Cube.Not.Exist	The Cube does not exist.	数据集不存在。
400	Not.WorkspaceCube.Error	You can only use the %s dataset of the current workspace.	只能使用当前工作空间的数据集。
400	UserInfo.Error	The personal information is invalid.	个人信息不合法。
400	Decryption.Error	An error occurred while decoding.	解密失败。
400	Datasource.UserPermission.Error	You do not have datasource authorization.	当前用户没有数据源权限。
400	CubeMeta.ToXml.Error	An error occurred while converting the data object to the XML format.	数据对象转换XML失败。
400	Datasource.NotFound.Error	The specified data source does not exist: %s.	数据源不存在：%s。
400	Cube.ParseToXml.Error	An error occurred while parsing a dataset object to XML format.	将多维数据集对象解析为XML错误。
400	DatasourceId.IsNull.Error	You must select a data source before selecting the table.	必须选择数据源之后再选择表。
400	Internal.System.Error	An internal system error occurred.	系统内部异常。

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-05-22	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情