调用ListProjects查询工作空间列表-大数据开发治理平台 DataWorks-阿里云-大数据开发治理平台 DataWorks(DataWorks)-阿里云帮助中心

该接口用于查询用户所在租户下的DataWorks工作空间列表。

接口说明

前置条件：已开通 DataWorks 服务，并为调用账号配置调用 OpenAPI 所需的 RAM 权限；权限或服务未就绪时可能返回 403 Forbidden.Access。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dataworks:ListProjects

get

*Project

acs:dataworks:{#regionId}:{#accountId}:workspace/*

无

请求参数

名称	类型	必填	描述	示例值
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	返回结果。
PageResult	object	查询结果。
PageNumber	integer	当前的页码。	1
PageSize	integer	每页显示的条数，默认为 10 条，最大 100 条。	10
ProjectList	array<object>	DataWorks 工作空间的结果列表。
	array<object>	工作空间详情。
DisableDevelopment	boolean	是否禁用开发角色，取值如下： false：开启开发角色。 true：禁用开发角色。	true
IsDefault	integer	是否为默认工作空间，取值如下： 1：是。 0：否。	1
ProjectDescription	string	工作空间的详细描述信息。	test_describe
ProjectId	integer	工作空间的 ID。	466230
ProjectIdentifier	string	工作空间的名称。	test_project
ProjectName	string	工作空间的显示名称。	test_project
ProjectOwnerBaseId	string	工作空间所有者的用户 ID。	13969939245****
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
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
ResourceManagerResourceGroupId	string	资源组 ID。	rg-acfmzbn7****
TablePrivacyMode	integer	MaxCompute 表的可见性权限，取值如下： 0：租户内用户不可见 MaxCompute 表。 1：租户内用户可见 MaxCompute 表。	1
Tags	array<object>	工作空间绑定的标签列表。
	object	标签信息。
Key	string	标签键。	key
Value	string	标签值。	value
UseProxyOdpsAccount	boolean	访问 MaxCompute 引擎是否使用代理账号。 false：不使用。 true：使用。	true
TotalCount	integer	返回结果的总条数。	68
RequestId	string	请求 ID。	20658801****

示例

正常返回示例

JSON格式

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

错误码

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.	用户不在租户中。

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

变更历史

更多信息，参考变更详情。