ListProjects - 获取工作空间详情列表_大数据开发治理平台 DataWorks(DataWorks)-阿里云帮助中心

该接口用于查询用户所在租户下的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：工作空间运行正常 Initializing：初始化工作空间 InitFailed：工作空间初始化失败 Forbidden：手动禁用工作空间 Deleting：正在删除工作空间 DeleteFailed：工作空间删除失败 Frozen：工作空间欠费冻结 Updating：更新工作空间中 UpdateFailed：更新工作空间失败该参数用于查询符合该状态的工作空间详情。	Available
DevEnvironmentEnabled	boolean	否	是否启用开发环境： true 工作空间启用开发环境，支持开发与生产环境隔离 false 仅使用生产环境该参数用于查询符合“启用/未启用开发环境”条件的工作空间详情。	true
DevRoleDisabled	boolean	否	是否禁用开发角色： false，开启开发角色（默认） true，禁用开发角色该参数用于查询符合“开启/禁用开发角色”条件的工作空间详情。	false
PaiTaskEnabled	boolean	否	是否启用 PAI 任务调度： true 可以在 DataWorks 工作空间创建机器学习（PAI）节点，并按照节点配置进行周期性调度运行。 false 禁用 PAI 任务调度该参数用于查询符合“开启/未开启 PAI 任务调用”条件的工作空间详情。	true
AliyunResourceTags	array<object>	否	标签列表。该参数用于查询拥有任意标签键值信息的工作空间详情。
	object	否	标签详情。您可以登录资源管理控制台，进入标签列表页面获取 Key、Value。
Key	string	否	标签键。	batch
Value	string	否	标签值。	blue
PageNumber	integer	否	请求的数据页数，用于翻页。	1
PageSize	integer	否	每页显示的条数，默认为 10 条，最大 100 条。	10

返回参数

名称	类型	描述	示例值
	object	返回结果。
RequestId	string	请求的 ID，用于定位日志，排查问题。	6D24AD9A-652F-59E2-AC1F-05029300F8A4
PagingInfo	object	分页信息。
PageSize	integer	每页显示的条数。	1
PageNumber	integer	请求的数据页数，用于翻页。	10
TotalCount	integer	满足条件的数据总条数。	100
Projects	array<object>	工作空间列表。
project	object	工作空间详细信息。
Id	long	工作空间 ID。	123456
Name	string	工作空间名称。	sora_finance
DisplayName	string	工作空间展示名称。	Sora金融分析
Description	string	工作空间描述。	金融分析组项目数据开发
Owner	string	工作空间拥有者 UserId，即阿里云账号 ID。	123532153125
AliyunResourceGroupId	string	工作空间所属阿里云资源组 ID。	rg-acfmzbn7pti3zfa
Status	string	空间状态： Available：工作空间运行正常 Initializing：初始化工作空间 InitFailed：工作空间初始化失败 Forbidden：手动禁用工作空间 Deleting：正在删除工作空间 DeleteFailed：工作空间删除失败 Frozen：工作空间欠费冻结 Updating：更新工作空间中 UpdateFailed：更新工作空间失败	Available
PaiTaskEnabled	boolean	是否启用 PAI 任务调度： true 可以在 DataWorks 工作空间创建机器学习（PAI）节点，并按照节点配置进行周期性调度运行。 false 禁用 PAI 任务调度。	true
DevEnvironmentEnabled	boolean	是否启用开发环境： true 工作空间启用开发环境，支持开发与生产环境隔离。 false 仅使用生产环境。	true
DevRoleDisabled	boolean	是否禁用开发角色： false，开启开发角色 true，禁用开发角色	false
AliyunResourceTags	array<object>	标签组。
tags	object	标签详情。
Key	string	标签键。	batch
Value	string	标签值。	blue

示例

正常返回示例

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"
          }
        ]
      }
    ]
  }
}

错误码

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