GetProject

Queries the details of a DataWorks workspace.

Operation description

You must purchase DataWorks Basic Edition or a higher edition to use this operation.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Id	integer	Yes	The ID of the DataWorks workspace. You can log on to the DataWorks console and go to the workspace management page to obtain the ID. This parameter specifies the DataWorks workspace for this API call.	123456

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID, which is used to locate logs and troubleshoot issues.	22C97E95-F023-56B5-8852-B1A77A1****
Project	object	The details of the workspace.
Id	integer	The workspace ID.	28477242
Name	string	The workspace name.	sora_finance
DisplayName	string	The display name of the workspace.	Sora financial analysis
Description	string	The description of the workspace.	Financial analysis group project data development
Owner	string	The user ID of the workspace owner, which is the Alibaba Cloud account ID.	207947397706614299
AliyunResourceGroupId	string	The ID of the Alibaba Cloud resource group to which the workspace belongs.	rg-acfmzbn7pti3zfa
Status	string	The workspace status. Valid values: Available: The workspace is running normally. Initializing: The workspace is being initialized. InitFailed: The workspace failed to be initialized. Forbidden: The workspace is manually disabled. Deleting: The workspace is being deleted. DeleteFailed: The workspace failed to be deleted. Frozen: The workspace is frozen due to overdue payment. Updating: The workspace is being updated. UpdateFailed: The workspace failed to be updated.	Available
PaiTaskEnabled	boolean	Indicates whether PAI task scheduling is enabled. Valid values: true: You can create Machine Learning Platform for AI (PAI) nodes in the DataWorks workspace and run them on a periodic schedule based on the node configurations. false: PAI task scheduling is disabled.	true
DevEnvironmentEnabled	boolean	Indicates whether the development environment is enabled. Valid values: true: The development environment is enabled for the workspace, which supports isolation between the development and production environments. false: Only the production environment is used.	true
DevRoleDisabled	boolean	Indicates whether the development role is disabled. Valid values: false: The development role is enabled. true: The development role is disabled.	false
AliyunResourceTags	array<object>	The tags.
	object	The tag details.
Key	string	The tag key.	batch
Value	string	The tag value.	blue

Examples

Success response

JSON format

{
  "RequestId": "22C97E95-F023-56B5-8852-B1A77A1****",
  "Project": {
    "Id": 28477242,
    "Name": "sora_finance",
    "DisplayName": "Sora financial analysis",
    "Description": "Financial analysis group project data development",
    "Owner": "207947397706614299",
    "AliyunResourceGroupId": "rg-acfmzbn7pti3zfa",
    "Status": "Available",
    "PaiTaskEnabled": true,
    "DevEnvironmentEnabled": true,
    "DevRoleDisabled": false,
    "AliyunResourceTags": [
      {
        "Key": "batch",
        "Value": "blue"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.