CreateProject-阿里云帮助中心

Creates a 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

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Name	string	Yes	The name of the workspace. Limits: The workspace name must be unqiue in a region. The workspace name can contain letters, digits, and underscores (_), and must start with a letter. The workspace name must be 3 to 28 characters in length.	sora_finance
DisplayName	string	Yes	The display name of the workspace.	Sora financial analysis
Description	string	No	The description of the workspace.	Financial analysis group project data development
AliyunResourceGroupId	string	No	The ID of the Alibaba Cloud resource group to which the workspace belongs. You can log on to the Resource Management console and go to the Resource Group page to query the ID. You must configure this parameter to specify an Alibaba Cloud resource group for the workspace that you want to create.	rg-acfmzbn7pti3zff
PaiTaskEnabled	boolean	No	Specifies whether to enable scheduling of Platform for AI (PAI) tasks. Valid values: true: enables scheduling of PAI tasks. 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: disables scheduling of PAI tasks.	true
DevEnvironmentEnabled	boolean	No	Specifies whether to enable the development environment. Valid values: true : enables the development environment. In this case, the development environment is isolated from the production environment in the workspace. false: disables the development environment. In this case, only the production environment is used in the workspace.	false
AliyunResourceTags	array<object>	No	The tags.
	object	No
Key	string	No	The tag key.	batch
Value	string	No	The tag value.	blue
DevRoleDisabled	boolean	No	Specifies whether to disable the Develop role. Valid values: false (default) true	true

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	AFBB799F-8578-51C5-A766-E922EDB8XXXX
ProjectId `deprecated`	integer	The workspace ID. Note: This parameter is deprecated and is replaced by the Id parameter.	123456
Id	integer	The workspace ID.	123456

Examples

Success response

JSON format

{
  "RequestId": "AFBB799F-8578-51C5-A766-E922EDB8XXXX\n",
  "ProjectId": 123456,
  "Id": 123456
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.