文档

QueryDatasetInfo - 查询数据集详情V2

更新时间:

查询指定数据集的信息。

调试

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

授权信息

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

请求参数

名称类型必填描述示例值
DatasetIdstring

数据集唯一 ID。

a201c85c-******

返回参数

名称类型描述示例值
object
Successboolean

接口是否成功返回,取值范围:

  • true:成功
  • false:失败
true
RequestIdstring

请求 ID。

a4d1a221d-41za1-****
Resultobject

数据集信息。

GmtModifystring

数据集最新修改时间。

1629450382000
DsNamestring

数据源名称。

odps
DsIdstring

数据源唯一 ID。

a201c85c-******
OwnerNamestring

数据集所有者名称。

大娃
WorkspaceNamestring

数据集所处空间名称。

测试空间
OwnerIdstring

数据集所有者在 Quick BI 的用户 ID。

b8494aab26124*****
DatasetNamestring

数据集名称。

opds_40
RowLevelboolean

行级权限是否开启,取值范围:

  • true:开启
  • false:关闭
false
WorkspaceIdstring

数据集所属工作空间唯一 ID。

420abef4-a79b-4289-b12****
CustimzeSqlboolean

是否自定义 SQL,取值范围:

  • true:是
  • false:否
false
GmtCreatestring

数据集创建时间。

1629450382000
DsTypestring

数据源类型,取值范围:

  • mysql
  • odps
  • oracle
  • …等 Quick BI 支持的数据源类型
odps
DatasetIdstring

数据集唯一 ID。

a201c85c-******
OpenOfflineAccelerationboolean

是否开启抽取加速,取值范围:

  • true:开启
  • false:关闭
false
CubeTableListobject []

数据集所使用的表的列表。

TableNamestring

表名称。

viewdasb8494aab2612473cb74992159fe****
DatasourceIdstring

数据源 ID。

dfefd7f4-fc6e-42c9-b4******
DsTypestring

数据源类型,取值范围:

  • mysql
  • odps
  • oracle
  • ...等 Quick BI 支持的数据源类型
maxcompute
UniqueIdstring

表唯一 ID。

7a62530b36
FactTableboolean

是否是数据源表,取值范围:

  • true:数据源表
  • false:自定义表
true
Captionstring

表的显示名称。

odps_40
Customsqlboolean

是否是自定义 SQL 表,取值范围:

  • true:自定义 SQL 表
  • false:非自定义 SQL 表
false
Sqlstring

当为自定义 SQL 表时,此为具体 SQL。

select * from ****
DimensionListobject []

数据集中所有维度的列表。

DataTypestring

数据类型; 取值范围:

  • string:字符
  • number:数字
  • datetime:时间
string
Expressionstring

计算维度的表达式;仅对计算维度有效。

example_expression
FactColumnstring

实际物理字段。

city
DimensionTypestring

维度类型,取值范围:

  • standard_dimension:普通维度
  • calculate_dimension:计算维度
  • group_dimension:分组维度
group_dimension
Granularitystring

粒度。

example_granularity
RefUidstring

分组度量,引用的字段唯一 ID。当且仅当该度量为分组度量时非 NULL。

308f7****
Captionstring

维度显示名称。

city
Uidstring

唯一 ID。

a69774***
TableUniqueIdstring

所属表的唯一 ID,对应 CubeTypeList 的 UniqueId。

7a62530***
MeasureListobject []

数据集所有度量的列表。

DataTypestring

数据类型; 取值范围:

  • string:字符
  • number:数字
  • datetime:时间
string
Expressionstring

计算度量的表达式;仅对计算度量有效。

example_expression
MeasureTypestring

度量类型,取值范围:

  • standard_measure:普通度量
  • calculate_measure:计算度量
calculate_measure
FactColumnstring

实际物理字段。

profit_amt
Captionstring

度量显示名称。

profit_amt
TableUniqueIdstring

所属表的唯一 ID,对应 CubeTypeList 的 UniqueId。

7a62530b36
Uidstring

度量唯一 ID。

88b680****
Directoryobject

数据集所属目录信息。

PathIdstring

目录 ID 的路径,例如:aa/bb/cc/dd。

88b680****
PathNamestring

目录 ID 的路径名称,例如:一层目录/二层目录。

测试目录
Namestring

目录名称。

测试目录
Idstring

目录 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***"
      }
    ],
    "MeasureList": [
      {
        "DataType": "string",
        "Expression": "example_expression",
        "MeasureType": "calculate_measure",
        "FactColumn": "profit_amt",
        "Caption": "profit_amt",
        "TableUniqueId": "7a62530b36",
        "Uid": "88b680****"
      }
    ],
    "Directory": {
      "PathId": "88b680****",
      "PathName": "测试目录",
      "Name": "测试目录",
      "Id": "a3eecab7-618d-4f9f-*****"
    }
  }
}

错误码

HTTP status code错误码错误信息描述
400Cube.Not.ExistThe Cube does not exist.数据集不存在。
400Not.WorkspaceCube.ErrorYou can only use the %s dataset of the current workspace.只能使用当前工作空间的数据集。
400UserInfo.ErrorThe personal information is invalid.个人信息不合法。
400Decryption.ErrorAn error occurred while decoding.解密失败。
400Datasource.UserPermission.ErrorYou do not have datasource authorization.当前用户没有数据源权限。
400CubeMeta.ToXml.ErrorAn error occurred while converting the data object to the XML format.数据对象转换XML失败。
400Datasource.NotFound.ErrorThe specified data source does not exist: %s.数据源不存在:%s。
400Cube.ParseToXml.ErrorAn error occurred while parsing a dataset object to XML format.将多维数据集对象解析为XML错误。
400DatasourceId.IsNull.ErrorYou must select a data source before selecting the table.必须选择数据源之后再选择表。
400Internal.System.ErrorAn internal system error occurred.系统内部异常。
400Instance.ExpiredYour instance has expired.您的购买实例已经过期。
400Instance.Not.ExistThe specified instance does not exist.暂未匹配到您的购买实例。
400Invalid.OrganizationThe specified organizational unit does not exist.该组织不存在。
400User.Not.In.OrganizationThe specified user is not in the organizational unit.该用户不在组织中。
400Invalid.ParameterAn error occurred while verifying parameters.参数验证失败。
400Invalid.Parameter.ErrorThe parameter is invalid:%s.无效参数%s。
400Invalid.Param.ErrorThe parameter is invalid.无效参数。
400Invalid.User.AdminYou are not an administrator of this organization.没有权限,您不是组织管理员。
400System.Param.EmptyYou must specify the %s parameter.参数%s不能为空。
400Access.ForbiddenYour instance version or access key is not allowed to call the API operation, only professional version supports calling.您的实例版本或者 AccessKey不允许调用该 API,仅专业版支持调用。
400ApiUser.Not.ExistsThe specified user does not exist.用户不存在。
400User.Not.WorkspaceAdminOnly administrators of the group workspace can perform this operation.没有权限,您不是该群空间的管理员。
400Application.Object.NotExistThe object you are operating does not exist or has been deleted.操作组件不存在或已被删除。
400Not.ApiCall.AuthUserYou are not an administrator or API call auth user of this organization.非组织管理员或API调用授权用户。

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

变更历史

变更时间变更内容概要操作
2024-05-22OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更
  • 本页导读 (0)