Obtaining the Workspace List

This API is used to obtain the workspace list.

For details, see Calling APIs.

GET /v1/{project_id}/workspaces/{instance_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see Project ID and Account ID.
instance_id	Yes	String	DataArts Studio instance ID. For details about how to obtain the instance ID, see Instance ID and Workspace ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Maximum number of data connections that can be queried each time. The default value is 20.
offset	No	Integer	Pagination offset. The default value is 0.

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. This parameter is mandatory for token authentication. Call the "Obtaining the User Token" API of IAM to obtain the value of X-Subject-Token in the response header.

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
count	Integer	Number of users in the current workspace
total_page	Integer	Number of pages for the query result
data	Array of Workspacebody objects	Workspace list

**Table 5** Workspacebody
Parameter	Type	Description
bad_record_location_name	String	OBS path for storing dirty data
description	String	Workspace description
eps_id	String	Enterprise project ID. For details about how to obtain the enterprise project ID, see Project ID and Account ID.
job_log_location_name	String	OBS path for job logs
name	String	Workspace name
id	String	Workspace ID. For details about how to obtain the workspace ID, see Instance ID and Workspace ID.
is_default	Integer	Whether the workspace is the default workspace. Value 0 indicates a private workspace, 1 indicates a default workspace, and 2 indicates a public workspace.
owner_name	String	Creator username
project_id	String	Project ID. For details about how to obtain the project ID, see Project ID and Account ID.
domain_id	String	Domain ID. You can obtain it from the user information on IAM.
instance_id	String	DataArts Studio instance ID. For details about how to obtain the instance ID, see Instance ID and Workspace ID.
create_time	Number	Creation time
create_user	String	Creator username
member_num	Integer	Number of members in the current workspace
update_time	Number	Update time
update_user	String	User who updated the workspace

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_msg	String	Returned error information.
error_code	String	Returned error code.

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_msg	String	Returned error information.
error_code	String	Returned error code.

None

Status code: 400

Bad request.

{
  "error_code" : "DAYU.4402",
  "error_msg" : "The operation failed, detail msg {0}."
}

Status code: 500

Internal server error.

{
  "error_code" : "DAYU.3531",
  "error_msg" : "Internal server error: {0}"
}

Status Code	Description
200	The workspace list is returned.
400	Bad request.
500	Internal server error.

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel