文档首页/ 智能数据湖 AI DataLake/ API参考/ 工作空间管理/ 查询工作空间列表 - ListV2Workspaces
更新时间：2026-10-10 GMT+08:00
查看PDF
分享

查询工作空间列表 - ListV2Workspaces

功能介绍

查询工作空间列表。此接口为同步接口。

调用方法

请参见如何调用API。

URI

GET /v2/workspaces

表1 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

否

String

参数解释：企业项目ID，获取方法，请参见获取企业项目ID。

约束限制：不涉及。

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

默认取值：all_granted_eps。

offset

否

Integer

参数解释：分页偏移量。

约束限制：不涉及。

取值范围：0~10000。

默认取值：0。

limit

否

Integer

参数解释：分页大小。

约束限制：不涉及。

取值范围：1~1000。

默认取值：100。

name

否

String

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

约束限制：不涉及。

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

默认取值：不涉及。

id

否

String

参数解释：工作空间ID，可通过查询工作空间列表获取工作空间ID。

约束限制：不涉及。

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

默认取值：不涉及。

tags

否

Array of strings

参数解释：标签过滤条件，支持多个标签。格式为 key#value1,value2，用英文逗号分隔多个值。

约束限制：最多10个标签。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：用户Token，通过调用获取IAM用户Token接口获取。

约束限制：不涉及。

取值范围：只能由英文字母、数字及特殊字符组成，长度不超过65534个字符。Token格式由IAM服务定义，具体字符集参见IAM服务相关文档。

默认取值：不涉及。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

total

Integer

参数解释：总记录数。

取值范围：不涉及。

workspaces

Array of Workspace objects

参数解释：工作空间列表，每个元素为一个Workspace对象，包含工作空间ID、名称、描述、创建时间等信息。
表4 Workspace

参数

参数类型

描述

id

String

参数解释：工作空间ID。

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

name

String

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

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

description

String

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

取值范围：不允许输入感叹号、小于号、大于号、等号、与号、双引号、单引号、艾特符、井号、百分号、分号、左括号、右括号、竖线、星号、反斜杠。长度为0~255个字符。

create_time

String

参数解释：资源创建时间，使用UTC时间，ISO 8601格式，yyyy-MM-dd'T'HH:mm:ss.SSSXXX，例如：2025-01-10T03:37:12.000+00:00。

取值范围：不涉及。

create_domain_name

String

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

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

create_user_name

String

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

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

metastore_id

String

参数解释：LakeFormation服务的实例ID，可在LakeFormation控制台实例列表中查看，或通过调用LakeFormation服务的查询实例列表接口获取。

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

enterprise_project_id

String

参数解释：企业项目ID。

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

tags

Array of ResourceTag objects

参数解释：工作空间的资源标签，每个元素为一个ResourceTag对象，包含key（标签键）和value（标签值）字段。
表5 ResourceTag

参数

参数类型

描述

key

String

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

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

value

String

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

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

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

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

error_msg

String

参数解释：错误描述。

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

solution_msg

String

参数解释：解决方案。

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

状态码：401

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

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

error_msg

String

参数解释：错误描述。

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

solution_msg

String

参数解释：解决方案。

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

状态码：403

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

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

error_msg

String

参数解释：错误描述。

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

solution_msg

String

参数解释：解决方案。

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

状态码：404

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

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

error_msg

String

参数解释：错误描述。

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

solution_msg

String

参数解释：解决方案。

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

状态码：408

表10 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

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

error_msg

String

参数解释：错误描述。

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

solution_msg

String

参数解释：解决方案。

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

状态码：500

表11 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

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

error_msg

String

参数解释：错误描述。

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

solution_msg

String

参数解释：解决方案。

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

请求示例

查询工作空间列表。

GET /v2/workspaces

响应示例

状态码：200

{
  "total" : 3,
  "workspaces" : [ {
    "id" : "6ccab7b6-fe3a-41b6-a215-be37323bd254",
    "name" : "AIDataLake-Test-Workspace",
    "description" : "AI DataLake测试工作空间",
    "create_time" : "2026-06-23T12:51:21.000+00:00",
    "create_domain_name" : "test_domain",
    "create_user_name" : "test_user",
    "metastore_id" : "0ba8919e-f52c-437f-a590-9ad7ecdb5ed9",
    "enterprise_project_id" : "0",
    "tags" : [ {
      "key" : "environment",
      "value" : "test"
    }, {
      "key" : "creator",
      "value" : "postman-script"
    }, {
      "key" : "purpose",
      "value" : "automation-testing"
    } ]
  }, {
    "id" : "61ff9cae-2e9e-46b5-9bcc-fc4e199c83be",
    "name" : "test-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" : [ ]
  }, {
    "id" : "e89e105f-3aab-42c9-8fec-da1d2512a7a8",
    "name" : "AutoTest",
    "description" : "计费自动化测试使用",
    "create_time" : "2026-05-14T08:53:45.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.00010151",
  "error_msg" : "Parameter value is invalid.",
  "solution_msg" : "Please input valid parameter value."
}

状态码：401

{
  "error_code" : "APIGW.0301",
  "error_msg" : "Incorrect IAM authentication information: decrypt token fail.",
  "solution_msg" : "Check whether the IAM authentication information is correct."
}

状态码：403

{
  "error_code" : "AIDataLake.00010150",
  "error_msg" : "The operation is not allowed.",
  "solution_msg" : "Check whether the operation is allowed in the current status."
}

状态码：404

{
  "error_code" : "AIDataLake.00010009",
  "error_msg" : "No resources found.",
  "solution_msg" : "Ensure the requested resource exists and the parameters are correct."
}

状态码：408

{
  "error_code" : "common.00000408",
  "error_msg" : "timeout exception occurred",
  "solution_msg" : "Try again later. If the problem persists, contact technical support."
}

状态码：500

{
  "error_code" : "AIDataLake.00011001",
  "error_msg" : "Internal error.",
  "solution_msg" : "Contact technical support or try again later."
}

状态码

状态码

描述

200

请求成功。

400

请求参数错误。

401

未授权。

403

禁止访问。

404

资源未找到。

408

请求超时。

500

内部服务器错误。
父主题： 工作空间管理

相关文档