文档

GetProject - 查询工作空间详细信息

更新时间:

该接口用于查询一个DataWorks工作空间的详细信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
ProjectIdlong

DataWorks 工作空间 ID。 您可以通过 ListProjects 接口获取工作空间 ID。

466230
ProjectIdentifierstring

DataWorks 工作空间的名称。您可以通过 ListProjects 接口获取工作空间的名称。

test_project

返回参数

名称类型描述示例值
object

返回结果。

HttpStatusCodeinteger

请求返回码。

200
RequestIdstring

请求 ID。

1AFAE64E-D1BE-432B-A9****
Successboolean

请求是否成功,取值如下:

  • true:请求成功。
  • false:请求失败。
true
Dataobject

工作空间的详细信息。

Statusinteger

工作空间的状态,取值如下:

  • 0:AVAILABLE,工作空间运行正常。
  • 1:DELETED,工作空间已被删除。
  • 2:INITIALIZING,初始化工作空间。
  • 3:INIT_FAILED,工作空间初始化失败。
  • 4:FORBIDDEN,手动禁用工作空间。
  • 5:DELETING,正在删除工作空间。
  • 6:DEL_FAILED,工作空间删除失败。
  • 7:FROZEN,工作空间欠费冻结。
  • 8:UPDATING,更新工作空间(为工作空间添加并初始化计算引擎)。
  • 9:UPDATE_FAILED,更新工作空间(为工作空间添加并初始化计算引擎)失败。
0
MaxFlowNodeinteger

该参数已废弃。

1
ProjectIdinteger

工作空间的 ID。

466230
IsAllowDownloadinteger

是否允许下载 ide 上查询的结果,取值如下:

  • 1:允许下载。
  • 0:不允许下载。
1
ProjectModeinteger

工作空间的模式,取值如下:

  • 2:表示简单工作空间模式。
  • 3:表示标准工作空间模式。
2
GmtModifiedstring

修改工作空间的时间,示例格式为Dec 3, 2019 9:12:20 PM

Dec 3, 2019 9:12:20 PM
ProdStorageQuotastring

该参数已废弃。

1
ProjectDescriptionstring

工作空间的详细描述信息。

test_describe
DevelopmentTypeinteger

该参数已废弃。

4
TablePrivacyModeinteger

MaxCompute 表的可见性权限,取值如下:

  • 0:租户内用户不可见 MaxCompute 表。
  • 1:租户内用户可见 MaxCompute 表。
1
DefaultDiResourceGroupIdentifierstring

购买 MaxCompute 独享资源组时,默认分配的资源组的标识。

group_280749521****
SchedulerMaxRetryTimesinteger

默认出错自动重跑的次数。

3
ProtectedModeinteger

工作空间是否开启了保护模式,取值如下:

  • 1:开启保护模式。
  • 0:未开启保护模式。
1
SchedulerRetryIntervalinteger

默认出错自动重跑的时间间隔,单位为 ms。取值最大为 30 分钟,注意单位转换。

120000
Appkeystring

该参数已废弃。

0
DevStorageQuotastring

该参数已废弃。

0
ResidentAreastring

工作空间的类型。

  • private:私有区
  • swap:交换区。
private
IsDefaultinteger

是否为默认工作空间,取值如下:

  • 1:是。
  • 0:否。
1
Destinationinteger

该参数已废弃。

0
ProjectNamestring

工作空间的显示名称。

test_project
ProjectIdentifierstring

工作空间的名称。

test_project
DisableDevelopmentboolean

是否禁用开发角色,取值如下:

  • false:默认值,开启开发角色。
  • true:禁用开发角色。
true
ProjectOwnerBaseIdstring

工作空间所有者的阿里云 ID。

18229311****
BaseProjectboolean

该参数已废弃。

false
UseProxyOdpsAccountboolean

访问 MaxCompute 引擎是否使用代理账号。

true
GmtCreatestring

创建工作空间时间,示例格式Dec 3, 2019 9:12:20 PM

Oct 10, 2019 3:42:53 PM
TenantIdlong

租户 ID。

280749521
EnvTypesarray

工作空间包含的环境信息。

string

工作空间包含的环境:

  • 简单模式只有生产环境(PROD)。
  • 标准模式包含开发环境(DEV)和生产环境(PROD)。
["PROD"]
ResourceManagerResourceGroupIdstring

资源组 ID。

rg-acfmzbn7****
Tagsarray<object>

工作空间绑定的标签信息列表。

object

标签信息详情。

Keystring

标签键。

key
Valuestring

标签值。

value

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400Invalid.Tenant.ProjectNotExistsThe project does not exist.项目不存在。
400Invalid.Tenant.UserNotInProjectThe user is not in the project.用户不在项目中。
403Invalid.Tenant.UserIsNotProjectOwnerOrAdminThe user is not a project administrator or owner.用户不是项目负责人或者项目管理员。
403Invalid.Tenant.UserNotInTenantThe user is not in tenant.用户不在租户中。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-09-19OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情
2022-11-07OpenAPI 错误码发生变更查看变更详情
2022-10-31OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情