GetProjectDetail-DataWorks(DataWorks)-阿里云帮助中心

Queries the information about 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:GetProjectDetail

get

Project

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

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	integer	Yes	The DataWorks workspace ID.	27

Response elements

Element	Type	Description	Example
	object
HttpStatusCode	integer	The HTTP status code.	200
RequestId	string	The request ID.	0bc1411515937635973****
Success	boolean	Indicates whether the request was successful.	true
Data	object	The information about the workspace.
Status	integer	The status of the workspace.	0
ResidentArea	string	The type of the workspace. Valid values: private and swap.	private
ProjectId	integer	The workspace ID.	27
ProjectIdentifier	string	The unique identifier of the workspace.	abc
ProjectName	string	The display name of the workspace.	abc
IsAllowDownload	integer	Indicates whether the download operation is allowed.	1
ProjectMode	integer	The mode of the workspace. The value 2 indicates that the workspace is in basic mode. The value 3 indicates that the workspace is in standard mode.	1
ProjectDescription	string	The description of the workspace.	abc
GmtModified	string	The time when the workspace was last modified.	Dec 3, 2019 9:12:20 PM
ProjectOwnerBaseId	string	The ID of the Alibaba Cloud account used by the workspace owner.	18229311****
DevelopmentType	integer	The development type of the workspace. The value is fixed to 4.	4
DefaultDiResourceGroupIdentifier	string	The identifier of the shared resource group for Data Integration on which nodes are run.	group_280749521****
GmtCreate	string	The time when the workspace was created.	Oct 10, 2019 3:42:53 PM
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.	1
TenantId	integer	The tenant ID.	280749521950784
SchedulerRetryInterval	integer	The interval between automatic reruns after an error occurs.	120000
EnvTypes	array	The environments of workspaces in different modes. Workspaces in basic mode provide only the production environment. Workspaces in standard mode provide both the development environment and the production environment.
	string	The environment of the workspace in a different mode. Workspaces in basic mode provide only the production 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 tag information.
	object
Key	string	The tag key.	Env
Value	string	The tag value.	Test
DisableDevelopment	boolean	Indicates whether the Develop role is disabled. Valid values: false (default) true	true
UseProxyOdpsAccount	boolean	Indicates whether a proxy account is used to access the MaxCompute compute engine.	true
TablePrivacyMode	integer	Indicates whether the MaxCompute tables in the workspace are visible to the users within a tenant. Valid values: 0: The MaxCompute tables in the workspace are not visible to the users within a tenant. 1: The MaxCompute tables in the workspace are visible to the users within a tenant.	1
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

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	Invalid.Tenant.ConnectionNotExists	The connection does not exist.	The connection does not exist.
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.