GetProject - 获取工作空间详情 - 大数据开发治理平台 DataWorks

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

接口说明

需要购买 DataWorks 基础版及以上版本才能使用。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
dataworks:GetProject	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
Id	long	是	DataWorks 工作空间的 ID。您可以登录 DataWorks 控制台，进入工作空间管理页面获取 ID。该参数用来确定本次 API 调用操作使用的 DataWorks 工作空间。	123456

返回参数

名称	类型	描述	示例值
	object	返回结果。
RequestId	string	请求的 ID，用于定位日志，排查问题。	22C97E95-F023-56B5-8852-B1A77A17XXXX
Project	object	工作空间详细信息。
Id	long	工作空间 ID。	28477242
Name	string	工作空间名称。	sora_finance
DisplayName	string	工作空间展示名称。	Sora金融分析
Description	string	工作空间描述。	金融分析组项目数据开发
Owner	string	工作空间拥有者 UserId，即阿里云账号 ID。	207947397706614299
AliyunResourceGroupId	string	工作空间所属阿里云资源组 ID。	rg-acfmzbn7pti3zfa
Status	string	空间状态： Available：工作空间运行正常 Initializing：初始化工作空间 InitFailed：工作空间初始化失败 Forbidden：手动禁用工作空间 Deleting：正在删除工作空间 DeleteFailed：工作空间删除失败 Frozen：工作空间欠费冻结 Updating：更新工作空间中 UpdateFailed：更新工作空间失败	Available
PaiTaskEnabled	boolean	是否启用 PAI 任务调度： true 可以在 DataWorks 工作空间创建机器学习（PAI）节点，并按照节点配置进行周期性调度运行。 false 禁用 PAI 任务调度。	true
DevEnvironmentEnabled	boolean	是否启用开发环境： true 工作空间启用开发环境，支持开发与生产环境隔离。 false 仅使用生产环境。	true
DevRoleDisabled	boolean	是否禁用开发角色： false，开启开发角色 true，禁用开发角色	false
AliyunResourceTags	array<object>	标签组。
tags	object	标签详情。
Key	string	标签键。	batch
Value	string	标签值。	blue

示例

正常返回示例

JSON格式

{
  "RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX\n",
  "Project": {
    "Id": 28477242,
    "Name": "sora_finance",
    "DisplayName": "Sora金融分析",
    "Description": "金融分析组项目数据开发",
    "Owner": "207947397706614299",
    "AliyunResourceGroupId": "rg-acfmzbn7pti3zfa",
    "Status": "Available",
    "PaiTaskEnabled": true,
    "DevEnvironmentEnabled": true,
    "DevRoleDisabled": false,
    "AliyunResourceTags": [
      {
        "Key": "batch",
        "Value": "blue"
      }
    ]
  }
}

错误码

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