Updated on 2025-09-15 GMT+08:00

Querying the Workspace List

Function

This API is used to list workspaces. You can use this API to obtain a list of workspaces that meet the filter criteria. The API supports pagination queries and queries by name, ID, and enterprise project ID. A list of workspaces that meet the filter criteria is returned. This API is synchronous with no accompanying APIs or specific scenarios.

URI

GET /v1/workspaces

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Definition: Offset where a query starts.

Constraints: N/A.

Range: [0, 1000000000].

Default Value: 0

limit

No

Integer

Definition: Maximum number of records returned on each page.

Constraints: N/A.

Range: [1, 100].

Default Value: 10.

name

No

String

Definition: Workspace name.

Constraints: N/A.

Range: 4 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.

Default Value: N/A.

id

No

String

Definition: Workspace ID. For how to obtain a workspace ID, see [Obtaining a Workspace ID] (dataartsfabric_03_0022.xml).

Constraints: N/A.

Range: 1 to 36 characters. Only letters, digits, and hyphens (-) are allowed.

Default Value: N/A.

enterprise_project_id

Yes

String

Definition: Enterprise project ID. For how to obtain an enterprise project ID, see [Obtaining an Enterprise Project ID] (dataartsfabric_03_0027.xml).

Constraints: 1 to 36 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.

Range: N/A.

Default Value: all_granted_eps.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

Definition: Tenant token. It is used for API calling authentication. For how to obtain a token, see [Authentication] (dataartsfabric_03_0005.xml).

Constraints: N/A.

Range: Up to 65,534 characters.

Default Value: N/A.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

total

Integer

Definition: Total number of workspaces.

Constraints: N/A.

Range: N/A.

Default Value: N/A.

workspaces

Array of Workspace objects

Definition: Workspace list.

Constraints: [0,1000].

Table 4 Workspace

Parameter

Type

Description

id

String

Definition: Workspace ID.

Constraints: N/A.

Range: 1 to 36 characters. Only letters, digits, and hyphens (-) are allowed.

Default Value: N/A.

name

String

Definition: Workspace name.

Constraints: N/A.

Range: 4 to 32 characters. Only letters, digits, and hyphens (-) are allowed.

Default Value: N/A.

description

String

Definition: Description entered by a user.

Constraints: N/A.

Range: 0 to 255 characters.

Default Value: N/A.

create_time

String

Definition: Creation time.

Constraints: N/A.

Range: N/A.

Default Value: N/A.

create_domain_name

String

Definition: Account name.

Constraints: N/A.

Range: N/A.

Default Value: N/A.

create_user_name

String

Definition: Username.

Constraints: N/A.

Range: N/A.

Default Value: N/A.

metastore_id

String

Definition: Instance ID of LakeFormation, that is, MetaStore ID.

Constraints: N/A.

Range: 32 to 36 characters. Only letters, digits, and hyphens (-) are allowed.

Default Value: N/A.

access_url

String

Definition: Resource access address.

Constraints: N/A.

Range: N/A.

Default Value: N/A.

enterprise_project_id

String

Definition: Enterprise project ID. For how to obtain an enterprise project ID, see [Obtaining an Enterprise Project ID] (dataartsfabric_03_0027.xml).

Constraints: This parameter can be set only when an enterprise project is connected.

Range: 1 to 64 characters. Only letters, digits, and hyphens (-) are allowed.

Default Value: 0, meaning the default ID is used.

tags

Array of ResourceTag objects

Definition: Resource tag of a workspace.

Constraints: N/A.

Table 5 ResourceTag

Parameter

Type

Description

key

String

Definition: Resource tag key. For details about how to obtain a tag key, see "API Description" > "Resource Tags" > "Querying Tag Keys" in Tag Management Service API Reference.

Constraints: N/A.

Range: 1 to 128 characters. Only letters, spaces, tabs, digits, underscores (_), periods (.), colons (:), backslashes (), equal signs (=), plus signs (+), minus signs (-), and at signs (@) are allowed.

Default Value: N/A.

value

String

Definition: Resource tag value.

Constraints: N/A.

Range: 0 to 255 characters. Only letters, spaces, tabs, digits, underscores (_), periods (.), colons (:), backslashes (), equal signs (=), plus signs (+), minus signs (-), and at signs (@) are allowed.

Default Value: N/A.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Definition: Error code.

Constraints: N/A.

Range: 8 to 36 characters.

Default Value: N/A.

error_msg

String

Definition: Error message.

Constraints: N/A.

Range: 2 to 512 characters.

Default Value: N/A.

solution_msg

String

Definition: Solution description.

Constraints: N/A.

Range: 0 to 4,096 characters.

Default Value: N/A.

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Definition: Error code.

Constraints: N/A.

Range: 8 to 36 characters.

Default Value: N/A.

error_msg

String

Definition: Error message.

Constraints: N/A.

Range: 2 to 512 characters.

Default Value: N/A.

solution_msg

String

Definition: Solution description.

Constraints: N/A.

Range: 0 to 4,096 characters.

Default Value: N/A.

Status code: 404

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Definition: Error code.

Constraints: N/A.

Range: 8 to 36 characters.

Default Value: N/A.

error_msg

String

Definition: Error message.

Constraints: N/A.

Range: 2 to 512 characters.

Default Value: N/A.

solution_msg

String

Definition: Solution description.

Constraints: N/A.

Range: 0 to 4,096 characters.

Default Value: N/A.

Status code: 408

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Definition: Error code.

Constraints: N/A.

Range: 8 to 36 characters.

Default Value: N/A.

error_msg

String

Definition: Error message.

Constraints: N/A.

Range: 2 to 512 characters.

Default Value: N/A.

solution_msg

String

Definition: Solution description.

Constraints: N/A.

Range: 0 to 4,096 characters.

Default Value: N/A.

Status code: 500

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Definition: Error code.

Constraints: N/A.

Range: 8 to 36 characters.

Default Value: N/A.

error_msg

String

Definition: Error message.

Constraints: N/A.

Range: 2 to 512 characters.

Default Value: N/A.

solution_msg

String

Definition: Solution description.

Constraints: N/A.

Range: 0 to 4,096 characters.

Default Value: N/A.

Example Requests

GET https://{endpoint}/v1/workspaces

Example Responses

Status code: 200

The workspace list is queried.

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

Status code: 400

BadRequest

{
  "error_code" : "common.01000001",
  "error_msg" : "failed to read http request, please check your input, code: 400, reason: Type mismatch., cause: TypeMismatchException"
}

Status code: 401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

Status code: 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"
}

Status code: 404

NotFound

{
  "error_code" : "common.01000001",
  "error_msg" : "response status exception, code: 404"
}

Status code: 408

Request Time-out

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

Status code: 500

InternalServerError

{
  "error_code" : "common.00000500",
  "error_msg" : "internal error"
}

Status Codes

Status Code

Description

200

The workspace list is queried.

400

BadRequest

401

Unauthorized

403

Forbidden

404

NotFound

408

Request Time-out

500

InternalServerError

Error Codes

See Error Codes.