All Products
Search

This Product

    DataWorks:ListProjects

    Document Center

    DataWorks:ListProjects

    Last Updated:Aug 28, 2026

    Queries the list of DataWorks workspaces in your tenant.

    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

    No authorization for this operation. If you encounter issues with this operation, contact technical support.

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    PageNumber

    integer

    No

    The page number. Valid values: 1 to 100.

    1
    PageSize

    integer

    No

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

    10
    ResourceManagerResourceGroupId

    string

    No

    The resource group ID.

    rg-acfmzbn7pt****
    Tags

    array<object>

    No

    The tags to add to the workspace.

    object

    No

    Key

    string

    No

    The key of tag N to add to the workspace.

    key
    Value

    string

    No

    The value of tag N to add to the workspace.

    value

    Response elements

    Element

    Type

    Description

    Example

    object

    Response parameters.

    RequestId

    string

    The request ID.

    20658801****
    PageResult

    object

    Paginated results.

    PageNumber

    integer

    The page number.

    1
    PageSize

    integer

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

    10
    TotalCount

    integer

    The total number of entries returned.

    68
    ProjectList

    array<object>

    The DataWorks workspaces.

    array<object>

    ProjectStatusCode

    string

    The status code of the workspace. Valid values:

    • AVAILABLE (0): Running normally.

    • DELETED (1): Deleted.

    • INITIALIZING (2): Being initialized.

    • INIT_FAILED (3): Initialization failed.

    • FORBIDDEN (4): Manually disabled.

    • DELETING (5): Being deleted.

    • DEL_FAILED (6): Deletion failed.

    • FROZEN (7): Frozen due to overdue payments.

    • UPDATING (8): Being updated. The system initializes and updates the workspace after you associate a compute engine.

    • UPDATE_FAILED (9): Update failed.

    AVAILABLE
    ProjectStatus

    integer

    The status of the workspace. Valid values:

    • 0 (AVAILABLE): Running normally.

    • 1 (DELETED): Deleted.

    • 2 (INITIALIZING): Being initialized.

    • 3 (INIT_FAILED): Initialization failed.

    • 4 (FORBIDDEN): Manually disabled.

    • 5 (DELETING): Being deleted.

    • 6 (DEL_FAILED): Deletion failed.

    • 7 (FROZEN): Frozen due to overdue payments.

    • 8 (UPDATING): Being updated. The system initializes and updates the workspace after you associate a compute engine.

    • 9 (UPDATE_FAILED): Update failed.

    0
    ProjectName

    string

    The display name of the workspace.

    test_project
    ProjectIdentifier

    string

    The name of the workspace.

    test_project
    ProjectId

    integer

    The workspace ID.

    466230
    ProjectDescription

    string

    The description of the workspace.

    test_describe
    ProjectOwnerBaseId

    string

    The user ID of the workspace owner.

    13969939245****
    ResourceManagerResourceGroupId

    string

    The resource group ID.

    rg-acfmzbn7****
    Tags

    array<object>

    The tags added to the workspace.

    object

    Key

    string

    The key of tag N added to the workspace.

    key
    Value

    string

    The value of tag N added to the workspace.

    value
    DisableDevelopment

    boolean

    Whether the Development role is disabled. Valid values:

    • false: enabled

    • true: disabled

    true
    UseProxyOdpsAccount

    boolean

    Whether a proxy account is used to access the MaxCompute compute engine associated with the workspace. Valid values:

    • false

    • true

    true
    TablePrivacyMode

    integer

    Whether MaxCompute tables in the workspace are visible to users within the tenant. Valid values:

    • 0: invisible

    • 1: visible

    1
    IsDefault

    integer

    Whether the workspace is a default workspace. Valid values:

    • 1: The workspace is a default workspace.

    • 0: The workspace is not a default workspace.

    1

    Examples

    Success response

    JSON format

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

    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.