Queries the information of a DataWorks workspace.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes GetProject

The operation that you want to perform.

ProjectId Long Yes 27

The ID of the DataWorks workspace. You can call the ListProjects operation to query the ID.

RegionId String Yes cn-shanghai

The region ID. For example, the ID of the China (Shanghai) region is cn-shanghai, and that of the China (Zhangjiakou) region is cn-zhangjiakou. The system automatically determines the value of this parameter based on the endpoint used to call the operation.

Response parameters

Parameter Type Example Description
Data Struct

The description of the workspace.

Appkey String 0

This parameter is deprecated.

BaseProject Boolean false

This parameter is deprecated.

DefaultDiResourceGroupIdentifier String group_280749521****

The unique identifier of the default resource group for Data Integration configured for the workspace.

Destination Integer 0

This parameter is deprecated.

DevStorageQuota String 0

This parameter is deprecated.

DevelopmentType Integer 4

This parameter is deprecated.

DisableDevelopment Boolean true

Indicates whether the development engineer role is disabled. Valid values:

0: The development engineer role is enabled.

-1: The development engineer role is disabled.

Default value: 0.

EnvTypes List ["PROD"]

The environment of the workspace. Valid values: PROD and DEV.

  • PROD indicates a production environment. Workspaces in basic mode can run only in a production environment.
  • DEV indicates a development environment. Workspaces in standard mode can run in both a development environment and a production environment.
GmtCreate String Oct 10, 2019 3:42:53 PM

The time when the workspace was created. Example value: Dec 3, 2019 9:12:20 PM.

GmtModified String Dec 3, 2019 9:12:20 PM

The time when the workspace was modified. Example value: Dec 3, 2019 9:12:20 PM.

IsAllowDownload Integer 1

Indicates whether the query result is allowed to be downloaded from DataStudio. Valid values:

  • 1: The query result is allowed to be downloaded from DataStudio.
  • 0: The query result is not allowed to be downloaded from DataStudio.
IsDefault Integer 1

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.
MaxFlowNode Integer 1

This parameter is deprecated.

ProdStorageQuota String 1

This parameter is deprecated.

ProjectDescription String abc

The description of the workspace.

ProjectId Integer 27

The ID of the workspace.

ProjectIdentifier String abc

The unique identifier of the workspace.

ProjectMode Integer 2

The mode in which the workspace runs. Valid values:

  • 2: The workspace is in basic mode.
  • 3: The workspace is in standard mode.
ProjectName String abc

The display name of the workspace.

ProjectOwnerBaseId String 18229311****

The ID of the Alibaba Cloud account used by the workspace owner.

ProtectedMode Integer 1

Indicates whether the workspace protection feature is enabled. Valid values:

  • 1: Workspace protection is enabled.
  • 0: Workspace protection is disabled.
ResidentArea String private

This parameter is deprecated.

SchedulerMaxRetryTimes Integer 3

The default maximum number of automatic reruns that are allowed after an error occurs.

SchedulerRetryInterval Integer 120000

The default interval at which an automatic rerun is performed. Unit: milliseconds. The maximum value of this parameter is 30 minutes. You must pay attention to the conversion between units.

Status Integer 0

The status of the workspace. Valid values:

  • AVAILABLE(0): The workspace is normally running.
  • DELETED(1): The workspace is deleted.
  • INITIALIZING(2): The workspace is being initialized.
  • INIT_FAILED(3): The workspace fails to be initialized.
  • FORBIDDEN(4): The workspace is manually disabled.
  • DELETING(5): The workspace is being deleted.
  • DEL_FAILED(6): The workspace fails to be deleted.
  • FROZEN(7): The workspace is frozen due to overdue payments.
  • UPDATING(8): 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 being initialized.
  • UPDATE_FAILED(9): The workspace fails to be updated.
TablePrivacyMode Integer 1

Indicates whether the MaxCompute tables in the workspace are visible to users within a tenant. Valid values:

  • 0: The MaxCompute tables are invisible to users within a tenant.
  • 1: The MaxCompute tables are visible to users within a tenant.
TenantId Long 280749521

The ID of the tenant.

UseProxyOdpsAccount Boolean true

Indicates whether the MaxCompute compute engine is accessed by using a proxy account.

HttpStatusCode Integer 200

The HTTP status code returned.

RequestId String 0bc1411515937635973****

The ID of the request. You can use the ID to locate logs and troubleshoot issues.

Success Boolean true

Indicates whether the information of the workspace is obtained.

Examples

Sample requests

http(s)://[Endpoint]/?Action=GetProject
&ProjectId=27
&RegionId=cn-shanghai
&<Common request parameters>

Sample success responses

XML format

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

JSON format

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

Error codes

Http status code Error code Error message Description
400 Invalid.Tenant.ConnectionNotExists The connection does not exist. The error message returned because the data source does not exist.
400 Invalid.Tenant.ProjectNotExists The project does not exist. The error message returned because the project does not exist.
403 Invalid.Tenant.UserIsNotProjectOwnerOrAdmin The user is not a project administrator or owner. The error message returned because the user is not the project owner or administrator.
400 Invalid.Tenant.UserNotInProject The user is not in the project. The error message returned because the user is not in the project.
403 Invalid.Tenant.UserNotInTenant The user is not in tenant. The error message returned because the user does not belong to the tenant.

For a list of error codes, visit the API Error Center.