# 查询工作空间列表 - ListWorkspaces
#### 功能介绍
列举工作空间列表。用户可通过该接口获取符合过滤条件的工作空间列表，接口支持分页查询、支持通过名称、ID和企业项目ID查询。返回为符合过滤条件的工作空间列表。此接口为同步接口，无配套使用接口和特殊场景。
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/DataArtsFabric/doc?api=ListWorkspaces)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-fabric/dataartsfabric_03_0014.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                           | 访问级别 | 资源类型（\*为必须）  | 条件键 | 别名 | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | DataArtsFabric:workspace:list | List | workspace \* | -   | -  | -      |
     
#### URI
GET /v1/workspaces
表1Query参数 
| 参数                    | 是否必选 | 参数类型    | 描述                                                                                                                                                                                                  |
|:---|:---|:---|:---|
| offset                | 否    | Integer | **参数解释**：偏移量，表示从此偏移量开始查询。 **约束限制**：不涉及。 **取值范围**：\[0,1000000000\]。 **默认取值**：0。                                                                                                                      |
| limit                 | 否    | Integer | **参数解释**：指定每一页返回的最大条目数。 **约束限制**：不涉及。 **取值范围**：\[1,100\]。 **默认取值**：10。                                                                                                                              |
| name                  | 否    | String  | **参数解释**：工作空间名称。 **约束限制**：不涉及。 **取值范围**：长度为\[4,32\]的字母、数字、中划线(-)和下划线(_)的组合。 **默认取值**：不涉及。                                                                                                           |
| id                    | 否    | String  | **参数解释** ：工作空间ID，获取方法，请参见[获取工作空间ID](https://support.huaweicloud.com/api-fabric/dataartsfabric_03_0022.html)。 **约束限制**：不涉及。 **取值范围**：长度为\[1,36\]的英文字符、数字和中划线(-)的组合。 **默认取值**：不涉及。                    |
| enterprise_project_id | 是    | String  | **参数解释** ：企业项目ID。获取方法，请参见[获取企业项目ID](https://support.huaweicloud.com/api-fabric/dataartsfabric_03_0027.html)。 **约束限制**：长度为\[1,36\]的英文字符、数字、中划线(-)和下划线(_)的组合。 **取值范围**：不涉及。 **默认取值**：all_granted_eps。 |
#### 请求参数
表2请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                                      |
|:---|:---|:---|:---|
| X-Auth-Token | 否    | String | **参数解释** ：租户Token。用于调用接口的认证。获取方法，请参见[认证鉴权](https://support.huaweicloud.com/api-fabric/dataartsfabric_03_0005.html)。 **约束限制**：不涉及。 **取值范围**：长度不超过65534个字符。 **默认取值**：不涉及。 |
   
#### 响应参数
**状态码：200**
表3响应Body参数 
| 参数         | 参数类型                                                                            | 描述                                                              |
|:---|:---|:---|
| total      | Integer                                                                         | **参数解释**：Workspace总数。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 |
| workspaces | Array of [Workspace] objects | **参数解释**：Workspace列表。 **约束限制**：\[0,1000\]。                      |
   
 表4Workspace 
| 参数                    | 参数类型                                                                                | 描述                                                                                                                                                                                                 |
|:---|:---|:---|
| id                    | String                                                                              | **参数解释**：工作空间ID。 **约束限制**：不涉及。 **取值范围**：长度为\[1,36\]的英文字符、数字和中划线(-)的组合。 **默认取值**：不涉及。                                                                                                               |
| name                  | String                                                                              | **参数解释**：工作空间名称。 **约束限制**：不涉及。 **取值范围**：长度为\[4,32\]的英文字符、数字和中划线(-)的组合。 **默认取值**：不涉及。                                                                                                               |
| description           | String                                                                              | **参数解释**：用户输入的描述。 **约束限制**：不涉及。 **取值范围**：长度为\[0,255\]个字符。 **默认取值**：不涉及。                                                                                                                            |
| create_time           | String                                                                              | **参数解释**：创建时间。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。                                                                                                                                           |
| create_domain_name    | String                                                                              | **参数解释**：创建账号名称。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。                                                                                                                                         |
| create_user_name      | String                                                                              | **参数解释**：创建用户名称。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。                                                                                                                                         |
| metastore_id          | String                                                                              | **参数解释**：LakeFormation服务的实例ID，即MetaStoreID。 **约束限制**：不涉及。 **取值范围**：长度为\[32,36\]的字母、数字、中划线(-)组合。 **默认取值**：不涉及。                                                                                      |
| access_url            | String                                                                              | **参数解释**：访问资源地址。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。                                                                                                                                         |
| enterprise_project_id | String                                                                              | **参数解释** ：企业项目ID。获取方法，请参见[获取企业项目ID](https://support.huaweicloud.com/api-fabric/dataartsfabric_03_0027.html)。 **约束限制**：只有对接了企业项目才可以填写。 **取值范围**：长度为\[1,64\]的英文字符、数字和中划线(-)的组合。 **默认取值**：0，即default。 |
| tags                  | Array of [ResourceTag] objects | **参数解释**：工作空间的资源标签。 **约束限制**：不涉及。                                                                                                                                                                  |
   
 表5ResourceTag 
| 参数    | 参数类型   | 描述                                                                                                                                                                                                     |
|:---|:---|:---|
| key   | String | **参数解释**：资源标签的键。 **约束限制**：不涉及。 **取值范围** ：长度1到128的多语言字母、空格、制表符、数字、下划线(_)、点(.)、冒号(:)、斜杠()、等号(=)、加号(+)、减号(-)、@符号(@)组合，见[查询标签键列表](https://support.huaweicloud.com/api-tms/ListTagKeys.html)。 **默认取值**：不涉及。 |
| 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\]个字符。 **默认取值**：不涉及。 |
   
**状态码：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\]个字符。 **默认取值**：不涉及。 |
   
#### 请求示例
```
GET https://{endpoint}/v1/workspaces
```
#### 响应示例
**状态码：200**
查询工作空间列表响应体。
```
{
  "total" : 2,
  "workspaces" : [ {
    "id" : "90a827a1-ca72-4be8-943b-774f94xxxxxx",
    "name" : "workspace1SqlResourceDef",
    "create_time" : "2025-01-10T03:37:12.000+00:00",
    "create_domain_name" : "create_domain_name_001",
    "create_user_name" : "create_user_name_001",
    "enterprise_project_id" : 0
  }, {
    "id" : "90a827a1-ca72-4be8-943b-774f95xxxxxx",
    "name" : "workspace2",
    "create_time" : "2025-01-11T03:37:12.000+00:00",
    "create_domain_name" : "create_domain_name_002",
    "create_user_name" : "create_user_name_002",
    "enterprise_project_id" : 0
  } ]
}
```
**状态码：400**
BadRequest
```
{
  "error_code" : "common.01000001",
  "error_msg" : "failed to read http request, please check your input, code: 400, reason: Type mismatch., cause: TypeMismatchException"
}
```
**状态码：401**
Unauthorized
```
{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}
```
**状态码：403**
Forbidden
```
{
  "error" : {
    "code" : "403",
    "message" : "X-Auth-Token is invalid in the request",
    "title" : "Forbidden"
  },
  "error_code" : 403,
  "error_msg" : "X-Auth-Token is invalid in the request",
  "title" : "Forbidden"
}
```
**状态码：404**
NotFound
```
{
  "error_code" : "common.01000001",
  "error_msg" : "response status exception, code: 404"
}
```
**状态码：408**
Request Time-out
```
{
  "error_code" : "common.00000408",
  "error_msg" : "timeout exception occurred"
}
```
**状态码：500**
InternalServerError
```
{
  "error_code" : "common.00000500",
  "error_msg" : "internal error"
}
```
#### 状态码
| 状态码 | 描述                  |
|:---|:---|
| 200 | 查询工作空间列表响应体。        |
| 400 | BadRequest          |
| 401 | Unauthorized        |
| 403 | Forbidden           |
| 404 | NotFound            |
| 408 | Request Time-out    |
| 500 | InternalServerError |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-fabric/dataartsfabric_03_0028.html)。