ListProjects - Query DataWorks workspaces - DataWorks - Alibaba Cloud Documentation Center

Queries a list of DataWorks workspaces in the tenant to which the user belongs.

Operation description

Before you begin: DataWorks is activated, and the RAM permissions required to call OpenAPI operations are configured for the calling account. If the permissions or service are not ready, a 403 Forbidden.Access error may be returned.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dataworks:ListProjects

get

*Project

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

None

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	No	The page number. Minimum value: 1. Maximum value: 100.	1
PageSize	integer	No	The number of entries per page. Default value: 10. Maximum value: 100.	10
ResourceManagerResourceGroupId	string	No	The ID of the resource group.	rg-acfmzbn7pt****
Tags	array<object>	No	The list of tags bound to the workspace.
	object	No	The tag information.
Key	string	No	The tag key.	key
Value	string	No	The tag value.	value

Response elements

Element	Type	Description	Example
	object	The response.
PageResult	object	The query result.
PageNumber	integer	The current page number.	1
PageSize	integer	The number of entries per page. Default value: 10. Maximum value: 100.	10
ProjectList	array<object>	The list of DataWorks workspaces.
	array<object>	The workspace details.
DisableDevelopment	boolean	Indicates whether the development role is disabled. Valid values: false: The development role is enabled. true: The development role is disabled.	true
IsDefault	integer	Indicates whether the workspace is the default workspace. Valid values: 1: Yes. 0: No.	1
ProjectDescription	string	The detailed description of the workspace.	test_describe
ProjectId	integer	The ID of the workspace.	466230
ProjectIdentifier	string	The name of the workspace.	test_project
ProjectName	string	The display name of the workspace.	test_project
ProjectOwnerBaseId	string	The user ID of the workspace owner.	13969939245****
ProjectStatus	integer	The status of the workspace. Valid values: AVAILABLE: 0. The workspace is normal. DELETED: 1. The workspace is deleted. INITIALIZING: 2. The workspace is being initialized. INIT_FAILED: 3. The workspace failed to be initialized. FORBIDDEN: 4. The workspace is manually disabled. DELETING: 5. The workspace is being deleted. DEL_FAILED: 6. The workspace failed to be deleted. FROZEN: 7. The workspace is frozen due to an overdue payment. UPDATING: 8. The workspace is being updated by adding and initializing a compute engine. UPDATE_FAILED: 9. The workspace failed to be updated by adding and initializing a compute engine.	0
ProjectStatusCode	string	The status code of the workspace. Valid values: AVAILABLE: 0. The workspace is normal. DELETED: 1. The workspace is deleted. INITIALIZING: 2. The workspace is being initialized. INIT_FAILED: 3. The workspace failed to be initialized. FORBIDDEN: 4. The workspace is manually disabled. DELETING: 5. The workspace is being deleted. DEL_FAILED: 6. The workspace failed to be deleted. FROZEN: 7. The workspace is frozen due to an overdue payment. UPDATING: 8. The workspace is being updated by adding and initializing a compute engine. UPDATE_FAILED: 9. The workspace failed to be updated by adding and initializing a compute engine.	AVAILABLE
ResourceManagerResourceGroupId	string	The ID of the resource group.	rg-acfmzbn7****
TablePrivacyMode	integer	The visibility permissions of MaxCompute tables. Valid values: 0: MaxCompute tables are invisible to users in the tenant. 1: MaxCompute tables are visible to users in the tenant.	1
Tags	array<object>	The list of tags bound to the workspace.
	object	The tag information.
Key	string	The tag key.	key
Value	string	The tag value.	value
UseProxyOdpsAccount	boolean	Indicates whether a proxy account is used to access the MaxCompute engine. Valid values: false: A proxy account is not used. true: A proxy account is used.	true
TotalCount	integer	The total number of returned entries.	68
RequestId	string	The ID of the request.	20658801****

Examples

Success response

JSON format

{
  "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****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	Invalid.Tenant.ConnectionNotExists	The connection does not exist.	The connection does not exist.
400	Invalid.Tenant.ProjectNotExists	The project does not exist.	The project does not exist.
400	Invalid.Tenant.UserAlreadyInProject	The user already exists in the project.	The user has already existed in project.
400	Invalid.Tenant.UserNotInProject	The user is not in the project.	The user is not in the project.
403	Invalid.Tenant.UserIsNotProjectOwnerOrAdmin	The user is not a project administrator or owner.	The user is not a project administrator or owner.
403	Invalid.Tenant.UserNotInTenant	The user is not in tenant.	The user is not in tenant.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.