調用QueryDatasetInfo介面查詢資料集資訊-智能商務分析 Quick BI-阿里雲

查詢指定資料集的資訊。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

quickbi-public:QueryDatasetInfo

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
DatasetId	string	是	資料集唯一 ID。	a201c85c-******

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	a4d1a221d-41za1-****
Result	object	資料集資訊。
CubeTableList	array<object>	資料集所使用的表的列表。
	object
Caption	string	表的顯示名稱。	odps_40
Customsql	boolean	是否是自訂 SQL 表，取值範圍： true：自訂 SQL 表 false：非自訂 SQL 表	false
DatasourceId	string	資料來源 ID。	dfefd7f4-fc6e-42c9-b4******
DsType	string	資料來源類型，取值範圍： mysql odps oracle ...等 Quick BI 支援的資料來源類型	maxcompute
FactTable	boolean	是否是資料來源表，取值範圍： true：資料來源表 false：自訂表格	true
Sql	string	當為自訂 SQL 表時，此為具體 SQL。	select * from ****
TableName	string	表名稱。	viewdasb8494aab2612473cb74992159fe****
UniqueId	string	表唯一 ID。	7a62530b36
CustimzeSql	boolean	是否自訂 SQL，取值範圍： true：是 false：否	false
DatasetId	string	資料集唯一 ID。	a201c85c-******
DatasetName	string	資料集名稱。	opds_40
DimensionList	array<object>	資料集中所有維度列表。
	object	資料集中所有維度列表。
Caption	string	維度顯示名稱。	city
DataType	string	資料類型；取值範圍： string：字元 number：數字 datetime：時間	string
DimensionType	string	維度類型，取值範圍： standard_dimension：普通維度 calculate_dimension：計算維度 group_dimension：分組維度	group_dimension
Expression	string	計算維度運算式；僅對計算維度有效。	example_expression
FactColumn	string	實際物理欄位。	city
FieldDescription	string	欄位描述資訊。	hhhh
Granularity	string	粒度。	example_granularity
RefUid	string	分組度量，引用的欄位唯一 ID。若且唯若該度量為分組度量時非 NULL。	308f7****
TableUniqueId	string	所屬表的唯一 ID，對應 CubeTypeList 的 UniqueId。	7a62530***
Uid	string	唯一 ID。	a69774***
ExpressionV2	string	平鋪的計算維度運算式。	example_expression
Directory	object	資料集所屬目錄資訊。
Id	string	目錄 ID。	a3eecab7-618d-4f9f-*****
Name	string	目錄名稱。	測試目錄
PathId	string	目錄 ID 的路徑，例如：aa/bb/cc/dd。	88b680****
PathName	string	目錄 ID 的路徑名稱，例如：一層目錄/二層目錄。	測試目錄
DsId	string	資料來源唯一 ID。	a201c85c-******
DsName	string	資料來源名稱。	odps
DsType	string	資料來源類型，取值範圍： mysql odps oracle …等 Quick BI 支援的資料來源類型	odps
GmtCreate	string	資料集建立時間。	1629450382000
GmtModify	string	資料集最新修改時間。	1629450382000
MeasureList	array<object>	資料集所有度量的列表。
	object
Caption	string	度量顯示名稱。	profit_amt
DataType	string	資料類型；取值範圍： string：字元 number：數字 datetime：時間	string
Expression	string	計算度量的運算式；僅對計算度量有效。	example_expression
FactColumn	string	實際物理欄位。	profit_amt
FieldDescription	string	欄位描述資訊。	asadsda
MeasureType	string	度量類型，取值範圍： standard_measure：普通度量 calculate_measure：計算度量	calculate_measure
TableUniqueId	string	所屬表的唯一 ID，對應 CubeTypeList 的 UniqueId。	7a62530b36
Uid	string	度量唯一 ID。	88b680****
ExpressionV2	string	平鋪的計算度量的運算式。	example_expression
OpenOfflineAcceleration	boolean	是否開啟抽取加速，取值範圍： true：開啟 false：關閉	false
OwnerId	string	資料集所有者在 Quick BI 的使用者識別碼。	b8494aab26124*****
OwnerName	string	資料集所有者名稱。	大娃
RowLevel	boolean	行級許可權是否開啟，取值範圍： true：開啟 false：關閉	false
WorkspaceId	string	資料集所屬工作空間唯一 ID。	420abef4-a79b-4289-b12****
WorkspaceName	string	資料集所處空間名稱。	測試空間
Success	boolean	介面是否成功返回，取值範圍： true：成功 false：失敗	true

樣本

正常返回樣本

JSON格式

{
  "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": "測試目錄",
      "PathId": "88b680****",
      "PathName": "測試目錄"
    },
    "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": "大娃",
    "RowLevel": false,
    "WorkspaceId": "420abef4-a79b-4289-b12****",
    "WorkspaceName": "測試空間"
  },
  "Success": true
}

錯誤碼

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	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.	將Cube對象解析為XML錯誤。
400	DatasourceId.IsNull.Error	You must select a data source before selecting the table.	必須選擇資料來源之後再選擇表。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。