調用QueryDatasetList API擷取工作空間資料集列表-智能商務分析 Quick BI-阿里雲

查詢指定工作空間的資料集列表，按照建立時間倒序排列。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

quickbi-public:QueryDatasetList

list

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
WorkspaceId	string	是	工作空間 ID。	95296e95-ca89-4c7d-8af9-dedf0ad0****
DirectoryId	string	否	指定目錄 ID。若該欄位不為空白，則擷取該目錄下的所有資料集。	schemaad8aad00-9c55-4984-a767-b4e0ec60****
WithChildren	boolean	否	是否遞迴包好子目錄下的資料集。取值範圍： true：返回 directoryId 目錄下所有遞迴子目錄下的資料集。 false：僅返回 directoryId 指定目錄下的資料集，不包含子目錄下的。	true
Keyword	string	否	資料集名稱搜尋索引鍵。	test
PageNum	integer	否	資料集列表的當前頁碼：起始值：1 預設值：1	1
PageSize	integer	否	分頁查詢時的每頁行數：預設值：10 最大值：1000	10

返回參數

名稱	類型	描述	樣本值
	object
Success	boolean	是否請求成功。取值範圍： true：請求成功 false：請求失敗	true
RequestId	string	請求 ID。	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	object	返回資料集列表的分頁結果，資料集列表的詳細資料存放在返回參數 Data 中。
Data	array<object>	資料集列表詳情。
	array<object>
CreateTime	string	建立時間。	2020-11-02 10:36:05
DataSource	object	資料集所屬資料來源資訊
DsId	string	資料來源 ID。	261b252d-c3c3-498a-a0a7-5d1ec6cd****
DsName	string	資料來源名稱。	test
DsType	string	資料來源類型。	mysql
DatasetId	string	資料集 ID。	5820f58c-c734-4d8a-baf1-7979af4f****
DatasetName	string	資料集名稱。	company_sales_record_copy12
Description	string	資料集備忘。	test
Directory	object	資料集所處目錄資訊
Id	string	目錄 ID。	schemaad8aad00-9c55-4984-a767-b4e0ec60****
Name	string	目錄名稱。	test
PathId	string	所處目錄路徑的 ID。	schemaad8aad00-9c55-4984-a767-b4e0ec60****
PathName	string	所處目錄路徑的名稱。	test
ModifyTime	string	修改時間。	2020-11-02 10:36:05
OpenOfflineAcceleration	boolean	是否開啟抽取加速。取值範圍： true：開啟 false：關閉	true
OwnerId	string	資料集擁有者在 Quick BI 的 UserID。	136516262323****
OwnerName	string	資料集擁有者的暱稱。	test
RowLevel	boolean	是否開啟行級許可權。取值範圍： true：開啟 false：關閉	true
WorkspaceId	string	工作空間 ID。	95296e95-ca89-4c7d-8af9-dedf0ad06adf
WorkspaceName	string	工作空間名稱。	test
PageNum	integer	頁碼。	1
PageSize	integer	請求介面時設定的每頁行數。	10
TotalNum	integer	總行數。	1
TotalPages	integer	總頁數。	1

樣本

正常返回樣本

JSON格式

{
  "Success": true,
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "Data": [
      {
        "CreateTime": "2020-11-02 10:36:05",
        "DataSource": {
          "DsId": "261b252d-c3c3-498a-a0a7-5d1ec6cd****",
          "DsName": "test",
          "DsType": "mysql"
        },
        "DatasetId": "5820f58c-c734-4d8a-baf1-7979af4f****",
        "DatasetName": "company_sales_record_copy12",
        "Description": "test",
        "Directory": {
          "Id": "schemaad8aad00-9c55-4984-a767-b4e0ec60****",
          "Name": "test",
          "PathId": "schemaad8aad00-9c55-4984-a767-b4e0ec60****",
          "PathName": "test"
        },
        "ModifyTime": "2020-11-02 10:36:05",
        "OpenOfflineAcceleration": true,
        "OwnerId": "136516262323****",
        "OwnerName": "test",
        "RowLevel": true,
        "WorkspaceId": "95296e95-ca89-4c7d-8af9-dedf0ad06adf",
        "WorkspaceName": "test"
      }
    ],
    "PageNum": 1,
    "PageSize": 10,
    "TotalNum": 1,
    "TotalPages": 1
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	Workspace.NotIn.Organization	The workspace is not owned by the organization.	空間不在組織內。
400	CubeSchema.Not.Exist	The cube schema does not exist.	資料集模型不存在。

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

變更歷史

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