GetProject

Queries the details of a DataWorks 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:GetProject

get

Project

acs:dataworks:{#regionId}:{#accountId}:workspace/{#ProjectIdentifier}

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	integer	No	The DataWorks workspace ID. You can call the ListProjects operation to obtain the workspace ID.	466230
ProjectIdentifier	string	No	The name of the DataWorks workspace. You can call the ListProjects operation to obtain the workspace name.	test_project

Response elements

Element	Type	Description	Example
	object	The response parameters.
Data	object	The details of the workspace.
Appkey	string	This parameter is deprecated.	0
BaseProject	boolean	This parameter is deprecated.	false
DefaultDiResourceGroupIdentifier	string	The identifier of the default resource group that is automatically assigned when you purchase a MaxCompute exclusive resource group.	group_280749521****
Destination	integer	This parameter is deprecated.	0
DevStorageQuota	string	This parameter is deprecated.	0
DevelopmentType	integer	This parameter is deprecated.	4
DisableDevelopment	boolean	Indicates whether the development role is disabled. Valid values: false (default): The development role is enabled. true: The development role is disabled.	true
EnvTypes	array	The environment context of the workspace.
	string	The environments of the workspace: Basic mode contains only the production environment (PROD). Standard mode contains the development environment (DEV) and the production environment (PROD).	["PROD"]
GmtCreate	string	The time when the workspace was created. Example: `Dec 3, 2019 9:12:20 PM`.	Oct 10, 2019 3:42:53 PM
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
IsAllowDownload	integer	Indicates whether downloading query results from the IDE is allowed. Valid values: 1: Downloading is allowed. 0: Downloading is not allowed.	1
IsDefault	integer	Indicates whether the workspace is the default workspace. Valid values: 1: Yes. 0: No.	1
MaxFlowNode	integer	This parameter is deprecated.	1
ProdStorageQuota	string	This parameter is deprecated.	1
ProjectDescription	string	The description of the workspace.	test_describe
ProjectId	integer	The workspace ID.	466230
ProjectIdentifier	string	The name of the workspace.	test_project
ProjectMode	integer	The mode of the workspace. Valid values: 2: basic mode. 3: standard mode.	2
ProjectName	string	The display name of the workspace.	test_project
ProjectOwnerBaseId	string	The Alibaba Cloud ID of the workspace owner.	18229311****
ProtectedMode	integer	Indicates whether protected mode is enabled for the workspace. Valid values: 1: Protected mode is enabled. 0: Protected mode is not enabled.	1
ResidentArea	string	The type of the workspace. Valid values: private: private zone. swap: swap zone.	private
ResourceManagerResourceGroupId	string	The resource group ID.	rg-acfmzbn7****
SchedulerMaxRetryTimes	integer	The default maximum number of automatic reruns upon an error.	3
SchedulerRetryInterval	integer	The default interval between automatic reruns upon an error. Unit: ms. The maximum value is 30 minutes. Note the unit conversion.	120000
Status	integer	The status of the workspace. Valid values: 0: AVAILABLE. The workspace is running normally. 1: DELETED. The workspace has been deleted. 2: INITIALIZING. The workspace is being initialized. 3: INIT_FAILED. The workspace failed to be initialized. 4: FORBIDDEN. The workspace is manually disabled. 5: DELETING. The workspace is being deleted. 6: DEL_FAILED. The workspace failed to be deleted. 7: FROZEN. The workspace is frozen due to overdue payment. 8: UPDATING. The workspace is being updated (a compute engine is being added and initialized). 9: UPDATE_FAILED. The workspace failed to be updated (a compute engine failed to be added and initialized).	0
TablePrivacyMode	integer	The visibility of MaxCompute tables. Valid values: 0: MaxCompute tables are not visible to users within the tenant. 1: MaxCompute tables are visible to users within the tenant.	1
Tags	array<object>	The list of tags bound to the workspace.
	object	The tag details.
Key	string	The tag key.	key
Value	string	The tag value.	value
TenantId	integer	The tenant ID.	280749521
UseProxyOdpsAccount	boolean	Indicates whether a proxy account is used to access the MaxCompute engine.	true
HttpStatusCode	integer	The HTTP status code.	200
RequestId	string	The request ID.	1AFAE64E-D1BE-432B-A9****
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true

Examples

Success response

JSON format

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

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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.