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

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

調試

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

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱	類型	必填	描述	樣本值
PageNumber	integer	否	頁碼數。最小值 1，最大值 100	1
PageSize	integer	否	每頁顯示的資料量，預設為 10 條，最大 100 條。	10
ResourceManagerResourceGroupId	string	否	資源群組 ID。	rg-acfmzbn7pt****
Tags	array<object>	否	工作空間綁定的標籤資訊列表。
	object	否	標籤資訊。
Key	string	否	標籤鍵。	key
Value	string	否	標籤值。	value

返回參數

名稱	類型	描述	樣本值
	object	返回結果。
RequestId	string	請求 ID。	20658801****
PageResult	object	查詢結果。
PageNumber	integer	當前的頁碼。	1
PageSize	integer	每頁顯示的條數，預設為 10 條，最大 100 條。	10
TotalCount	integer	返回結果的總條數。	68
ProjectList	array<object>	DataWorks 工作空間的結果清單。
	array<object>	工作空間詳情。
ProjectStatusCode	string	工作空間的狀態代碼。 AVAILABLE：狀態取值為 0，表示正常。 DELETED：狀態取值為 1，表示已刪除。 INITIALIZING：狀態取值為 2，表示初始化。 INIT_FAILED：狀態取值為 3，表示初始化失敗。 FORBIDDEN：狀態取值為 4，表示手動禁用。 DELETING：狀態取值為 5，表示刪除中。 DEL_FAILED：狀態取值為 6，表示刪除失敗。 FROZEN：狀態取值為 7，表示欠費凍結。 UPDATING：狀態取值為 8，表示專案更新（為專案添加並初始化計算引擎）中。 UPDATE_FAILED：狀態取值為 9，表示專案更新（為專案添加並初始化計算引擎）失敗。	AVAILABLE
ProjectStatus	integer	工作空間的狀態。 AVAILABLE：狀態取值為 0，表示正常。 DELETED：狀態取值為 1，表示已刪除。 INITIALIZING：狀態取值為 2，表示初始化。 INIT_FAILED：狀態取值為 3，表示初始化失敗。 FORBIDDEN：狀態取值為 4，表示手動禁用。 DELETING：狀態取值為 5，表示刪除中。 DEL_FAILED：狀態取值為 6，表示刪除失敗。 FROZEN：狀態取值為 7，表示欠費凍結。 UPDATING：狀態取值為 8，表示專案更新（為專案添加並初始化計算引擎）中。 UPDATE_FAILED：狀態取值為 9，表示專案更新（為專案添加並初始化計算引擎）失敗。	0
ProjectName	string	工作空間的顯示名稱。	test_project
ProjectIdentifier	string	工作空間的名稱。	test_project
ProjectId	integer	工作空間的 ID。	466230
ProjectDescription	string	工作空間的詳細描述資訊。	test_describe
ProjectOwnerBaseId	string	工作空間所有者的使用者識別碼。	13969939245****
ResourceManagerResourceGroupId	string	資源群組 ID。	rg-acfmzbn7****
Tags	array<object>	工作空間綁定的標籤列表。
	object	標籤資訊。
Key	string	標籤鍵。	key
Value	string	標籤值。	value
DisableDevelopment	boolean	是否禁用開發角色，取值如下： false：開啟開發角色。 true：禁用開發角色。	true
UseProxyOdpsAccount	boolean	訪問 MaxCompute 引擎是否使用代理帳號。 false：不使用。 true：使用。	true
TablePrivacyMode	integer	MaxCompute 表的可見度許可權，取值如下： 0：租戶內使用者不可見 MaxCompute 表。 1：租戶內使用者可見 MaxCompute 表。	1
IsDefault	integer	是否為預設工作空間，取值如下： 1：是。 0：否。	1

樣本

正常返回樣本

JSON格式

{
  "RequestId": "20658801****",
  "PageResult": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 68,
    "ProjectList": [
      {
        "ProjectStatusCode": "AVAILABLE",
        "ProjectStatus": 0,
        "ProjectName": "test_project",
        "ProjectIdentifier": "test_project",
        "ProjectId": 466230,
        "ProjectDescription": "test_describe",
        "ProjectOwnerBaseId": "13969939245****",
        "ResourceManagerResourceGroupId": "rg-acfmzbn7****",
        "Tags": [
          {
            "Key": "key",
            "Value": "value"
          }
        ],
        "DisableDevelopment": true,
        "UseProxyOdpsAccount": true,
        "TablePrivacyMode": 1,
        "IsDefault": 1
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	Invalid.Tenant.ConnectionNotExists	The connection does not exist.	資料來源不存在。
400	Invalid.Tenant.ProjectNotExists	The project does not exist.	專案不存在。
400	Invalid.Tenant.UserAlreadyInProject	The user already exists in the project.	待添加使用者已經存在於工作空間中。
400	Invalid.Tenant.UserNotInProject	The user is not in the project.	使用者不在專案中。
403	Invalid.Tenant.UserIsNotProjectOwnerOrAdmin	The user is not a project administrator or owner.	使用者不是專案負責人或者專案系統管理員。
403	Invalid.Tenant.UserNotInTenant	The user is not in tenant.	使用者不在租戶中。

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

變更歷史

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