文档

ListWorkspaces - 获取工作空间列表

更新时间:

获取某个地域下的工作空间列表。

接口说明

您可以通过 option 参数指定不同的查询选项,来获取不同的工作空间相关信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

GET /api/v1/workspaces

请求参数

名称类型必填描述示例值
PageNumberlong

工作空间列表的页码。起始值为 1,默认为 1。

1
PageSizeinteger

分页查询时设置的每页行数,默认为 20。

20
SortBystring

分页查询时的排序字段,默认使用 GmtCreateTime。取值如下。

  • GmtCreateTime(默认值):按创建时间。
  • GmtModifiedTime:按修改时间。
GmtCreateTime
Orderstring

分页查询时,对指定的排序字段进行升序或降序。取值如下:

  • ASC(默认值):升序。
  • DESC :降序。
ASC
WorkspaceNamestring

工作空间名称。

abc
ModuleListstring

逗号分割的模块列表。默认值:PAI。

PAI
Statusstring

工作空间状态,目前支持如下值:

  • ENABLED:正常。
  • INITIALIZING:初始化中。
  • FAILURE:失败。
  • DISABLED:手动禁用。
  • FROZEN:欠费冻结。
  • UPDATING:项目更新中。
ENABLED
Optionstring

选项,取值如下:

  • GetWorkspaces(默认值):获取工作空间列表,会返回 Workspaces。
  • GetResourceLimits:获取资源限制,会返回 ResourceLimits。
GetWorkspaces
Verboseboolean

是否显示工作空间详细信息。取值如下:

  • false(默认值):不显示。
  • true:显示。
true
Fieldsstring

工作空间详情的返回字段列表。用于限定返回结果中的工作空间属性。 多个属性用半角逗号(,)分隔。目前只支持 Id,表示工作空间 ID。

Id
WorkspaceIdsstring

工作空间 ID 列表。多个工作空间 ID 用半角逗号(,)分隔。

123,234

返回参数

名称类型描述示例值
object

返回结构体。

RequestIdstring

请求 ID。

8D7B2E70-F770-505B-A672-09F1D8F2EC1E
Workspacesobject []

工作空间详情列表,当 Option 为 GetWorkspaces 时会返回该列表。

WorkspaceIdstring

工作空间 ID。

123
WorkspaceNamestring

工作空间名称。

workspace-example
GmtCreateTimestring

工作空间创建时间。以 ISO8601 为标准,并使用 UTC+0 时间,格式为 yyyy-MM-ddTHH:mm:ss.SSSZ。

2021-01-21T17:12:35.232Z
GmtModifiedTimestring

工作空间修改时间。以 ISO8601 为标准,并使用 UTC+0 时间,格式为 yyyy-MM-ddTHH:mmZ。

2021-01-21T17:12:35.232Z
Descriptionstring

工作空间描述。

workspace description example
Creatorstring

创建者用户 ID。

122424353535
EnvTypesarray

工作空间包含的环境列表。

string

工作空间包含的环境,可能值:

  • 简单模式只有生产环境(prod)。
  • 标准模式包含开发环境(dev)和生产环境(prod)。
prod
Statusstring

工作空间状态。

ENABLED
AdminNamesarray

管理员账户名称列表。

string

管理员账户名称。

demo_test@***.aliyunid.com
IsDefaultboolean

是否为默认工作空间。

false
ExtraInfosobject

扩展信息,目前包含 TenantId,代表租户 ID。

{"TenantId": "4286******98"}
TotalCountlong

符合查询条件的工作空间总数。

1
ResourceLimitsobject

用户在一个工作空间内允许开通的资源类型和数量限制,当 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"
      }
    }
  ],
  "TotalCount": 1,
  "ResourceLimits": {
    "MaxCompute_share": 1,
    "MaxCompute_isolate": 1,
    "DLC_share": 1
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2021-03-02OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2021-03-02OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:WorkspaceIds
2021-03-02OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更