All Products
Search

This Product

    DataWorks:CreateProject

    Document Center

    DataWorks:CreateProject

    Last Updated:Sep 20, 2026

    Creates a DataWorks workspace.

    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:CreateProject

    create

    *Project

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

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    ClientToken

    string

    No

    The idempotency parameter. This parameter can be left empty.

    ABFUOEUOTRTRJKE
    ProjectName

    string

    Yes

    The display name of the workspace.

    test_project
    ProjectDescription

    string

    No

    The detailed description of the workspace.

    test_describe
    DisableDevelopment

    boolean

    No

    Specifies whether to disable the development role. Valid values:

    • false (default): enables the development role.

    • true: disables the development role.

    false
    IsAllowDownload

    integer

    No

    Specifies whether to allow downloading query results from the IDE. Valid values:

    • 1 (default): allows downloading.

    • 0: does not allow downloading.

    1
    ProjectMode

    integer

    No

    The mode of the workspace. For more information about the differences between modes, see Must-read: Differences between simple mode and standard mode.

    Valid values:

    • 2 (default): simple workspace mode.

    • 3: standard workspace mode.

    3
    ProjectIdentifier

    string

    Yes

    The name of the workspace. The name can contain only letters, digits, and underscores (_), and must start with a letter or digit.

    test_project
    ResourceManagerResourceGroupId

    string

    No

    The resource group ID.

    rg-acfmzbn7pti3****
    Tags

    array<object>

    No

    The list of tags bound to the workspace.

    object

    No

    The tag information.

    Key

    string

    Yes

    The tag key.

    key
    Value

    string

    Yes

    The tag value.

    value

    Response elements

    Element

    Type

    Description

    Example

    object

    The response.

    Data

    integer

    The ID of the DataWorks workspace that was created.

    466230
    HttpStatusCode

    integer

    The HTTP status code.

    200
    RequestId

    string

    The request ID.

    1AFAE64E-D1BE-432B-A9****
    Success

    boolean

    Indicates whether the request was successful. Valid values:

    • true: The request was successful.

    • false: The request failed.

    true

    Examples

    Success response

    JSON format

    {
  "Data": 466230,
  "HttpStatusCode": 200,
  "RequestId": "1AFAE64E-D1BE-432B-A9****",
  "Success": true
}

    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.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.