DocsICP FilingConsole
Documentation
Home Page DataWorks Developer Reference API Reference (2020-05-18) API catalog Canceled APIs. GetProjectDetail

GetProjectDetail

Updated at:
Copy as MD
Product
My Favorites

Queries the information about a DataWorks workspace.

Note

This API has been deprecated. We recommend migrating to dataworks-public(2020-05-18) - GetProject for enhanced functionality and continued support. While the deprecated API remains temporarily accessible, no further updates or bug fixes will be provided.

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 None

Request parameters

Parameter

Type

Required

Description

Example
ProjectId

integer

Yes

The ID of the DataWorks workspace.

27

Response elements

Element

Type

Description

Example

object

Data

object

The description of the workspace.

DefaultDiResourceGroupIdentifier

string

The identifier of the default data integration resource group for nodes.

group_280749521****
DevelopmentType

integer

The project development type. The value is 4.

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 environments contained in the workspace. A workspace in basic mode contains only the production environment (PROD). A workspace in standard mode contains the development environment (DEV) and the production environment (PROD).

string

The environments contained in the workspace. A workspace in basic mode contains only the production environment (PROD). A workspace in standard mode contains the development environment (DEV) and the production environment (PROD).

["PROD"]
GmtCreate

string

The time when the workspace was created.

Oct 10, 2019 3:42:53 PM
GmtModified

string

The time when the workspace was last modified.

Dec 3, 2019 9:12:20 PM
IsAllowDownload

integer

Indicates whether downloads are allowed.

1
IsDefault

integer

Indicates whether the workspace is the default workspace. Valid values:

  • 1: Yes.

  • 0: No.

1
ProjectDescription

string

The description of the workspace.

abc
ProjectId

integer

The ID of the workspace.

27
ProjectIdentifier

string

The identifier of the workspace.

abc
ProjectMode

integer

The workspace mode. A value of 2 indicates basic mode. A value of 3 indicates standard mode.

1
ProjectName

string

The display name of the workspace.

abc
ProjectOwnerBaseId

string

The Alibaba Cloud ID of the workspace owner.

18229311****
ProtectedMode

integer

Indicates whether protected mode is enabled for the workspace.

1
ResidentArea

string

The type of the workspace. A value of private indicates a private zone. A value of swap indicates a swap zone.

private
ResourceManagerResourceGroupId

string

The resource group ID.

rg-acfmzbn7pti3zfa
SchedulerMaxRetryTimes

integer

The default maximum number of automatic reruns upon an error.

3
SchedulerRetryInterval

integer

The default interval between automatic reruns upon an error.

120000
Status

integer

The status of the workspace.

0
TablePrivacyMode

integer

The visibility of MaxCompute tables. Valid values:

  • 0: MaxCompute tables are not visible to tenant users.

  • 1: MaxCompute tables are visible to tenant users.

1
Tags

array<object>

The tag information.

object

The tag information.

Key

string

The tag key.

Env
Value

string

The tag value.

Test
TenantId

integer

The tenant ID.

280749521950784
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.

0bc1411515937635973****
Success

boolean

Indicates whether the workspace information was queried successfully.

true

Examples

Success response

JSON format

{
  "Data": {
    "DefaultDiResourceGroupIdentifier": "group_280749521****",
    "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,
    "ProjectDescription": "abc",
    "ProjectId": 27,
    "ProjectIdentifier": "abc",
    "ProjectMode": 1,
    "ProjectName": "abc",
    "ProjectOwnerBaseId": "18229311****",
    "ProtectedMode": 1,
    "ResidentArea": "private",
    "ResourceManagerResourceGroupId": "rg-acfmzbn7pti3zfa",
    "SchedulerMaxRetryTimes": 3,
    "SchedulerRetryInterval": 120000,
    "Status": 0,
    "TablePrivacyMode": 1,
    "Tags": [
      {
        "Key": "Env",
        "Value": "Test"
      }
    ],
    "TenantId": 280749521950784,
    "UseProxyOdpsAccount": true
  },
  "HttpStatusCode": 200,
  "RequestId": "0bc1411515937635973****",
  "Success": true
}

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.

Previous：ListConnectionsNext：ListNodeIO