Updated on 2024-11-06 GMT+08:00

Creating a Model Workspace

Function

Create a model workspace.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/design/workspaces

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.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

IAM token, which is obtained by calling the IAM API for obtaining a user token (value of X-Subject-Token in the response header).

This field is mandatory for authentication using tokens.

workspace

Yes

String

Workspace ID. For details about how to obtain the workspace ID, see Instance ID and Workspace ID.

X-Project-Id

No

String

Project ID. For details about how to obtain the project ID, see Project ID and Account ID.

This parameter is mandatory for API requests that use AK/SK authentication in multi-project scenarios.

Content-Type

No

String

Default value: application/json;charset=UTF-8

This parameter is optional. If the body is available, this parameter is mandatory. If the body is unavailable, you do not need to set this parameter or verify it.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

id

No

String

ID. The value of this parameter is of the String type instead of the Long type.

name

Yes

String

Name of the workspace.

description

No

String

Description.

is_physical

No

Boolean

Indicates whether a table is a physical table.

frequent

No

Boolean

Indicates whether it is commonly used.

top

No

Boolean

Hierarchical governance.

level

No

String

Data governance layers.

Options:

  • SDI: source data layer

  • DWI: data integration layer

  • DWR: data reporting layer

  • DM: data mart layer

dw_type

No

String

Data connection type, which corresponds to the type of the data warehouse where the table is located. The value can be DLI, DWS, MRS_HIVE, POSTGRESQL, MRS_SPARK, CLICKHOUSE, MYSQL, Oracle, or DORIS.

create_by

No

String

Creator.

update_by

No

String

Person who updates the information.

type

Yes

String

Defines the workspace type enumeration.

Options:

  • THIRD_NF: relational modeling

  • DIMENSION: dimensional modeling

biz_catalog_ids

No

String

{"l1Ids":[],"l2Ids":[],"l3Ids":[]}: ID list of associated service catalogs.

databases

No

Array of strings

Array of database names.

table_model_prefix

No

String

Model verification prefix. The value contains a maximum of 100 characters, including digits, letters, and underscores (_), and starts with a letter.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

data

data object

data: unified outermost data structure of the returned result.

Table 5 data

Parameter

Type

Description

value

WorkspaceVO object

value: unified outer data structure of the returned result.

Table 6 WorkspaceVO

Parameter

Type

Description

id

String

ID. The value of this parameter is of the String type instead of the Long type.

name

String

Name of the workspace.

description

String

Description.

is_physical

Boolean

Indicates whether a table is a physical table.

frequent

Boolean

Indicates whether it is commonly used.

top

Boolean

Hierarchical governance.

level

String

Data governance layers.

Options:

  • SDI: source data layer

  • DWI: data integration layer

  • DWR: data reporting layer

  • DM: data mart layer

dw_type

String

Data connection type, which corresponds to the type of the data warehouse where the table is located. The value can be DLI, DWS, MRS_HIVE, POSTGRESQL, MRS_SPARK, CLICKHOUSE, MYSQL, Oracle, or DORIS.

create_time

String

Creation time, which is read-only. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z.

update_time

String

Update time, which is read-only. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z.

create_by

String

Creator.

update_by

String

Person who updates the information.

type

String

Defines the workspace type enumeration.

Options:

  • THIRD_NF: relational modeling

  • DIMENSION: dimensional modeling

biz_catalog_ids

String

{"l1Ids":[],"l2Ids":[],"l3Ids":[]}: ID list of associated service catalogs.

databases

Array of strings

Array of database names.

table_model_prefix

String

Model verification prefix. The value contains a maximum of 100 characters, including digits, letters, and underscores (_), and starts with a letter.

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code, for example, DS.6000, indicating that the request fails to be processed.

error_msg

String

Error message

data

Object

Returned data information.

Status code: 401

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code, for example, DS.6000, indicating that the request fails to be processed.

error_msg

String

Error message

data

Object

Returned data information.

Status code: 403

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code, for example, DS.6000, indicating that the request fails to be processed.

error_msg

String

Error message

data

Object

Returned data information.

Example Requests

Create a model workspace.

POST https://{endpoint}/v2/{project_id}/design/workspaces

{
  "name" : "test_create_model",
  "table_model_prefix" : "",
  "description" : "this is a demo.",
  "type" : "THIRD_NF",
  "frequent" : false,
  "is_physical" : "true",
  "dw_type" : "DLI"
}

Example Responses

Status code: 200

This operation succeeds, and the returned data is WorkspaceVO.

{
  "data" : {
    "value" : {
      "id" : "1231989920109842432",
      "name" : "test_create_model",
      "description" : "this is a demo.",
      "is_physical" : true,
      "frequent" : false,
      "top" : true,
      "level" : null,
      "dw_type" : "DLI",
      "create_time" : "2024-04-22T15:28:06.22+08:00",
      "update_time" : "2024-04-22T15:28:06.22+08:00",
      "create_by" : "ei_dayu_y00321344_01",
      "update_by" : "ei_dayu_y00321344_01",
      "type" : "THIRD_NF",
      "biz_catalog_ids" : null,
      "databases" : null,
      "table_model_prefix" : ""
    }
  }
}

Status code: 400

{
  "error_code" : "DS.60xx",
  "error_msg" : "The user request is illegal."
}

Status code: 401

{
  "error_code" : "DS.60xx",
  "error_msg" : "User authentication failed."
}

Status code: 403

{
  "error_code" : "DS.60xx",
  "error_msg" : "The user does not have permission to call this API."
}

SDK Sample Code

The SDK sample code is as follows.

Create a model workspace.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.dataartsstudio.v1.region.DataArtsStudioRegion;
import com.huaweicloud.sdk.dataartsstudio.v1.*;
import com.huaweicloud.sdk.dataartsstudio.v1.model.*;


public class CreateWorkspaceSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        DataArtsStudioClient client = DataArtsStudioClient.newBuilder()
                .withCredential(auth)
                .withRegion(DataArtsStudioRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateWorkspaceRequest request = new CreateWorkspaceRequest();
        WorkspaceVO body = new WorkspaceVO();
        body.withTableModelPrefix("");
        body.withType(WorkspaceVO.TypeEnum.fromValue("THIRD_NF"));
        body.withDwType("DLI");
        body.withFrequent(false);
        body.withIsPhysical(true);
        body.withDescription("this is a demo.");
        body.withName("test_create_model");
        request.withBody(body);
        try {
            CreateWorkspaceResponse response = client.createWorkspace(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Create a model workspace.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdataartsstudio.v1.region.dataartsstudio_region import DataArtsStudioRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdataartsstudio.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = DataArtsStudioClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DataArtsStudioRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateWorkspaceRequest()
        request.body = WorkspaceVO(
            table_model_prefix="",
            type="THIRD_NF",
            dw_type="DLI",
            frequent=False,
            is_physical=True,
            description="this is a demo.",
            name="test_create_model"
        )
        response = client.create_workspace(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Create a model workspace.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dataartsstudio "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := dataartsstudio.NewDataArtsStudioClient(
        dataartsstudio.DataArtsStudioClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateWorkspaceRequest{}
	tableModelPrefixWorkspaceVo:= ""
	dwTypeWorkspaceVo:= "DLI"
	frequentWorkspaceVo:= false
	isPhysicalWorkspaceVo:= true
	descriptionWorkspaceVo:= "this is a demo."
	request.Body = &model.WorkspaceVo{
		TableModelPrefix: &tableModelPrefixWorkspaceVo,
		Type: model.GetWorkspaceVoTypeEnum().THIRD_NF,
		DwType: &dwTypeWorkspaceVo,
		Frequent: &frequentWorkspaceVo,
		IsPhysical: &isPhysicalWorkspaceVo,
		Description: &descriptionWorkspaceVo,
		Name: "test_create_model",
	}
	response, err := client.CreateWorkspace(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

This operation succeeds, and the returned data is WorkspaceVO.

400

BadRequest

401

Unauthorized

403

Forbidden