調用ListProjects查詢工作空間詳情列表-巨量資料開發治理平台 DataWorks-阿里雲

該介面用於查詢使用者所在租戶下的DataWorks工作空間列表。

介面說明

需要購買 DataWorks 基礎版及以上版本才能使用。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dataworks:ListProjects

list

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
Ids	array	否	DataWorks 工作空間 ID 列表。該參數用來查詢符合工作空間 ID 列表的空間詳情。
	integer	否	工作空間 ID。您可以登入 DataWorks 控制台，進入工作空間管理頁面擷取 ID。	123456
Names	array	否	DataWorks 工作空間名稱列表。該參數用來查詢符合工作空間 Name 列表的空間詳情。
	string	否	工作空間名稱。您可以登入 DataWorks 控制台，進入工作空間管理頁面擷取 Name。	sora_finance
AliyunResourceGroupId	string	否	工作空間所屬阿里雲資源群組 ID。您可以登入資源管理主控台，進入資源群組列表頁面擷取 ID。該參數用來查詢歸屬該資源群組的工作空間詳情。	rg-acfmzbn****
Status	string	否	空間狀態： Available：工作空間運行正常 Initializing：初始化工作空間 InitFailed：工作空間初始化失敗 Forbidden：手動禁用工作空間 Deleting：正在刪除工作空間 DeleteFailed：工作空間刪除失敗 Frozen：工作空間欠費凍結 Updating：更新工作空間中 UpdateFailed：更新工作空間失敗該參數用於查詢符合該狀態的工作空間詳情。	Available
DevEnvironmentEnabled	boolean	否	是否啟用開發環境： true 工作空間啟用開發環境，支援開發與生產環境隔離 false 僅使用生產環境該參數用於查詢符合“啟用/未啟用開發環境”條件的工作空間詳情。	true
DevRoleDisabled	boolean	否	是否禁用開發角色： false，開啟開發角色（預設） true，禁用開發角色該參數用於查詢符合“開啟/禁用開發角色”條件的工作空間詳情。	false
PaiTaskEnabled	boolean	否	是否啟用 PAI 任務調度： true 可以在 DataWorks 工作空間建立機器學習（PAI）節點，並按照節點配置進行周期性調度運行。 false 禁用 PAI 任務調度該參數用於查詢符合“開啟/未開啟 PAI 任務調用”條件的工作空間詳情。	true
AliyunResourceTags	array<object>	否	標籤列表。該參數用於查詢擁有任意標籤索引值資訊的工作空間詳情。
	object	否	標籤詳情。您可以登入資源管理主控台，進入標籤列表頁面擷取 Key、Value。
Key	string	否	標籤鍵。	batch
Value	string	否	標籤值。	blue
PageNumber	integer	否	請求的資料頁數，用於翻頁。	1
PageSize	integer	否	每頁顯示的條數，預設為 10 條，最大 100 條。	10

返回參數

名稱	類型	描述	樣本值
	object	返回結果。
RequestId	string	請求的 ID，用於定位日誌，排查問題。	6D24AD9A-652F-59E2-AC1F-05029300F8A4
PagingInfo	object	分頁資訊。
PageSize	integer	每頁顯示的條數。	1
PageNumber	integer	請求的資料頁數，用於翻頁。	10
TotalCount	integer	滿足條件的資料總條數。	100
Projects	array<object>	工作空間列表。
	array<object>	工作空間詳細資料。
Id	integer	工作空間 ID。	123456
Name	string	工作空間名稱。	sora_finance
DisplayName	string	工作空間展示名稱。	Sora financial analysis
Description	string	工作空間描述。	Financial analysis group project data development
Owner	string	工作空間擁有者 UserId，即阿里雲帳號 ID。	123532153125
AliyunResourceGroupId	string	工作空間所屬阿里雲資源群組 ID。	rg-acfmzbn7pti3zfa
Status	string	空間狀態： Available：工作空間運行正常 Initializing：初始化工作空間 InitFailed：工作空間初始化失敗 Forbidden：手動禁用工作空間 Deleting：正在刪除工作空間 DeleteFailed：工作空間刪除失敗 Frozen：工作空間欠費凍結 Updating：更新工作空間中 UpdateFailed：更新工作空間失敗	Available
PaiTaskEnabled	boolean	是否啟用 PAI 任務調度： true 可以在 DataWorks 工作空間建立機器學習（PAI）節點，並按照節點配置進行周期性調度運行。 false 禁用 PAI 任務調度。	true
DevEnvironmentEnabled	boolean	是否啟用開發環境： true 工作空間啟用開發環境，支援開發與生產環境隔離。 false 僅使用生產環境。	true
DevRoleDisabled	boolean	是否禁用開發角色： false，開啟開發角色 true，禁用開發角色	false
AliyunResourceTags	array<object>	標籤組。
	object	標籤詳情。
Key	string	標籤鍵。	batch
Value	string	標籤值。	blue

樣本

正常返回樣本

JSON格式

{
  "RequestId": "6D24AD9A-652F-59E2-AC1F-05029300F8A4",
  "PagingInfo": {
    "PageSize": 1,
    "PageNumber": 10,
    "TotalCount": 100,
    "Projects": [
      {
        "Id": 123456,
        "Name": "sora_finance",
        "DisplayName": "Sora financial analysis\n",
        "Description": "Financial analysis group project data development",
        "Owner": "123532153125",
        "AliyunResourceGroupId": "rg-acfmzbn7pti3zfa",
        "Status": "Available",
        "PaiTaskEnabled": true,
        "DevEnvironmentEnabled": true,
        "DevRoleDisabled": false,
        "AliyunResourceTags": [
          {
            "Key": "batch",
            "Value": "blue"
          }
        ]
      }
    ]
  }
}

錯誤碼

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

變更歷史

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