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

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	long	Yes	The ID of the DataWorks workspace. You can call the ListProjects operation to query the ID.	27
ProjectIdentifier	string	No	The name of the DataWorks workspace. You can call the ListProjects operation to query the name.	test_project

Response parameters

Parameter	Type	Description	Example
	object	The returned result.
HttpStatusCode	integer	The HTTP status code.	200
RequestId	string	The request ID.	0bc1411515937635973****
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
Data	object	The information about the workspace.
Status	integer	The status of the workspace. Valid values: 0: AVAILABLE, which indicates that the workspace runs as expected. 1: DELETED, which indicates that the workspace is deleted. 2: INITIALIZING, which indicates that the workspace is being initialized. 3: INIT_FAILED, which indicates that the workspace fails to be initialized. 4: FORBIDDEN, which indicates that the workspace is manually disabled. 5: DELETING, which indicates that the workspace is being deleted. 6: DEL_FAILED, which indicates that the workspace fails to be deleted. 7: FROZEN, which indicates that the workspace is frozen due to overdue payments. 8: UPDATING, which indicates that the workspace is being updated. The workspace enters this state after you associate a new compute engine with the workspace and the compute engine is initialized. 9: UPDATE_FAILED, which indicates that the workspace fails to be updated.	0
MaxFlowNode	integer	This parameter is deprecated.	1
ProjectId	integer	The ID of the workspace.	27
IsAllowDownload	integer	Indicates whether you are allowed to download the query result from DataStudio. Valid values: 1: You are allowed to download the query result from DataStudio. 0: You are not allowed to download the query result from DataStudio.	1
ProjectMode	integer	The mode of the workspace. Valid values: 2: The workspace is in basic mode. 3: The workspace is in standard mode.	2
GmtModified	string	The time when the workspace was last modified. Example: `Dec 3, 2019 9:12:20 PM`.	Dec 3, 2019 9:12:20 PM
ProdStorageQuota	string	This parameter is deprecated.	1
ProjectDescription	string	The description of the workspace.	abc
DevelopmentType	integer	This parameter is deprecated.	4
TablePrivacyMode	integer	Indicates whether the MaxCompute tables in the workspace are visible to the users within a tenant. Valid values: 0: invisible 1: visible	1
DefaultDiResourceGroupIdentifier	string	The ID of the resource group that was allocated by default when you purchased an exclusive resource group for MaxCompute.	group_280749521****
SchedulerMaxRetryTimes	integer	The default maximum number of automatic reruns that are allowed after an error occurs.	3
ProtectedMode	integer	Indicates whether the workspace protection feature is enabled. Valid values: 1: enabled 0: disabled	1
SchedulerRetryInterval	integer	The default interval between automatic reruns after an error occurs. Unit: milliseconds. The maximum interval is 30 minutes. You must pay attention to the conversion between units.	120000
Appkey	string	This parameter is deprecated.	0
DevStorageQuota	string	This parameter is deprecated.	0
ResidentArea	string	The type of the workspace. Valid values: private swap	private
IsDefault	integer	Indicates whether the workspace is a default workspace. Valid values: 1: The workspace is a default workspace. 0: The workspace is not a default workspace.	1
Destination	integer	This parameter is deprecated.	0
ProjectName	string	The display name of the workspace.	abc
ProjectIdentifier	string	The name of the workspace.	abc
DisableDevelopment	boolean	Indicates whether the Develop role is disabled. Valid values: false (default) true	true
ProjectOwnerBaseId	string	The ID of the Alibaba Cloud account used by the workspace owner.	18229311****
BaseProject	boolean	This parameter is deprecated.	false
UseProxyOdpsAccount	boolean	Indicates whether a proxy account is used to access the MaxCompute compute engine associated with the workspace.	true
GmtCreate	string	The time when the workspace was created. Example: `Dec 3, 2019 9:12:20 PM`.	Oct 10, 2019 3:42:53 PM
TenantId	long	The tenant ID.	280749521
EnvTypes	array	The environment information of the workspace.
EnvTypes	string	The environment of the workspace. Valid values: PROD and DEV. The value PROD indicates the production environment. Workspaces in basic mode provide only the production environment. The value DEV indicates the development environment. Workspaces in standard mode provide both the development environment and the production environment.	["PROD"]
ResourceManagerResourceGroupId	string	The resource group ID.	rg-acfmzbn7pti3zfa
Tags	array<object>	The tags added to the workspace.
Tag	object
Key	string	The tag key.	Env
Value	string	The tag value.	Test

Examples

Sample success responses

JSONformat

{
  "HttpStatusCode": 200,
  "RequestId": "0bc1411515937635973****",
  "Success": true,
  "Data": {
    "Status": 0,
    "MaxFlowNode": 1,
    "ProjectId": 27,
    "IsAllowDownload": 1,
    "ProjectMode": 2,
    "GmtModified": "Dec 3, 2019 9:12:20 PM",
    "ProdStorageQuota": " 1",
    "ProjectDescription": "abc",
    "DevelopmentType": 4,
    "TablePrivacyMode": 1,
    "DefaultDiResourceGroupIdentifier": "group_280749521****",
    "SchedulerMaxRetryTimes": 3,
    "ProtectedMode": 1,
    "SchedulerRetryInterval": 120000,
    "Appkey": "0",
    "DevStorageQuota": "0",
    "ResidentArea": "private",
    "IsDefault": 1,
    "Destination": 0,
    "ProjectName": "abc",
    "ProjectIdentifier": "abc",
    "DisableDevelopment": true,
    "ProjectOwnerBaseId": "18229311****",
    "BaseProject": false,
    "UseProxyOdpsAccount": true,
    "GmtCreate": "Oct 10, 2019 3:42:53 PM",
    "TenantId": 280749521,
    "EnvTypes": [
      "[\"PROD\"]"
    ],
    "ResourceManagerResourceGroupId": "rg-acfmzbn7pti3zfa",
    "Tags": [
      {
        "Key": "Env",
        "Value": "Test"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
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.

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

Change history

Change time	Summary of changes	Operation
2023-09-19	The Error code has changed. The request parameters of the API has changed	View Change Details
2022-11-07	The Error code has changed	View Change Details
2022-10-31	API Description Update. The Error code has changed. The response structure of the API has changed	View Change Details