Instance ID and Workspace ID
Concepts
Instance
A DataArts Studio instance is the minimum unit of compute resources provided for users. You can create, access, and manage multiple DataArts Studio instances at the same time. A DataArts Studio instance allows you to access the following modules: Management Center, DataArts Architecture, DataArts Migration, DataArts Factory, DataArts Quality, and DataArts Catalog. You can obtain DataArts Studio instances with specifications tailored to your service requirements.
Instance ID
The unique identifier of a DataArts Studio instance. Each instance ID is globally unique and is used to specify a particular DataArts Studio instance in API calls.
Workspace
A workspace enables admins to manage member permissions, resources, and configurations of the underlying compute engines.
The workspace is a basic unit for member management as well as role and permission assignment. Each team must have an independent workspace.
You can access the Management Center, DataArts Catalog, DataArts Quality, DataArts Architecture, DataArts DataService, DataArts Security, DataArts Factory, and DataArts Migration modules only after your account is added to a workspace and assigned the permissions required to perform such operations.
Workspace ID
The unique identifier of each workspace. It is used to specify a specific workspace in API calls.
Obtaining a DataArts Studio Instance ID and Workspace ID
- On the DataArts Studio console, locate a workspace and click any module, such as Management Center.
- On the Management Center page, obtain the values of instanceId and workspace in the browser address bar, which are the instance ID and workspace ID, respectively. As shown in Figure 1, the instance ID is 6b88…2688, and the workspace ID is 1dd3bc…d93f0.
Use Cases
Use case 1: creating a data connection
When creating a data connection via the API, you need to specify the workspace ID:
POST /v1/{project_id}/data-connections | Parameter | Mandatory | Type | Description |
|---|---|---|---|
| workspace | Yes | String | Workspace ID. |
Use case 2: listing workspaces
When listing workspaces via the API, you need to specify the instance ID:
GET /v1/{project_id}/workspaces/{instance_id} | Parameter | Mandatory | Type | Description |
|---|---|---|---|
| instance_id | Yes | String | DataArts Studio instance ID. |
What is your overall rating for this page?
Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot
