GetProject - DataWorks - Alibaba Cloud Documentation Center

Queries the information about a DataWorks workspace.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
dataworks:GetProject	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
Id	long	Yes	The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to query the ID. You must configure this parameter to specify the DataWorks workspace to which the API operation is applied.	123456

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	22C97E95-F023-56B5-8852-B1A77A17XXXX
Project	object	The information about the workspace.
Id	long	The workspace ID.	28477242
Name	string	The name of the workspace.	sora_finance
DisplayName	string	The display name of the workspace.
Description	string	The description of the workspace.
Owner	string	The ID of the Alibaba Cloud account to which the workspace belongs.	207947397706614299
AliyunResourceGroupId	string	The ID of the Alibaba Cloud resource group to which the workspace belongs.	rg-acfmzbn7pti3zfa
Status	string	The status of the workspace. Valid values: Available Initializing InitFailed Forbidden Deleting DeleteFailed Frozen Updating UpdateFailed	Available
PaiTaskEnabled	boolean	Indicates whether scheduling of Platform for AI (PAI) tasks is enabled. Valid values: true: Scheduling of PAI tasks is enabled. 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: Scheduling of PAI tasks is disabled.	true
DevEnvironmentEnabled	boolean	Indicates whether the development environment is enabled. Valid values: true: The development environment is enabled. In this case, the development environment is isolated from the production environment in the workspace. false: The development environment is disabled. In this case, only the production environment is used in the workspace.	true
DevRoleDisabled	boolean	Indicates whether the Develop role is disabled. Valid values: false true	false
AliyunResourceTags	array<object>	The tags.
tags	object	The tag.
Key	string	The tag key.	batch
Value	string	The tag value.	blue

Examples

Sample success responses

JSONformat

{
  "RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX\n",
  "Project": {
    "Id": 28477242,
    "Name": "sora_finance",
    "DisplayName": "",
    "Description": "",
    "Owner": "207947397706614299",
    "AliyunResourceGroupId": "rg-acfmzbn7pti3zfa",
    "Status": "Available",
    "PaiTaskEnabled": true,
    "DevEnvironmentEnabled": true,
    "DevRoleDisabled": false,
    "AliyunResourceTags": [
      {
        "Key": "batch",
        "Value": "blue"
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.