GetProjectDetail - 查询工作空间信息

更新时间:
复制 MD 格式

查询一个DataWorks工作空间的信息。

说明

目前该API接口已标记为弃用,推荐使用替代API:dataworks-public(2020-05-18) - GetProject。

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dataworks:GetProjectDetail

get

Project

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

无 无

请求参数

名称

类型

必填

描述

示例值

ProjectId

integer

是

DataWorks 工作空间的 ID。

27

返回参数

名称

类型

描述

示例值

object

Data

object

工作空间的描述信息。

DefaultDiResourceGroupIdentifier

string

默认节点的数据集成资源组标识。

group_280749521****

DevelopmentType

integer

项目开发类型,目前均为 4。

4

DisableDevelopment

boolean

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

  • false:默认值,开启开发角色。

  • true:禁用开发角色。

true

EnvTypes

array

工作空间包含的环境:简单模式只有生产环境(PROD),标准模式包含开发环境(DEV)和生产环境(PROD)。

string

工作空间包含的环境:简单模式只有生产环境(PROD),标准模式包含开发环境(DEV)和生产环境(PROD)。

["PROD"]

GmtCreate

string

创建工作空间的时间。

Oct 10, 2019 3:42:53 PM

GmtModified

string

修改工作空间的时间。

Dec 3, 2019 9:12:20 PM

IsAllowDownload

integer

是否允许下载。

1

IsDefault

integer

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

  • 1,是。

  • 0,否。

1

ProjectDescription

string

工作空间的描述。

abc

ProjectId

integer

工作空间的 ID。

27

ProjectIdentifier

string

工作空间的标识。

abc

ProjectMode

integer

工作空间模式:简单工作空间模式为 2,标准工作空间模式为 3。

1

ProjectName

string

工作空间的显示名称。

abc

ProjectOwnerBaseId

string

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

18229311****

ProtectedMode

integer

工作空间是否开启了保护模式。

1

ResidentArea

string

工作空间的类型:private 为私有区,swap 为交换区。

private

ResourceManagerResourceGroupId

string

资源组 ID。

rg-acfmzbn7pti3zfa

SchedulerMaxRetryTimes

integer

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

3

SchedulerRetryInterval

integer

默认出错自动重跑的时间间隔。

120000

Status

integer

工作空间的状态。

0

TablePrivacyMode

integer

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

  • 0,租户内用户不可见 MaxCompute 表。

  • 1,租户内用户可见 MaxCompute 表。

1

Tags

array<object>

标签信息。

object

标签信息。

Key

string

标签键。

Env

Value

string

标签值。

Test

TenantId

integer

租户 ID。

280749521950784

UseProxyOdpsAccount

boolean

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

true

HttpStatusCode

integer

HTTP 状态码。

200

RequestId

string

请求 ID。

0bc1411515937635973****

Success

boolean

是否成功查询工作空间的信息。

true

示例

正常返回示例

JSON格式

{
  "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
}

错误码

HTTP status code

错误码

错误信息

描述

400 Invalid.Tenant.ConnectionNotExists The connection does not exist. 数据源不存在。
400 Invalid.Tenant.ProjectNotExists The project does not exist. 项目不存在。
400 Invalid.Tenant.UserNotInProject The user is not in the project. 用户不在项目中。
403 Invalid.Tenant.UserIsNotProjectOwnerOrAdmin The user is not a project administrator or owner. 用户不是项目负责人或者项目管理员。
403 Invalid.Tenant.UserNotInTenant The user is not in tenant. 用户不在租户中。

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

变更历史

更多信息,参考变更详情。