ListProjects-阿里云帮助中心

Queries a list of DataWorks workspaces of the tenant to which your account belongs.

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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Ids	array	No	The IDs of the DataWorks workspaces.
	integer	No	The ID of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace page to query the ID.	123456
Names	array	No	The names of the DataWorks workspaces.
	string	No	The name of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace page to query the name.	sora_finance
AliyunResourceGroupId	string	No	The ID of the Alibaba Cloud resource group to which the workspaces belong. You can log on to the Resource Management console and go to the Resource Group page to query the ID. This parameter is used to query the information about workspaces that belong to a specific resource group.	rg-acfmzbn7pti3zff
Status	string	No	The status of the workspaces. Valid values: Available Initializing InitFailed Forbidden Deleting DeleteFailed Frozen Updating UpdateFailed	Available
DevEnvironmentEnabled	boolean	No	Specifies whether the development environment is enabled. Valid values: true: The development environment is enabled. In this case, the development environment is isolated from the production environment in a workspace. false: The development environment is disabled. In this case, only the production environment is used in a workspace.	true
DevRoleDisabled	boolean	No	Specifies whether the Develop role is disabled. Valid values: false (default) true	false
PaiTaskEnabled	boolean	No	Specifies whether scheduling of Platform for AI (PAI) tasks is enabled. Valid values: true: Scheduling of PAI tasks is enabled. In this case, you can create a PAI node in a DataWorks workspace and configure scheduling properties for the node to implement periodic scheduling of PAI tasks. false: Scheduling of PAI tasks is disabled.	true
AliyunResourceTags	array<object>	No	The tags.
	object	No	The tag. You can log on to the Resource Management console and go to the Tag page to query the tag key and tag value.
Key	string	No	The tag key.	batch
Value	string	No	The tag value.	blue
PageNumber	integer	No	The page number.	1
PageSize	integer	No	The number of entries per page. Default value: 10. Maximum value: 100.	10

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	6D24AD9A-652F-59E2-AC1F-05029300F8A4
PagingInfo	object	The pagination information.
PageSize	integer	The number of entries per page.	1
PageNumber	integer	The page number.	10
TotalCount	integer	The total number of entries returned.	100
Projects	array<object>	The workspaces.
	array<object>	The workspace.
Id	integer	The workspace ID.	123456
Name	string	The name of the workspace.	sora_finance
DisplayName	string	The display name of the workspace.	Sora financial analysis
Description	string	The description of the workspace.	Financial analysis group project data development
Owner	string	The ID of the Alibaba Cloud account to which the workspace belongs.	123532153125
AliyunResourceGroupId	string	The ID of the Alibaba Cloud resource group to which the workspace belongs.	rg-acfmzbn7pti3zfa
Status	string	The status of the workspace. Valid values: Available Initializing InitFailed Forbidden Deleting DeleteFailed Frozen Updating UpdateFailed	Available
PaiTaskEnabled	boolean	Indicates whether scheduling of PAI tasks is enabled. Valid values: true: Scheduling of PAI tasks is enabled. In this case, you can create a PAI node in a DataWorks workspace and configure scheduling properties for the node to implement periodic scheduling of PAI tasks. false: Scheduling of PAI tasks is disabled.	true
DevEnvironmentEnabled	boolean	Indicates whether the development environment is enabled. Valid values: true: The development environment is enabled. In this case, the development environment is isolated from the production environment in the workspace. false: The development environment is disabled. In this case, only the production environment is used in the workspace.	true
DevRoleDisabled	boolean	Indicates whether the Develop role is disabled. Valid values: false (default) true	false
AliyunResourceTags	array<object>	The tags.
	object	The tag.
Key	string	The tag key.	batch
Value	string	The tag value.	blue

Examples

Success response

JSON format

{
  "RequestId": "6D24AD9A-652F-59E2-AC1F-05029300F8A4",
  "PagingInfo": {
    "PageSize": 1,
    "PageNumber": 10,
    "TotalCount": 100,
    "Projects": [
      {
        "Id": 123456,
        "Name": "sora_finance",
        "DisplayName": "Sora financial analysis\n",
        "Description": "Financial analysis group project data development",
        "Owner": "123532153125",
        "AliyunResourceGroupId": "rg-acfmzbn7pti3zfa",
        "Status": "Available",
        "PaiTaskEnabled": true,
        "DevEnvironmentEnabled": true,
        "DevRoleDisabled": false,
        "AliyunResourceTags": [
          {
            "Key": "batch",
            "Value": "blue"
          }
        ]
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.