該接口用于查詢用戶所在租戶下的DataWorks工作空間列表。
接口說明
需要購買 DataWorks 基礎版及以上版本才能使用。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| dataworks:ListProjects | list | *全部資源 * |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| Ids | array | 否 | DataWorks 工作空間 ID 列表。 該參數用來查詢符合工作空間 ID 列表的空間詳情。 | |
| long | 否 | 工作空間 ID。您可以登錄 DataWorks 控制臺，進入工作空間管理頁面獲取 ID。 | 123456 | |
| Names | array | 否 | DataWorks 工作空間名稱列表。 該參數用來查詢符合工作空間 Name 列表的空間詳情。 | |
| string | 否 | 工作空間名稱。您可以登錄 DataWorks 控制臺，進入工作空間管理頁面獲取 Name。 | sora_finance | |
| AliyunResourceGroupId | string | 否 | 工作空間所屬阿里云資源組 ID。您可以登錄資源管理控制臺，進入資源組列表頁面獲取 ID。 該參數用來查詢歸屬該資源組的工作空間詳情。 | rg-acfmzbn7pti3zff |
| Status | string | 否 | 空間狀態：
該參數用于查詢符合該狀態的工作空間詳情。 | Available |
| DevEnvironmentEnabled | boolean | 否 | 是否啟用開發環境：
該參數用于查詢符合“啟用/未啟用開發環境”條件的工作空間詳情。 | true |
| DevRoleDisabled | boolean | 否 | 是否禁用開發角色：
該參數用于查詢符合“開啟/禁用開發角色”條件的工作空間詳情。 | false |
| PaiTaskEnabled | boolean | 否 | 是否啟用 PAI 任務調度：
該參數用于查詢符合“開啟/未開啟 PAI 任務調用”條件的工作空間詳情。 | true |
| AliyunResourceTags | array<object> | 否 | 標簽列表。 該參數用于查詢擁有任意標簽鍵值信息的工作空間詳情。 | |
| object | 否 | 標簽詳情。 您可以登錄 資源管理控制臺，進入標簽列表頁面獲取 Key、Value。 | ||
| Key | string | 否 | 標簽鍵。 | batch |
| Value | string | 否 | 標簽值。 | blue |
| PageNumber | integer | 否 | 請求的數據頁數，用于翻頁。 | 1 |
| PageSize | integer | 否 | 每頁顯示的條數，默認為 10 條，最大 100 條。 | 10 |
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "6D24AD9A-652F-59E2-AC1F-05029300F8A4",
"PagingInfo": {
"PageSize": 1,
"PageNumber": 10,
"TotalCount": 100,
"Projects": [
{
"Id": 123456,
"Name": "sora_finance",
"DisplayName": "Sora金融分析",
"Description": "金融分析組項目數據開發",
"Owner": "123532153125",
"AliyunResourceGroupId": "rg-acfmzbn7pti3zfa",
"Status": "Available",
"PaiTaskEnabled": true,
"DevEnvironmentEnabled": true,
"DevRoleDisabled": false,
"AliyunResourceTags": [
{
"Key": "batch",
"Value": "blue"
}
]
}
]
}
}錯誤碼
訪問錯誤中心查看更多錯誤碼。