# 新建模型工作区 - CreateWorkspace #### 功能介绍 新建模型工作区。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-dataartsstudio/making_request.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dataartsstudio/abcd.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI POST /v2/{project_id}/design/workspaces 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID，获取方法请参见[项目ID和账号ID](https://support.huaweicloud.com/api-dataartsstudio/projectid_accountid.html)。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | IAM Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 使用Token认证时必选。 | | workspace | 是 | String | 工作空间ID，获取方法请参见[实例ID和工作空间ID](https://support.huaweicloud.com/api-dataartsstudio/dataartsstudio_02_0350.html)。 | | X-Project-Id | 否 | String | 项目ID，获取方法请参见[项目ID和账号ID](https://support.huaweicloud.com/api-dataartsstudio/projectid_accountid.html)。 多project场景采用AK/SK认证的接口请求，则该字段必选。 | | Content-Type | 否 | String | 默认值：application/json;charset=UTF-8 可选，有Body体的情况下必选，没有Body体则无需填写和校验。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | id | 否 | String | 编号，ID字符串。 | | name | 是 | String | 工作区名字。 | | description | 否 | String | 描述。 | | is_physical | 否 | Boolean | 是否为物理表。 | | frequent | 否 | Boolean | 是否为常用。 | | top | 否 | Boolean | 分层治理。 | | level | 否 | String | 数据治理分层。 枚举值： - SDI: 贴源数据层 - DWI: 数据整合层 - DWR: 数据报告层 - DM: 数据集市层 | | dw_type | 否 | String | 数据连接类型，对应表所在的数仓类型，取值可以为DWS、MRS_HIVE、POSTGRESQL、MRS_SPARK、CLICKHOUSE、MYSQL、ORACLE和DORIS等。 | | create_by | 否 | String | 创建人。 | | update_by | 否 | String | 更新人。 | | type | 是 | String | 工作区类型枚举。 枚举值： - THIRD_NF: 关系建模 - DIMENSION: 维度建模 | | biz_catalog_ids | 否 | String | 关联的业务分层的ID列表 {"l1Ids":\[\],"l2Ids":\[\],"l3Ids":\[\]}。 | | databases | 否 | Array of strings | 数据库名称数组。 | | table_model_prefix | 否 | String | 模型校验前缀，长度不超过100，数字字母下划线组成，字母开头 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | data | [data] object | data，统一的返回结果的最外层数据结构。 | 表5data | 参数 | 参数类型 | 描述 | |:---|:---|:---| | value | [WorkspaceVO] object | value，统一的返回结果的外层数据结构。 | 表6WorkspaceVO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 编号，ID字符串。 | | name | String | 工作区名字。 | | description | String | 描述。 | | is_physical | Boolean | 是否为物理表。 | | frequent | Boolean | 是否为常用。 | | top | Boolean | 分层治理。 | | level | String | 数据治理分层。 枚举值： - SDI: 贴源数据层 - DWI: 数据整合层 - DWR: 数据报告层 - DM: 数据集市层 | | dw_type | String | 数据连接类型，对应表所在的数仓类型，取值可以为DWS、MRS_HIVE、POSTGRESQL、MRS_SPARK、CLICKHOUSE、MYSQL、ORACLE和DORIS等。 | | create_time | String | 创建时间，只读，格式遵循RFC3339，精确到秒，UTC时区，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z。 | | update_time | String | 更新时间，只读，格式遵循RFC3339，精确到秒，UTC时区，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z。 | | create_by | String | 创建人。 | | update_by | String | 更新人。 | | type | String | 工作区类型枚举。 枚举值： - THIRD_NF: 关系建模 - DIMENSION: 维度建模 | | biz_catalog_ids | String | 关联的业务分层的ID列表 {"l1Ids":\[\],"l2Ids":\[\],"l3Ids":\[\]}。 | | databases | Array of strings | 数据库名称数组。 | | table_model_prefix | String | 模型校验前缀，长度不超过100，数字字母下划线组成，字母开头 | **状态码：400** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，如DS.6000，请求处理失败。 | | error_msg | String | 错误信息。 | | data | Object | 返回的数据信息。 | **状态码：401** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，如DS.6000，请求处理失败。 | | error_msg | String | 错误信息。 | | data | Object | 返回的数据信息。 | **状态码：403** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，如DS.6000，请求处理失败。 | | error_msg | String | 错误信息。 | | data | Object | 返回的数据信息。 | #### 请求示例 新建模型工作区。 ``` 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" : "DWS" } ``` #### 响应示例 **状态码：200** Success，返回data数据是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" : "DWS", "create_time" : "2024-04-22T15:28:06.22+08:00", "update_time" : "2024-04-22T15:28:06.22+08:00", "create_by" : "test_user", "update_by" : "test_user", "type" : "THIRD_NF", "biz_catalog_ids" : null, "databases" : null, "table_model_prefix" : "" } } } ``` **状态码：400** BadRequest ``` { "error_code" : "DS.60xx", "error_msg" : "The user request is illegal." } ``` **状态码：401** Unauthorized ``` { "error_code" : "DS.60xx", "error_msg" : "User authentication failed." } ``` **状态码：403** Forbidden ``` { "error_code" : "DS.60xx", "error_msg" : "The user does not have permission to call this API." } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 新建模型工作区。 ``` 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("")) .build(); CreateWorkspaceRequest request = new CreateWorkspaceRequest(); WorkspaceVO body = new WorkspaceVO(); body.withTableModelPrefix(""); body.withType(WorkspaceVO.WorkspaceVO.fromValue("THIRD_NF")); body.withDwType("DWS"); 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()); } } } ``` - [Python] 新建模型工作区。 ``` # 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("")) \ .build() try: request = CreateWorkspaceRequest() request.body = WorkspaceVO( table_model_prefix="", type="THIRD_NF", dw_type="DWS", 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) ``` - [Go] 新建模型工作区。 ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := dataartsstudio.DataArtsStudioClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := dataartsstudio.NewDataArtsStudioClient(hcClient) request := &model.CreateWorkspaceRequest{} tableModelPrefixWorkspaceVo:= "" dwTypeWorkspaceVo:= "DWS" 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) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/DataArtsStudio/sdk?api=CreateWorkspace)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | Success，返回data数据是WorkspaceVO。 | | 400 | BadRequest | | 401 | Unauthorized | | 403 | Forbidden |