Modify Workspace Settings with UpdateProject API - DataWorks

Operation description

This feature requires DataWorks Basic Edition or a later version.

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

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Id	integer	Yes	The ID of the DataWorks workspace. To find the workspace ID, log in to the DataWorks console and go to the Workspace Management page. This parameter specifies the DataWorks workspace to use for the API call.	123456
Description	string	No	An optional description of the workspace.	Financial analysis group project data development
Status	string	No	Specifies whether to enable or disable the workspace. Valid values: `Available`: Enables the workspace. `Forbidden`: Disables the workspace.	Forbidden
DevEnvironmentEnabled	boolean	No	Specifies whether to enable the development environment. Valid values: `true`: Enables the development environment for the workspace and isolates it from the production environment. `false`: Uses only the production environment. Important: You cannot disable the development environment after you enable it.	true
DevRoleDisabled	boolean	No	Specifies whether to disable the development role, which grants permissions for workflow and code editing. Valid values: `false`: Enables the development role. This is the default value. `true`: Disables the development role. Important: After you enable the development role (by setting this parameter to `false`), you cannot disable it.	true
DisplayName	string	No	The display name of the workspace.	Sora financial analysis Space
PaiTaskEnabled	boolean	No	Specifies whether to enable task scheduling for Machine Learning Platform for AI (PAI). Valid values: `true`: You can create PAI nodes in the DataWorks workspace and run them on a schedule. `false`: Disables task scheduling for PAI.	true

Response elements

Element	Type	Description	Example
	object	The response data.
RequestId	string	The Request ID. Use this ID to troubleshoot issues.	AFBB799F-8578-51C5-A766-E922EDB8XXXX

Examples

Success response

JSON format

{
  "RequestId": "AFBB799F-8578-51C5-A766-E922EDB8XXXX\n"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.