文档首页/ 智能数据湖 AIDataLake/ API参考/ 工作空间管理/ 查询工作空间详细信息 - ShowV2Workspace
更新时间:2026-07-13 GMT+08:00
分享

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

功能介绍

查询工作空间详细信息。用户可通过该接口查询某工作空间详情,输入为工作空间ID,返回对应工作空间详情。此接口为同步接口,无配套使用接口和特殊场景。

调用方法

请参见如何调用API

URI

GET /v2/workspaces/{workspace_id}

表1 路径参数

参数

是否必选

参数类型

描述

workspace_id

String

参数解释:工作空间ID。

约束限制:不涉及。

取值范围:长度为32~36的英文字符、数字和中划线的组合。

默认取值:不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:用户Token。

约束限制:不涉及。

取值范围:长度不超过65534个字符。

默认取值:不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

id

String

参数解释:工作空间ID。

取值范围:长度为1~36的英文字母、数字和中划线的组合。

name

String

参数解释:工作空间名称。

取值范围:长度为4~32的英文字母、数字、下划线和中划线的组合。

description

String

参数解释:用户输入的描述。

取值范围:长度为0~255个中文字符、英文字母、数字和特殊字符的组合。

create_time

String

参数解释:资源创建时间。

取值范围:ISO 8601格式,yyyy-MM-dd'T'HH:mm:ss.SSSZ,UTC时间。

create_domain_name

String

参数解释:创建账号名称。

取值范围:长度为0~64个英文字母、数字、下划线和中划线的组合。

create_user_name

String

参数解释:创建用户名称。

取值范围:长度为0~64个英文字母、数字、下划线和中划线的组合。

metastore_id

String

参数解释:LakeFormation服务的实例ID。

取值范围:长度为32~36的英文字母、数字和中划线的组合。

enterprise_project_id

String

参数解释:企业项目ID。

取值范围:长度为0~128的英文字符、数字、中划线和下划线的组合。

tags

Array of ResourceTag objects

参数解释:工作空间的资源标签。

表4 ResourceTag

参数

参数类型

描述

key

String

参数解释:资源标签的键。

约束限制:不涉及。

取值范围:长度1~128的多语言字母、空格、数字、下划线、点、冒号、斜杠、等号、加号、减号、@符号组合。

默认取值:不涉及。

value

String

参数解释:资源标签的值。

约束限制:不涉及。

取值范围:长度0~255的多语言字母、空格、数字、下划线、点、冒号、斜杠、等号、加号、减号、@符号组合。

默认取值:不涉及。

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:错误码。

取值范围:长度为8~36个字符。

error_msg

String

参数解释:错误描述。

取值范围:长度为2~512个字符。

solution_msg

String

参数解释:解决方案。

取值范围:长度为0~4096个字符。

状态码:401

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:错误码。

取值范围:长度为8~36个字符。

error_msg

String

参数解释:错误描述。

取值范围:长度为2~512个字符。

solution_msg

String

参数解释:解决方案。

取值范围:长度为0~4096个字符。

状态码:403

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:错误码。

取值范围:长度为8~36个字符。

error_msg

String

参数解释:错误描述。

取值范围:长度为2~512个字符。

solution_msg

String

参数解释:解决方案。

取值范围:长度为0~4096个字符。

状态码:404

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:错误码。

取值范围:长度为8~36个字符。

error_msg

String

参数解释:错误描述。

取值范围:长度为2~512个字符。

solution_msg

String

参数解释:解决方案。

取值范围:长度为0~4096个字符。

状态码:408

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:错误码。

取值范围:长度为8~36个字符。

error_msg

String

参数解释:错误描述。

取值范围:长度为2~512个字符。

solution_msg

String

参数解释:解决方案描述。

取值范围:长度为0~4096个字符。

状态码:500

表10 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:错误码。

取值范围:长度为8~36个字符。

error_msg

String

参数解释:错误描述。

取值范围:长度为2~512个字符。

solution_msg

String

参数解释:解决方案。

取值范围:长度为0~4096个字符。

请求示例

查询指定工作空间ID对应的详细信息。

GET /v2/workspaces/{workspace_id}

响应示例

状态码:200

请求成功。

{
  "id" : "61ff9cae-2e9e-46b5-9bcc-fc4e199c83be",
  "name" : "liuzeyuan-pool",
  "description" : "",
  "create_time" : "2026-06-22T08:27:32.000+00:00",
  "create_domain_name" : "test_domain",
  "create_user_name" : "test_user",
  "metastore_id" : "99543e6a-1df6-4bd9-8696-1a2f185f0968",
  "enterprise_project_id" : "0",
  "tags" : [ ]
}

状态码:400

请求参数错误。

{
  "error_code" : "AIDataLake.00010011",
  "error_msg" : "Invalid specification code.",
  "solution_msg" : "Enter a correct specification code."
}

状态码:401

未授权。

{
  "error_code" : "APIGW.0301",
  "error_msg" : "Incorrect IAM authentication information decrypt token fail"
}

状态码:403

禁止访问。

{
  "error_code" : "AIDataLake.00010038",
  "error_msg" : "Unauthorized requests.",
  "solution_msg" : "Check permissions {xxx} and retry after authorization."
}

状态码:404

资源未找到。

{
  "error_code" : "AIDataLake.00010004",
  "error_msg" : "Not Found",
  "solution_msg" : "Please check the resource ID and try again"
}

状态码:408

请求超时。

{
  "error_code" : "common.00000408",
  "error_msg" : "timeout exception occurred"
}

状态码:500

内部服务器错误。

{
  "error_code" : "AIDataLake.00010067",
  "error_msg" : "Failed to initialize the task because the number of tasks may have reached the upper limit.",
  "solution_msg" : "Try again later."
}

状态码

状态码

描述

200

请求成功。

400

请求参数错误。

401

未授权。

403

禁止访问。

404

资源未找到。

408

请求超时。

500

内部服务器错误。

相关文档