QueryDatasetInfo接口用于获取指定数据集的信息。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 QueryDatasetInfo

要执行的操作。取值：QueryDatasetInfo。

DatasetId String 是 a201c85c-******

数据集唯一ID。

返回数据

名称 类型 示例值 描述
Success Boolean true

接口是否成功返回，取值范围：

  • true：成功
  • false：失败
RequestId String a4d1a221d-41za1-****

请求ID。
Result Object

数据集信息。
GmtModify String 1629450382000

数据集最新修改时间。
DsName String odps

数据源名称。
DsId String a201c85c-******

数据源唯一ID。
OwnerName String 大娃

所有者名称。
WorkspaceName String 自定义模板

空间名称。
OwnerId String b8494aab26124*****

所有者唯一ID。
DatasetName String opds_40

数据集名称。
RowLevel Boolean false

行级权限是否开启，取值范围：

  • true：开启
  • false：关闭
WorkspaceId String 420abef4-a79b-4289-b12****

空间唯一ID。
CustimzeSql Boolean false

是否自定义SQL，取值范围：

  • true：是
  • false：否
GmtCreate String 1629450382000

数据集创建时间。
DsType String odps

数据源类型，取值范围：

  • mysql
  • odps
  • oracle
  • …等QuickBI支持的数据源类型
DatasetId String a201c85c-******

数据集唯一ID。
CubeTableList Array of CubeTableList

数据集所使用的表的列表。
TableName String viewdasb8494aab2612473cb74992159fe****

表名称。
DatasourceId String dfefd7f4-fc6e-42c9-b4******

数据源ID。
DsType String maxcompute

数据源类型，取值范围：

  • mysql
  • odps
  • oracle
  • ...等QuickBI支持的数据源类型
UniqueId String 7a62530b36

表唯一ID。
FactTable Boolean true

是否是数据源表，取值范围：

  • true：数据源表
  • false：自定义表
Caption String odps_40

表的显示名称。
Customsql Boolean false

是否是自定义SQL表，取值范围：

  • true：自定义SQL表
  • false：非自定义SQL表
Sql String select * from ****

当为自定义SQL表时，此为具体SQL。
DimensionList Array of DimensionList

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

数据类型； 取值范围：

  • string：字符
  • number：数字
  • datetime：时间
Expression String example_expression

计算维度的表达式；仅对计算维度有效。
FactColumn String city

实际物理字段。
DimensionType String group_dimension

维度类型，取值范围：

  • standard_dimension：普通维度
  • calculate_dimension：计算维度
  • group_dimension：分组维度
Granularity String example_granularity

粒度。
RefUid String 308f7****

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

维度显示名称。
Uid String a69774***

唯一ID。
TableUniqueId String 7a62530b36

所属表的唯一ID，对应CubeTypeList的UniqueId。
MeasureList Array of MeasureList

数据集所有度量的列表。
DataType String string

数据类型； 取值范围：

  • string：字符
  • number：数字
  • datetime：时间
Expression String example_expression

计算度量的表达式；仅对计算度量有效。
MeasureType String calculate_measure

度量类型，取值范围：

  • standard_measure：普通度量
  • calculate_measure：计算度量
FactColumn String profit_amt

实际物理字段。
Caption String profit_amt

度量显示名称。
TableUniqueId String 7a62530b36

所属表的唯一ID，对应CubeTypeList的UniqueId。
Uid String 88b680****

度量唯一ID。
Directory Object

数据集所属目录信息。
PathId String a3eecab7-618d-4f9f-*****

目录ID的路径，例如：aa/bb/cc/dd。
PathName String 测试_勿删

目录ID的路径名称，例如：一层目录/二层目录。
Name String 测试_勿删

目录名称。
Id String a3eecab7-618d-4f9f-*****

目录ID。

示例

请求示例

http(s)://quickbi-public.aliyuncs.com/?Action=QueryDatasetInfo
&DatasetId=a201c85c-******
&公共请求参数

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<QueryDatasetInfoResponse>
    <Success>true</Success>
    <RequestId>a4d1a221d-41za1-****</RequestId>
    <Result>
        <GmtModify>1629450382000</GmtModify>
        <DsName>odps</DsName>
        <DsId>a201c85c-******</DsId>
        <OwnerName>大娃</OwnerName>
        <WorkspaceName>自定义模板</WorkspaceName>
        <OwnerId>b8494aab26124*****</OwnerId>
        <DatasetName>opds_40</DatasetName>
        <RowLevel>false</RowLevel>
        <WorkspaceId>420abef4-a79b-4289-b12****</WorkspaceId>
        <CustimzeSql>false</CustimzeSql>
        <GmtCreate>1629450382000</GmtCreate>
        <DsType>odps</DsType>
        <DatasetId>a201c85c-******</DatasetId>
        <CubeTableList>
            <TableName>viewdasb8494aab2612473cb74992159fe****</TableName>
            <DatasourceId>dfefd7f4-fc6e-42c9-b4******</DatasourceId>
            <DsType>maxcompute</DsType>
            <UniqueId>7a62530b36</UniqueId>
            <FactTable>true</FactTable>
            <Caption>odps_40</Caption>
            <Customsql>false</Customsql>
            <Sql>select * from ****</Sql>
        </CubeTableList>
        <DimensionList>
            <DataType>string</DataType>
            <Expression>example_expression</Expression>
            <FactColumn>city</FactColumn>
            <DimensionType>group_dimension</DimensionType>
            <Granularity>example_granularity</Granularity>
            <RefUid>308f7****</RefUid>
            <Caption>city</Caption>
            <Uid>a69774***</Uid>
            <TableUniqueId>7a62530b36</TableUniqueId>
        </DimensionList>
        <MeasureList>
            <DataType>string</DataType>
            <Expression>example_expression</Expression>
            <MeasureType>calculate_measure</MeasureType>
            <FactColumn>profit_amt</FactColumn>
            <Caption>profit_amt</Caption>
            <TableUniqueId>7a62530b36</TableUniqueId>
            <Uid>88b680****</Uid>
        </MeasureList>
        <Directory>
            <PathId>a3eecab7-618d-4f9f-*****</PathId>
            <PathName>测试_勿删</PathName>
            <Name>测试_勿删</Name>
            <Id>a3eecab7-618d-4f9f-*****</Id>
        </Directory>
    </Result>
</QueryDatasetInfoResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/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-******",
    "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" : "7a62530b36"
    } ],
    "MeasureList" : [ {
      "DataType" : "string",
      "Expression" : "example_expression",
      "MeasureType" : "calculate_measure",
      "FactColumn" : "profit_amt",
      "Caption" : "profit_amt",
      "TableUniqueId" : "7a62530b36",
      "Uid" : "88b680****"
    } ],
    "Directory" : {
      "PathId" : "a3eecab7-618d-4f9f-*****",
      "PathName" : "测试_勿删",
      "Name" : "测试_勿删",
      "Id" : "a3eecab7-618d-4f9f-*****"
    }
  }
}

错误码

HttpCode 错误码 错误信息 描述
500 Instance.Expired Your instance has expired. 您的购买实例已经过期。
500 Instance.Not.Exist The specified instance does not exist. 暂未匹配到您的购买实例。
500 Access.Forbidden Access forbidden. Your instance version or access key is not allowed to call the API operation. 访问被禁止，您的实例版本或者 AccessKey不允许调用该 API。
500 Invalid.Organization The specified organizational unit does not exist. 该组织不存在。
500 User.Not.In.Organization The specified user is not in the organizational unit. 该用户不在组织中。
500 Cube.Not.Exist The Cube does not exist. 数据集不存在。
500 Not.WorkspaceCube.Error You can only use the %s dataset of the current workspace. 只能使用当前工作空间的数据集。
500 UserInfo.Error The personal information is invalid. 个人信息不合法。
500 Decryption.Error An error occurred while decoding. 解密失败。
500 Invalid.Param.Error The parameter is invalid. 无效参数。
500 Datasource.UserPermission.Error You do not have datasource authorization. 当前用户没有数据源权限。
500 System.Param.empty This error code has been discarded. 错误码已废弃。
500 CubeMeta.ToXml.Error An error occurred while converting the data object to the XML format. 数据对象转换XML失败。
500 Datasource.NotFound.Error The specified data source does not exist: %s. 数据源不存在：%s。
500 Cube.ParseToXml.Error An error occurred while parsing a dataset object to XML format. 将多维数据集对象解析为XML错误。
500 DatasourceId.IsNull.Error You must select a data source before selecting the table. 必须选择数据源之后再选择表。
500 Invalid.Parameter.Error The parameter is invalid:%s. 无效参数%s。
500 Internal.System.Error An internal system error occurred. 系统内部异常。

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