獲取某個地域下的工作空間列表。
接口說明
您可以通過 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 | long | 否 | 工作空間列表的頁碼。起始值為 1,默認為 1。 | 1 |
PageSize | integer | 否 | 分頁查詢時設置的每頁行數,默認為 20。 | 20 |
SortBy | string | 否 | 分頁查詢時的排序字段,默認使用 GmtCreateTime。取值如下。
| GmtCreateTime |
Order | string | 否 | 分頁查詢時,對指定的排序字段進行升序或降序。取值如下:
| ASC |
WorkspaceName | string | 否 | 工作空間名稱。 | abc |
ModuleList | string | 否 | 逗號分割的模塊列表。默認值:PAI。 | PAI |
Status | string | 否 | 工作空間狀態,目前支持如下值:
| ENABLED |
Option | string | 否 | 選項,取值如下:
| GetWorkspaces |
Verbose | boolean | 否 | 是否顯示工作空間詳細信息。取值如下:
| true |
Fields | string | 否 | 工作空間詳情的返回字段列表。用于限定返回結果中的工作空間屬性。 多個屬性用半角逗號(,)分隔。目前只支持 Id,表示工作空間 ID。 | Id |
WorkspaceIds | string | 否 | 工作空間 ID 列表。多個工作空間 ID 用半角逗號(,)分隔。 | 123,234 |
返回參數
示例
正常返回示例
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"
}
}
],
"TotalCount": 1,
"ResourceLimits": {
"MaxCompute_share": 1,
"MaxCompute_isolate": 1,
"DLC_share": 1
}
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2021-03-02 | OpenAPI 返回結構發生變更 | 查看變更詳情 |
2021-03-02 | OpenAPI 入參發生變更 | 查看變更詳情 |
2021-03-02 | OpenAPI 返回結構發生變更 | 查看變更詳情 |