All Products
Search
Document Center

DataWorks:ListProjects

Last Updated:Dec 05, 2024

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

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
dataworks:ListProjectslist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
IdsarrayNo

The IDs of the DataWorks workspaces.

longNo

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
NamesarrayNo

The names of the DataWorks workspaces.

stringNo

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
AliyunResourceGroupIdstringNo

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.

rg-acfmzbn7pti3zff
StatusstringNo

The status of the workspaces. Valid values:

  • Available
  • Initializing
  • InitFailed
  • Forbidden
  • Deleting
  • DeleteFailed
  • Frozen
  • Updating
  • UpdateFailed
Available
DevEnvironmentEnabledbooleanNo

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
DevRoleDisabledbooleanNo

Specifies whether the Develop role is disabled. Valid values:

  • false (default)
  • true
false
PaiTaskEnabledbooleanNo

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
AliyunResourceTagsarray<object>No

The tags.

objectNo

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.

KeystringNo

The tag key.

batch
ValuestringNo

The tag value.

blue
PageNumberintegerNo

The page number.

1
PageSizeintegerNo

The number of entries per page. Default value: 10. Maximum value: 100.

10

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

6D24AD9A-652F-59E2-AC1F-05029300F8A4
PagingInfoobject

The pagination information.

PageSizeinteger

The number of entries per page.

1
PageNumberinteger

The page number.

10
TotalCountinteger

The total number of entries returned.

100
Projectsarray<object>

The workspaces.

projectobject

The workspace.

Idlong

The workspace ID.

123456
Namestring

The name of the workspace.

sora_finance
DisplayNamestring

The display name of the workspace.

Descriptionstring

The description of the workspace.

Ownerstring

The ID of the Alibaba Cloud account to which the workspace belongs.

123532153125
AliyunResourceGroupIdstring

The ID of the Alibaba Cloud resource group to which the workspace belongs.

rg-acfmzbn7pti3zfa
Statusstring

The status of the workspace. Valid values:

  • Available
  • Initializing
  • InitFailed
  • Forbidden
  • Deleting
  • DeleteFailed
  • Frozen
  • Updating
  • UpdateFailed
Available
PaiTaskEnabledboolean

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
DevEnvironmentEnabledboolean

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
DevRoleDisabledboolean

Indicates whether the Develop role is disabled. Valid values:

  • false (default)
  • true
false
AliyunResourceTagsarray<object>

The tags.

tagsobject

The tag.

Keystring

The tag key.

batch
Valuestring

The tag value.

blue

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.