ListWorkspaces - 擷取工作空間列表 - Platform For AI

擷取某個地區下的工作空間列表。

介面說明

您可以通過 option 參數指定不同的查詢選項，來擷取不同的工作空間相關資訊。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

paiworkspace:ListWorkspaces

list

*全部資源

*

無

請求文法

GET /api/v1/workspaces HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
PageNumber	integer	否	工作空間列表的頁碼。起始值為 1，預設為 1。	1
PageSize	integer	否	分頁查詢時設定的每頁行數，預設為 20。	20
SortBy	string	否	分頁查詢時的排序欄位，預設使用 GmtCreateTime。取值如下。 GmtCreateTime（預設值）：按建立時間。 GmtModifiedTime：按修改時間。	GmtCreateTime
Order	string	否	分頁查詢時，對指定的排序欄位進行升序或降序。取值如下： ASC（預設值）：升序。 DESC ：降序。	ASC
WorkspaceName	string	否	工作空間名稱。	abc
ModuleList	string	否	逗號分割的模組列表。預設值：PAI。	PAI
Status	string	否	工作空間狀態，目前支援如下值： ENABLED：正常。 INITIALIZING：初始化中。 FAILURE：失敗。 DISABLED：手動禁用。 FROZEN：欠費凍結。 UPDATING：專案更新中。	ENABLED
Option	string	否	選項，取值如下： GetWorkspaces（預設值）：擷取工作空間列表，會返回 Workspaces。 GetResourceLimits：擷取資源限制，會返回 ResourceLimits。	GetWorkspaces
Verbose	boolean	否	是否顯示工作空間詳細資料。取值如下： false（預設值）：不顯示。 true：顯示。	true
Fields	string	否	工作空間詳情的返回欄位列表。用於限定返回結果中的工作空間屬性。多個屬性用半形逗號（,）分隔。目前只支援 Id，表示工作空間 ID。	Id
WorkspaceIds	string	否	工作空間 ID 列表。多個工作空間 ID 用半形逗號（,）分隔。	123,234
ResourceGroupId	string	否	資源群組 ID。如何查看資源群組 ID，請參見查看資源群組基本資料。	rg-acfmwp7rky****
UserId	string	否

返回參數

名稱	類型	描述	樣本值
	object	返回結構體。
RequestId	string	請求 ID。	8D7B2E70-F770-505B-A672-09F1D8F2EC1E
Workspaces	array<object>	工作空間詳情列表，當 Option 為 GetWorkspaces 時會返回該列表。
	array<object>	工作空間詳情。
WorkspaceId	string	工作空間 ID。	123
WorkspaceName	string	工作空間名稱。	workspace-example
GmtCreateTime	string	工作空間建立時間。以 ISO8601 為標準，並使用 UTC+0 時間，格式為 yyyy-MM-ddTHH:mm:ss.SSSZ。	2021-01-21T17:12:35.232Z
GmtModifiedTime	string	工作空間修改時間。以 ISO8601 為標準，並使用 UTC+0 時間，格式為 yyyy-MM-ddTHH:mmZ。	2021-01-21T17:12:35.232Z
Description	string	工作空間描述。	workspace description example
Creator	string	建立者使用者識別碼。	122424353535
EnvTypes	array	工作空間包含的環境列表。
	string	工作空間包含的環境，可能值：簡單模式只有生產環境（prod）。標準模式包含開發環境（dev）和生產環境（prod）。	prod
Status	string	工作空間狀態。	ENABLED
AdminNames	array	管理員賬戶名稱列表。
	string	管理員賬戶名稱。	demo_test@***.aliyunid.com
IsDefault	boolean	是否為預設工作空間。	false
ExtraInfos	object	擴充資訊，目前包含 TenantId，代表租戶 ID。	{"TenantId": "4286******98"}
resourceGroupId	string	資源群組 ID。	rg-acfmwp7rky****
TotalCount	integer	符合查詢條件的工作空間總數。	1
ResourceLimits	object	使用者在一個工作空間內允許開通的資源類型和數量限制，當 Option 為 GetResourceLimits 時會返回該列表。目前支援的資源類型包括： MaxCompute_share：MaxCompute 後付費。 MaxCompute_isolate：MaxCompute 預付費。 DLC_share：DLC 後付費。 PAI_isolate：PAI 預付費。 PAI_share：PAI 後付費。 DataWorks_isolate：Dataworks 預付費。 DataWorks_share：Dataworks 後付費。	{ "MaxCompute_share": 1, "MaxCompute_isolate": 1, "DLC_share": 1 }

樣本

正常返回樣本

JSON格式

{
  "RequestId": "8D7B2E70-F770-505B-A672-09F1D8F2EC1E",
  "Workspaces": [
    {
      "WorkspaceId": "123",
      "WorkspaceName": "workspace-example",
      "GmtCreateTime": "2021-01-21T17:12:35.232Z",
      "GmtModifiedTime": "2021-01-21T17:12:35.232Z",
      "Description": "workspace description example",
      "Creator": "122424353535",
      "EnvTypes": [
        "prod"
      ],
      "Status": "ENABLED",
      "AdminNames": [
        "demo_test@***.aliyunid.com"
      ],
      "IsDefault": false,
      "ExtraInfos": {
        "TenantId": "4286******98"
      },
      "resourceGroupId": "rg-acfmwp7rky****"
    }
  ],
  "TotalCount": 1,
  "ResourceLimits": {
    "MaxCompute_share": 1,
    "MaxCompute_isolate": 1,
    "DLC_share": 1
  }
}

錯誤碼

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

變更歷史

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